final class ClusterShardingSettings extends NoSerializationVerificationNeeded

Source
ClusterShardingSettings.scala
Type Hierarchy
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, shardRegionQueryTimeout: FiniteDuration, tuningParameters: TuningParameters, coordinatorSingletonSettings: ClusterSingletonManagerSettings, leaseSettings: Option[LeaseUsageSettings])

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

    shardRegionQueryTimeout

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

    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

  3. new ClusterShardingSettings(role: Option[String], rememberEntities: Boolean, journalPluginId: String, snapshotPluginId: String, stateStoreMode: String, passivateIdleEntityAfter: FiniteDuration, tuningParameters: TuningParameters, coordinatorSingletonSettings: ClusterSingletonManagerSettings)
    Annotations
    @deprecated
    Deprecated

    (Since version 2.5.21) Use the ClusterShardingSettings factory methods or the constructor including shardRegionQueryTimeout instead

  4. new ClusterShardingSettings(role: Option[String], rememberEntities: Boolean, journalPluginId: String, snapshotPluginId: String, stateStoreMode: String, passivateIdleEntityAfter: FiniteDuration, tuningParameters: TuningParameters, coordinatorSingletonSettings: ClusterSingletonManagerSettings, leaseSettings: Option[LeaseUsageSettings])
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use the ClusterShardingSettings factory methods or the constructor including shardRegionQueryTimeout instead

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 toany2stringadd[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 toArrowAssoc[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
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  8. val coordinatorSingletonSettings: ClusterSingletonManagerSettings
  9. 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
  10. 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
  11. 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
  12. 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
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  15. 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
    @inline()
  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. val journalPluginId: String
  20. val leaseSettings: Option[LeaseUsageSettings]
  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  24. val passivateIdleEntityAfter: FiniteDuration
  25. val rememberEntities: Boolean
  26. val role: Option[String]
  27. val shardRegionQueryTimeout: FiniteDuration
  28. val snapshotPluginId: String
  29. val stateStoreMode: String
  30. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  31. def toString(): String
    Definition Classes
    AnyRef → Any
  32. val tuningParameters: TuningParameters
  33. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  34. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  35. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  36. 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.

  37. def withJournalPluginId(journalPluginId: String): ClusterShardingSettings
  38. def withLeaseSettings(leaseSettings: LeaseUsageSettings): ClusterShardingSettings
  39. def withPassivateIdleAfter(duration: Duration): ClusterShardingSettings
  40. def withPassivateIdleAfter(duration: FiniteDuration): ClusterShardingSettings
  41. def withRememberEntities(rememberEntities: Boolean): ClusterShardingSettings
  42. def withRole(role: Option[String]): ClusterShardingSettings
  43. def withRole(role: String): ClusterShardingSettings
  44. def withShardRegionQueryTimeout(duration: Duration): ClusterShardingSettings
  45. def withShardRegionQueryTimeout(duration: FiniteDuration): ClusterShardingSettings
  46. def withSnapshotPluginId(snapshotPluginId: String): ClusterShardingSettings
  47. def withStateStoreMode(stateStoreMode: String): ClusterShardingSettings
  48. def withTuningParameters(tuningParameters: TuningParameters): ClusterShardingSettings

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated @deprecated
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

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

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromClusterShardingSettings to any2stringadd[ClusterShardingSettings]

Inherited by implicit conversion StringFormat fromClusterShardingSettings to StringFormat[ClusterShardingSettings]

Inherited by implicit conversion Ensuring fromClusterShardingSettings to Ensuring[ClusterShardingSettings]

Inherited by implicit conversion ArrowAssoc fromClusterShardingSettings to ArrowAssoc[ClusterShardingSettings]

Ungrouped