root/akka.cluster.sharding/ClusterShardingSettings

ClusterShardingSettings

final class ClusterShardingSettings(val role: Option[String], val rememberEntities: Boolean, val journalPluginId: String, val snapshotPluginId: String, val stateStoreMode: String, val rememberEntitiesStore: String, val passivateIdleEntityAfter: FiniteDuration, val shardRegionQueryTimeout: FiniteDuration, val tuningParameters: TuningParameters, val coordinatorSingletonSettings: ClusterSingletonManagerSettings, val leaseSettings: Option[LeaseUsageSettings]) extends NoSerializationVerificationNeeded
Value parameters:
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.

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. It is always disabled if rememberEntities is enabled.

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.

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.

shardRegionQueryTimeout

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

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.

tuningParameters

additional tuning parameters, see descriptions in reference.conf

Companion:
object
class Object
trait Matchable
class Any

Value members

Deprecated constructors

@deprecated("Use the ClusterShardingSettings factory methods or the constructor including rememberedEntitiesStore instead", "2.6.7")
def this(role: Option[String], rememberEntities: Boolean, journalPluginId: String, snapshotPluginId: String, stateStoreMode: String, passivateIdleEntityAfter: FiniteDuration, shardRegionQueryTimeout: FiniteDuration, tuningParameters: TuningParameters, coordinatorSingletonSettings: ClusterSingletonManagerSettings, leaseSettings: Option[LeaseUsageSettings])
Deprecated
@deprecated("Use the ClusterShardingSettings factory methods or the constructor including shardRegionQueryTimeout instead", since = "2.6.0")
def this(role: Option[String], rememberEntities: Boolean, journalPluginId: String, snapshotPluginId: String, stateStoreMode: String, passivateIdleEntityAfter: FiniteDuration, tuningParameters: TuningParameters, coordinatorSingletonSettings: ClusterSingletonManagerSettings, leaseSettings: Option[LeaseUsageSettings])
Deprecated
[Since version 2.6.0]
@deprecated("Use the ClusterShardingSettings factory methods or the constructor including shardRegionQueryTimeout instead", since = "2.5.21")
def this(role: Option[String], rememberEntities: Boolean, journalPluginId: String, snapshotPluginId: String, stateStoreMode: String, passivateIdleEntityAfter: FiniteDuration, tuningParameters: TuningParameters, coordinatorSingletonSettings: ClusterSingletonManagerSettings)
Deprecated
[Since version 2.5.21]
@deprecated("Use the ClusterShardingSettings factory methods or the constructor including passivateIdleEntityAfter instead", since = "2.5.18")
def this(role: Option[String], rememberEntities: Boolean, journalPluginId: String, snapshotPluginId: String, stateStoreMode: String, tuningParameters: TuningParameters, coordinatorSingletonSettings: ClusterSingletonManagerSettings)
Deprecated
[Since version 2.5.18]

Concrete methods

def withCoordinatorSingletonSettings(coordinatorSingletonSettings: ClusterSingletonManagerSettings): ClusterShardingSettings

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

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

Concrete fields