final class ClusterShardingSettings extends AnyRef

Annotations
@nowarn()
Source
ClusterShardingSettings.scala
Linear Supertypes
AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ClusterShardingSettings
  2. AnyRef
  3. 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(numberOfShards: Int, role: Option[String], dataCenter: [DataCenter], rememberEntities: Boolean, journalPluginId: String, snapshotPluginId: String, passivationStrategySettings: PassivationStrategySettings, shardRegionQueryTimeout: FiniteDuration, stateStoreMode: StateStoreMode, rememberEntitiesStoreMode: RememberEntitiesStoreMode, tuningParameters: TuningParameters, coordinatorSingletonOverrideRole: Boolean, coordinatorSingletonSettings: ClusterSingletonManagerSettings, leaseSettings: [LeaseUsageSettings])

    numberOfShards

    number of shards used by the default HashCodeMessageExtractor

    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. If the given role does not match the role of the current node the ShardRegion will be started in proxy mode.

    dataCenter

    The data center of the cluster nodes where the cluster sharding is running. If the dataCenter is not specified then the same data center as current node. If the given dataCenter does not match the data center of the current node the ShardRegion will be started in proxy mode.

    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

    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(numberOfShards: Int, role: Option[String], dataCenter: [DataCenter], rememberEntities: Boolean, journalPluginId: String, snapshotPluginId: String, passivateIdleEntityAfter: FiniteDuration, shardRegionQueryTimeout: FiniteDuration, stateStoreMode: StateStoreMode, tuningParameters: TuningParameters, coordinatorSingletonSettings: ClusterSingletonManagerSettings)
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.6) Use constructor with rememberEntitiesStoreMode

  3. new ClusterShardingSettings(numberOfShards: Int, role: Option[String], dataCenter: [DataCenter], rememberEntities: Boolean, journalPluginId: String, snapshotPluginId: String, passivateIdleEntityAfter: FiniteDuration, shardRegionQueryTimeout: FiniteDuration, stateStoreMode: StateStoreMode, rememberEntitiesStoreMode: RememberEntitiesStoreMode, tuningParameters: TuningParameters, coordinatorSingletonSettings: ClusterSingletonManagerSettings)
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.11) Use constructor with leaseSettings

  4. new ClusterShardingSettings(numberOfShards: Int, role: Option[String], dataCenter: [DataCenter], rememberEntities: Boolean, journalPluginId: String, snapshotPluginId: String, passivateIdleEntityAfter: FiniteDuration, shardRegionQueryTimeout: FiniteDuration, stateStoreMode: StateStoreMode, rememberEntitiesStoreMode: RememberEntitiesStoreMode, tuningParameters: TuningParameters, coordinatorSingletonSettings: ClusterSingletonManagerSettings, leaseSettings: [LeaseUsageSettings])
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.18) Use constructor with passivationStrategySettings

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

    (Since version 2.6.20) Use constructor with coordinatorSingletonOverrideRole

Value Members

  1. val coordinatorSingletonOverrideRole: Boolean
  2. val coordinatorSingletonSettings: ClusterSingletonManagerSettings
  3. val journalPluginId: String
  4. val leaseSettings: [LeaseUsageSettings]
  5. val numberOfShards: Int
  6. val passivationStrategySettings: PassivationStrategySettings
  7. val rememberEntities: Boolean
  8. val rememberEntitiesStoreMode: RememberEntitiesStoreMode
  9. val role: Option[String]
  10. val shardRegionQueryTimeout: FiniteDuration
  11. val snapshotPluginId: String
  12. val stateStoreMode: StateStoreMode
  13. val tuningParameters: TuningParameters
  14. 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.

  15. def withJournalPluginId(journalPluginId: String): ClusterShardingSettings
  16. 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.

  17. def withNoPassivationStrategy(): ClusterShardingSettings
  18. 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()
  19. def withRememberEntities(rememberEntities: Boolean): ClusterShardingSettings
  20. def withRememberEntitiesStoreMode(rememberEntitiesStoreMode: RememberEntitiesStoreMode): ClusterShardingSettings
  21. def withRole(role: String): ClusterShardingSettings
  22. def withShardRegionQueryTimeout(duration: Duration): ClusterShardingSettings
  23. def withShardRegionQueryTimeout(duration: FiniteDuration): ClusterShardingSettings
  24. def withSnapshotPluginId(snapshotPluginId: String): ClusterShardingSettings
  25. def withStateStoreMode(stateStoreMode: StateStoreMode): ClusterShardingSettings
  26. def withTuningParameters(tuningParameters: TuningParameters): ClusterShardingSettings

Deprecated Value Members

  1. val dataCenter: [DataCenter]
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use Akka Distributed Cluster instead

  2. def passivateIdleEntityAfter: FiniteDuration
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.18) See passivationStrategySettings.idleEntitySettings instead

  3. def withDataCenter(dataCenter: DataCenter): ClusterShardingSettings
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use Akka Distributed Cluster instead

  4. def withPassivateIdleEntityAfter(duration: Duration): ClusterShardingSettings
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.18) Use withPassivationStrategy instead

  5. def withPassivateIdleEntityAfter(duration: FiniteDuration): ClusterShardingSettings
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.18) Use withPassivationStrategy instead