final class ClusterShardingSettings extends NoSerializationVerificationNeeded
- Alphabetic
- By Inheritance
- ClusterShardingSettings
- NoSerializationVerificationNeeded
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
ClusterShardingSettings(role: Option[String], rememberEntities: Boolean, journalPluginId: String, snapshotPluginId: String, stateStoreMode: String, passivateIdleEntityAfter: FiniteDuration, tuningParameters: TuningParameters, coordinatorSingletonSettings: ClusterSingletonManagerSettings)
- 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 theShard
is started on a differentShardRegion
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.
- passivateIdleEntityAfter
Passivate entities that have not received any message in this interval. Note that only messages sent through sharding are counted, so direct messages to the
ActorRef
of the actor or messages that it sends to itself are not counted as activity. Use 0 to disable automatic passivation.- tuningParameters
additional tuning parameters, see descriptions in reference.conf
-
new
ClusterShardingSettings(role: Option[String], rememberEntities: Boolean, journalPluginId: String, snapshotPluginId: String, stateStoreMode: String, tuningParameters: TuningParameters, coordinatorSingletonSettings: ClusterSingletonManagerSettings)
- Annotations
- @deprecated
- Deprecated
(Since version 2.5.18) Use the ClusterShardingSettings factory methods or the constructor including passivateIdleEntityAfter instead
Value Members
- val coordinatorSingletonSettings: ClusterSingletonManagerSettings
- val journalPluginId: String
- val passivateIdleEntityAfter: FiniteDuration
- val rememberEntities: Boolean
- val role: Option[String]
- val snapshotPluginId: String
- val stateStoreMode: String
- val tuningParameters: TuningParameters
-
def
withCoordinatorSingletonSettings(coordinatorSingletonSettings: ClusterSingletonManagerSettings): ClusterShardingSettings
The
role
of theClusterSingletonManagerSettings
is not used.The
role
of theClusterSingletonManagerSettings
is not used. Therole
of the coordinator singleton will be the same as therole
ofClusterShardingSettings
. - def withJournalPluginId(journalPluginId: String): ClusterShardingSettings
- def withPassivateIdleAfter(duration: Duration): ClusterShardingSettings
- def withPassivateIdleAfter(duration: FiniteDuration): ClusterShardingSettings
- def withRememberEntities(rememberEntities: Boolean): ClusterShardingSettings
- def withRole(role: Option[String]): ClusterShardingSettings
- def withRole(role: String): ClusterShardingSettings
- def withSnapshotPluginId(snapshotPluginId: String): ClusterShardingSettings
- def withStateStoreMode(stateStoreMode: String): ClusterShardingSettings
- def withTuningParameters(tuningParameters: TuningParameters): ClusterShardingSettings