final class ClusterShardingSettings extends NoSerializationVerificationNeeded

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ClusterShardingSettings
  2. NoSerializationVerificationNeeded
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ClusterShardingSettings(role: Option[String], rememberEntities: Boolean, journalPluginId: String, snapshotPluginId: String, stateStoreMode: String, rememberEntitiesStore: String, passivationStrategySettings: PassivationStrategySettings, shardRegionQueryTimeout: FiniteDuration, tuningParameters: TuningParameters, coordinatorSingletonOverrideRole: Boolean, 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.

    passivationStrategySettings

    settings for automatic passivation strategy, see descriptions in reference.conf

    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 Akka 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 Akka 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 Akka 2.6.0) Use the ClusterShardingSettings factory methods or the constructor including shardRegionQueryTimeout instead

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

    (Since version Akka 2.6.7) Use the ClusterShardingSettings factory methods or the constructor including rememberedEntitiesStore instead

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

    (Since version Akka 2.6.18) Use the ClusterShardingSettings factory methods or the constructor including passivationStrategySettings instead

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

    (Since version Akka 2.6.20) Use the ClusterShardingSettings factory methods or the constructor including coordinatorSingletonOverrideRole instead

Value Members

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

  32. def withJournalPluginId(journalPluginId: String): ClusterShardingSettings
  33. def withLeaseSettings(leaseSettings: LeaseUsageSettings): ClusterShardingSettings
  34. def withNoPassivationStrategy(): ClusterShardingSettings
  35. 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()
  36. def withRememberEntities(rememberEntities: Boolean): ClusterShardingSettings
  37. def withRole(role: Option[String]): ClusterShardingSettings
  38. def withRole(role: String): ClusterShardingSettings
  39. def withShardRegionQueryTimeout(duration: Duration): ClusterShardingSettings
  40. def withShardRegionQueryTimeout(duration: FiniteDuration): ClusterShardingSettings
  41. def withSnapshotPluginId(snapshotPluginId: String): ClusterShardingSettings
  42. def withStateStoreMode(stateStoreMode: String): ClusterShardingSettings
  43. def withTuningParameters(tuningParameters: TuningParameters): ClusterShardingSettings

Deprecated Value Members

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

    (Since version 9)

  2. def passivateIdleEntityAfter: FiniteDuration
    Annotations
    @deprecated
    Deprecated

    (Since version Akka 2.6.18) See passivationStrategySettings.idleEntitySettings instead

  3. def withPassivateIdleAfter(duration: Duration): ClusterShardingSettings
    Annotations
    @deprecated
    Deprecated

    (Since version Akka 2.6.18) Use withPassivationStrategy instead

  4. def withPassivateIdleAfter(duration: FiniteDuration): ClusterShardingSettings
    Annotations
    @deprecated
    Deprecated

    (Since version Akka 2.6.18) Use withPassivationStrategy instead

Inherited from NoSerializationVerificationNeeded

Inherited from AnyRef

Inherited from Any

Ungrouped