Class/Object

akka.cluster.sharding

ClusterShardingSettings

Related Docs: object ClusterShardingSettings | package sharding

Permalink

final class ClusterShardingSettings extends NoSerializationVerificationNeeded

Source
ClusterShardingSettings.scala
Linear Supertypes
NoSerializationVerificationNeeded, AnyRef, Any
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, tuningParameters: TuningParameters, coordinatorSingletonSettings: ClusterSingletonManagerSettings)

    Permalink

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

    Permalink

    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

  3. new ClusterShardingSettings(role: Option[String], rememberEntities: Boolean, journalPluginId: String, snapshotPluginId: String, stateStoreMode: String, tuningParameters: TuningParameters, coordinatorSingletonSettings: ClusterSingletonManagerSettings)

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 2.5.18) Use the ClusterShardingSettings factory methods or the constructor including passivateIdleEntityAfter instead

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. def +(other: String): String

    Permalink
    Implicit information
    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)

    Permalink
    Implicit information
    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

    Permalink
    Definition Classes
    AnyRef → Any

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  8. val coordinatorSingletonSettings: ClusterSingletonManagerSettings

    Permalink

  9. def ensuring(cond: (ClusterShardingSettings) ⇒ Boolean, msg: ⇒ Any): ClusterShardingSettings

    Permalink
    Implicit information
    This member is added by an implicit conversion from ClusterShardingSettings to Ensuring[ClusterShardingSettings] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  10. def ensuring(cond: (ClusterShardingSettings) ⇒ Boolean): ClusterShardingSettings

    Permalink
    Implicit information
    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: Boolean, msg: ⇒ Any): ClusterShardingSettings

    Permalink
    Implicit information
    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): ClusterShardingSettings

    Permalink
    Implicit information
    This member is added by an implicit conversion from ClusterShardingSettings to Ensuring[ClusterShardingSettings] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  13. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  14. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  15. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  16. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    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()

  17. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  18. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  19. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  20. val journalPluginId: String

    Permalink

    Absolute path to the journal plugin configuration entity that is to be used for the internal persistence of ClusterSharding.

    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.

  21. val leaseSettings: Option[LeaseUsageSettings]

    Permalink

  22. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  23. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  24. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  25. val passivateIdleEntityAfter: FiniteDuration

    Permalink

    Passivate entities that have not received any message in this interval.

    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.

  26. val rememberEntities: Boolean

    Permalink

    true if active entity actors shall be automatically restarted upon Shard restart.

    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.

  27. val role: Option[String]

    Permalink

    specifies that this entity type requires cluster nodes with a specific 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.

  28. val snapshotPluginId: String

    Permalink

    Absolute path to the snapshot plugin configuration entity that is to be used for the internal persistence of ClusterSharding.

    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.

  29. val stateStoreMode: String

    Permalink

  30. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  31. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  32. val tuningParameters: TuningParameters

    Permalink

    additional tuning parameters, see descriptions in reference.conf

  33. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  34. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  35. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  36. def withCoordinatorSingletonSettings(coordinatorSingletonSettings: ClusterSingletonManagerSettings): ClusterShardingSettings

    Permalink

    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

    Permalink

  38. def withLeaseSettings(leaseSettings: LeaseUsageSettings): ClusterShardingSettings

    Permalink
    Annotations
    @ApiMayChange()

  39. def withPassivateIdleAfter(duration: Duration): ClusterShardingSettings

    Permalink

  40. def withPassivateIdleAfter(duration: FiniteDuration): ClusterShardingSettings

    Permalink

  41. def withRememberEntities(rememberEntities: Boolean): ClusterShardingSettings

    Permalink

  42. def withRole(role: Option[String]): ClusterShardingSettings

    Permalink

  43. def withRole(role: String): ClusterShardingSettings

    Permalink

  44. def withSnapshotPluginId(snapshotPluginId: String): ClusterShardingSettings

    Permalink

  45. def withStateStoreMode(stateStoreMode: String): ClusterShardingSettings

    Permalink

  46. def withTuningParameters(tuningParameters: TuningParameters): ClusterShardingSettings

    Permalink

  47. def →[B](y: B): (ClusterShardingSettings, B)

    Permalink
    Implicit information
    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 NoSerializationVerificationNeeded

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