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(numberOfShards: Int, role: Option[String], dataCenter: Option[DataCenter], rememberEntities: Boolean, journalPluginId: String, snapshotPluginId: String, passivateIdleEntityAfter: FiniteDuration, stateStoreMode: StateStoreMode, tuningParameters: TuningParameters, coordinatorSingletonSettings: ClusterSingletonManagerSettings)
- 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.
- 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
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 to any2stringadd[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 to ArrowAssoc[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[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate() @throws( ... )
- 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 to Ensuring[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 to Ensuring[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 to Ensuring[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 to Ensuring[ClusterShardingSettings] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from ClusterShardingSettings to StringFormat[ClusterShardingSettings] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @inline()
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val journalPluginId: String
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- val numberOfShards: Int
- val passivateIdleEntityAfter: FiniteDuration
- val rememberEntities: Boolean
- val role: Option[String]
- 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( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
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 withPassivateIdleEntitiesAfter(duration: FiniteDuration): ClusterShardingSettings
- def withPassivateIdleEntityAfter(duration: Duration): ClusterShardingSettings
- def withRememberEntities(rememberEntities: Boolean): ClusterShardingSettings
- def withRole(role: String): ClusterShardingSettings
- def withSnapshotPluginId(snapshotPluginId: String): ClusterShardingSettings
- def withStateStoreMode(stateStoreMode: StateStoreMode): ClusterShardingSettings
- def withTuningParameters(tuningParameters: TuningParameters): ClusterShardingSettings
-
def
→[B](y: B): (ClusterShardingSettings, B)
- Implicit
- This member is added by an implicit conversion from ClusterShardingSettings to ArrowAssoc[ClusterShardingSettings] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc