Packages

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(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 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

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. 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
  4. 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()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  8. val coordinatorSingletonSettings: ClusterSingletonManagerSettings
  9. val dataCenter: Option[DataCenter]
  10. 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
  11. 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
  12. 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
  13. 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
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  16. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. 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()
  18. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. val journalPluginId: String
  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  25. val numberOfShards: Int
  26. val passivateIdleEntityAfter: FiniteDuration
  27. val rememberEntities: Boolean
  28. val role: Option[String]
  29. val snapshotPluginId: String
  30. val stateStoreMode: StateStoreMode
  31. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  32. def toString(): String
    Definition Classes
    AnyRef → Any
  33. val tuningParameters: TuningParameters
  34. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  37. 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.

  38. def withDataCenter(dataCenter: DataCenter): ClusterShardingSettings
  39. def withJournalPluginId(journalPluginId: String): ClusterShardingSettings
  40. def withPassivateIdleEntitiesAfter(duration: FiniteDuration): ClusterShardingSettings
  41. def withPassivateIdleEntityAfter(duration: Duration): ClusterShardingSettings
  42. def withRememberEntities(rememberEntities: Boolean): ClusterShardingSettings
  43. def withRole(role: String): ClusterShardingSettings
  44. def withSnapshotPluginId(snapshotPluginId: String): ClusterShardingSettings
  45. def withStateStoreMode(stateStoreMode: StateStoreMode): ClusterShardingSettings
  46. def withTuningParameters(tuningParameters: TuningParameters): ClusterShardingSettings
  47. 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

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from ClusterShardingSettings to any2stringadd[ClusterShardingSettings]

Inherited by implicit conversion StringFormat from ClusterShardingSettings to StringFormat[ClusterShardingSettings]

Inherited by implicit conversion Ensuring from ClusterShardingSettings to Ensuring[ClusterShardingSettings]

Inherited by implicit conversion ArrowAssoc from ClusterShardingSettings to ArrowAssoc[ClusterShardingSettings]

Ungrouped