final class ClusterShardingSettings extends NoSerializationVerificationNeeded

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. All

Instance Constructors

  1. 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 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.

    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

  2. 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

  1. val coordinatorSingletonSettings: ClusterSingletonManagerSettings
  2. val journalPluginId: String
  3. val passivateIdleEntityAfter: FiniteDuration
  4. val rememberEntities: Boolean
  5. val role: Option[String]
  6. val snapshotPluginId: String
  7. val stateStoreMode: String
  8. val tuningParameters: TuningParameters
  9. 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.

  10. def withJournalPluginId(journalPluginId: String): ClusterShardingSettings
  11. def withPassivateIdleAfter(duration: Duration): ClusterShardingSettings
  12. def withPassivateIdleAfter(duration: FiniteDuration): ClusterShardingSettings
  13. def withRememberEntities(rememberEntities: Boolean): ClusterShardingSettings
  14. def withRole(role: Option[String]): ClusterShardingSettings
  15. def withRole(role: String): ClusterShardingSettings
  16. def withSnapshotPluginId(snapshotPluginId: String): ClusterShardingSettings
  17. def withStateStoreMode(stateStoreMode: String): ClusterShardingSettings
  18. def withTuningParameters(tuningParameters: TuningParameters): ClusterShardingSettings