final class ClusterShardingSettings extends NoSerializationVerificationNeeded

Source
ClusterShardingSettings.scala
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ClusterShardingSettings
  2. NoSerializationVerificationNeeded
  3. AnyRef
  4. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ClusterShardingSettings(role: Option[String], rememberEntities: Boolean, journalPluginId: String, snapshotPluginId: String, stateStoreMode: String, rememberEntitiesStore: String, passivationStrategySettings: PassivationStrategySettings, shardRegionQueryTimeout: FiniteDuration, tuningParameters: TuningParameters, coordinatorSingletonOverrideRole: Boolean, coordinatorSingletonSettings: ClusterSingletonManagerSettings, leaseSettings: Option[LeaseUsageSettings])

    role

    specifies that this entity type requires cluster nodes with a specific role. If the role is not specified all nodes in the cluster are used.

    rememberEntities

    true if active entity actors shall be automatically restarted upon Shard restart. i.e. if the Shard is started on a different ShardRegion due to rebalance or crash.

    journalPluginId

    Absolute path to the journal plugin configuration entity that is to be used for the internal persistence of ClusterSharding. If not defined the default journal plugin is used. Note that this is not related to persistence used by the entity actors.

    snapshotPluginId

    Absolute path to the snapshot plugin configuration entity that is to be used for the internal persistence of ClusterSharding. If not defined the default snapshot plugin is used. Note that this is not related to persistence used by the entity actors.

    passivationStrategySettings

    settings for automatic passivation strategy, see descriptions in reference.conf

    shardRegionQueryTimeout

    the timeout for querying a shard region, see descriptions in reference.conf

    tuningParameters

    additional tuning parameters, see descriptions in reference.conf

    leaseSettings

    LeaseSettings for acquiring before creating the shard. Note that if you define a custom lease name and have several sharding entity types each one must have a unique lease name. If the lease name is undefined it will be derived from ActorSystem name and shard name, but that may result in too long lease names.

  2. new ClusterShardingSettings(role: Option[String], rememberEntities: Boolean, journalPluginId: String, snapshotPluginId: String, stateStoreMode: String, passivateIdleEntityAfter: FiniteDuration, tuningParameters: TuningParameters, coordinatorSingletonSettings: ClusterSingletonManagerSettings, leaseSettings: Option[LeaseUsageSettings])
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use the ClusterShardingSettings factory methods or the constructor including shardRegionQueryTimeout instead

  3. new ClusterShardingSettings(role: Option[String], rememberEntities: Boolean, journalPluginId: String, snapshotPluginId: String, stateStoreMode: String, passivateIdleEntityAfter: FiniteDuration, shardRegionQueryTimeout: FiniteDuration, tuningParameters: TuningParameters, coordinatorSingletonSettings: ClusterSingletonManagerSettings, leaseSettings: Option[LeaseUsageSettings])
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.7) Use the ClusterShardingSettings factory methods or the constructor including rememberedEntitiesStore instead

  4. new ClusterShardingSettings(role: Option[String], rememberEntities: Boolean, journalPluginId: String, snapshotPluginId: String, stateStoreMode: String, rememberEntitiesStore: String, passivateIdleEntityAfter: FiniteDuration, shardRegionQueryTimeout: FiniteDuration, tuningParameters: TuningParameters, coordinatorSingletonSettings: ClusterSingletonManagerSettings, leaseSettings: Option[LeaseUsageSettings])
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.18) Use the ClusterShardingSettings factory methods or the constructor including passivationStrategySettings instead

  5. new ClusterShardingSettings(role: Option[String], rememberEntities: Boolean, journalPluginId: String, snapshotPluginId: String, stateStoreMode: String, rememberEntitiesStore: String, passivationStrategySettings: PassivationStrategySettings, shardRegionQueryTimeout: FiniteDuration, tuningParameters: TuningParameters, coordinatorSingletonSettings: ClusterSingletonManagerSettings, leaseSettings: Option[LeaseUsageSettings])
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.20) Use the ClusterShardingSettings factory methods or the constructor including coordinatorSingletonOverrideRole instead

Value Members

  1. val coordinatorSingletonOverrideRole: Boolean
  2. val coordinatorSingletonSettings: ClusterSingletonManagerSettings
  3. val journalPluginId: String
  4. val leaseSettings: Option[LeaseUsageSettings]
  5. val passivationStrategySettings: PassivationStrategySettings
  6. val rememberEntities: Boolean
  7. val rememberEntitiesStore: String
  8. val role: Option[String]
  9. val shardRegionQueryTimeout: FiniteDuration
  10. val snapshotPluginId: String
  11. val stateStoreMode: String
  12. val tuningParameters: TuningParameters
  13. def withCoordinatorSingletonSettings(coordinatorSingletonSettings: ClusterSingletonManagerSettings): ClusterShardingSettings

    The role of the ClusterSingletonManagerSettings is not used.

    The role of the ClusterSingletonManagerSettings is not used. The role of the coordinator singleton will be the same as the role of ClusterShardingSettings.

  14. def withJournalPluginId(journalPluginId: String): ClusterShardingSettings
  15. def withLeaseSettings(leaseSettings: LeaseUsageSettings): ClusterShardingSettings

    Note that if you define a custom lease name and have several sharding entity types each one must have a unique lease name.

    Note that if you define a custom lease name and have several sharding entity types each one must have a unique lease name. If the lease name is undefined it will be derived from ActorSystem name and shard name, but that may result in too long lease names.

  16. def withNoPassivationStrategy(): ClusterShardingSettings
  17. def withPassivationStrategy(settings: PassivationStrategySettings): ClusterShardingSettings

    API MAY CHANGE: Settings for passivation strategies may change after additional testing and feedback.

    API MAY CHANGE: Settings for passivation strategies may change after additional testing and feedback.

    Annotations
    @ApiMayChange()
  18. def withRememberEntities(rememberEntities: Boolean): ClusterShardingSettings
  19. def withRole(role: Option[String]): ClusterShardingSettings
  20. def withRole(role: String): ClusterShardingSettings
  21. def withShardRegionQueryTimeout(duration: Duration): ClusterShardingSettings
  22. def withShardRegionQueryTimeout(duration: FiniteDuration): ClusterShardingSettings
  23. def withSnapshotPluginId(snapshotPluginId: String): ClusterShardingSettings
  24. def withStateStoreMode(stateStoreMode: String): ClusterShardingSettings
  25. def withTuningParameters(tuningParameters: TuningParameters): ClusterShardingSettings

Deprecated Value Members

  1. def passivateIdleEntityAfter: FiniteDuration
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.18) See passivationStrategySettings.idleEntitySettings instead

  2. def withPassivateIdleAfter(duration: Duration): ClusterShardingSettings
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.18) Use withPassivationStrategy instead

  3. def withPassivateIdleAfter(duration: FiniteDuration): ClusterShardingSettings
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.18) Use withPassivationStrategy instead