final class ClusterShardingSettings extends AnyRef
- Alphabetic
- By Inheritance
- ClusterShardingSettings
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new ClusterShardingSettings(numberOfShards: Int, role: Option[String], dataCenter: Option[DataCenter], rememberEntities: Boolean, journalPluginId: String, snapshotPluginId: String, passivationStrategySettings: PassivationStrategySettings, shardRegionQueryTimeout: FiniteDuration, stateStoreMode: StateStoreMode, rememberEntitiesStoreMode: RememberEntitiesStoreMode, tuningParameters: TuningParameters, coordinatorSingletonOverrideRole: Boolean, coordinatorSingletonSettings: ClusterSingletonManagerSettings, leaseSettings: Option[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 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.
- 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.
- new ClusterShardingSettings(numberOfShards: Int, role: Option[String], dataCenter: Option[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
- new ClusterShardingSettings(numberOfShards: Int, role: Option[String], dataCenter: Option[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
- new ClusterShardingSettings(numberOfShards: Int, role: Option[String], dataCenter: Option[DataCenter], rememberEntities: Boolean, journalPluginId: String, snapshotPluginId: String, passivateIdleEntityAfter: FiniteDuration, shardRegionQueryTimeout: FiniteDuration, stateStoreMode: StateStoreMode, rememberEntitiesStoreMode: RememberEntitiesStoreMode, tuningParameters: TuningParameters, coordinatorSingletonSettings: ClusterSingletonManagerSettings, leaseSettings: Option[LeaseUsageSettings])
- Annotations
- @deprecated
- Deprecated
(Since version 2.6.18) Use constructor with passivationStrategySettings
- new ClusterShardingSettings(numberOfShards: Int, role: Option[String], dataCenter: Option[DataCenter], rememberEntities: Boolean, journalPluginId: String, snapshotPluginId: String, passivationStrategySettings: PassivationStrategySettings, shardRegionQueryTimeout: FiniteDuration, stateStoreMode: StateStoreMode, rememberEntitiesStoreMode: RememberEntitiesStoreMode, tuningParameters: TuningParameters, coordinatorSingletonSettings: ClusterSingletonManagerSettings, leaseSettings: Option[LeaseUsageSettings])
- Annotations
- @deprecated
- Deprecated
(Since version 2.6.20) Use constructor with coordinatorSingletonOverrideRole
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- Implicit
- This member is added by an implicit conversion from ClusterShardingSettings toany2stringadd[ClusterShardingSettings] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (ClusterShardingSettings, B)
- Implicit
- This member is added by an implicit conversion from ClusterShardingSettings toArrowAssoc[ClusterShardingSettings] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- val coordinatorSingletonOverrideRole: Boolean
- val coordinatorSingletonSettings: ClusterSingletonManagerSettings
- val dataCenter: Option[DataCenter]
- def ensuring(cond: (ClusterShardingSettings) => Boolean, msg: => Any): ClusterShardingSettings
- Implicit
- This member is added by an implicit conversion from ClusterShardingSettings toEnsuring[ClusterShardingSettings] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (ClusterShardingSettings) => Boolean): ClusterShardingSettings
- Implicit
- This member is added by an implicit conversion from ClusterShardingSettings toEnsuring[ClusterShardingSettings] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): ClusterShardingSettings
- Implicit
- This member is added by an implicit conversion from ClusterShardingSettings toEnsuring[ClusterShardingSettings] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): ClusterShardingSettings
- Implicit
- This member is added by an implicit conversion from ClusterShardingSettings toEnsuring[ClusterShardingSettings] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val journalPluginId: String
- val leaseSettings: Option[LeaseUsageSettings]
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- val numberOfShards: Int
- val passivationStrategySettings: PassivationStrategySettings
- val rememberEntities: Boolean
- val rememberEntitiesStoreMode: RememberEntitiesStoreMode
- val role: Option[String]
- val shardRegionQueryTimeout: FiniteDuration
- val snapshotPluginId: String
- val stateStoreMode: StateStoreMode
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- val tuningParameters: TuningParameters
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- 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 withDataCenter(dataCenter: DataCenter): ClusterShardingSettings
- def withJournalPluginId(journalPluginId: String): ClusterShardingSettings
- 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.
- def withNoPassivationStrategy(): ClusterShardingSettings
- 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()
- def withRememberEntities(rememberEntities: Boolean): ClusterShardingSettings
- def withRememberEntitiesStoreMode(rememberEntitiesStoreMode: RememberEntitiesStoreMode): ClusterShardingSettings
- def withRole(role: String): ClusterShardingSettings
- def withShardRegionQueryTimeout(duration: Duration): ClusterShardingSettings
- def withShardRegionQueryTimeout(duration: FiniteDuration): ClusterShardingSettings
- def withSnapshotPluginId(snapshotPluginId: String): ClusterShardingSettings
- def withStateStoreMode(stateStoreMode: StateStoreMode): ClusterShardingSettings
- def withTuningParameters(tuningParameters: TuningParameters): ClusterShardingSettings
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from ClusterShardingSettings toStringFormat[ClusterShardingSettings] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)
instead ofvalue.formatted(formatString)
, or use thef""
string interpolator. In Java 15 and later,formatted
resolves to the new method in String which has reversed parameters.
- def passivateIdleEntityAfter: FiniteDuration
- Annotations
- @deprecated
- Deprecated
(Since version 2.6.18) See passivationStrategySettings.idleEntitySettings instead
- def withPassivateIdleEntityAfter(duration: Duration): ClusterShardingSettings
- Annotations
- @deprecated
- Deprecated
(Since version 2.6.18) Use withPassivationStrategy instead
- def withPassivateIdleEntityAfter(duration: FiniteDuration): ClusterShardingSettings
- Annotations
- @deprecated
- Deprecated
(Since version 2.6.18) Use withPassivationStrategy instead
- def →[B](y: B): (ClusterShardingSettings, B)
- Implicit
- This member is added by an implicit conversion from ClusterShardingSettings toArrowAssoc[ClusterShardingSettings] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use
->
instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.