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

    leaseSettings

    LeaseSettings for acquiring before creating the shard. Note that if you define a custom lease name and have several sharding entity types each one must have a unique lease name. If the lease name is undefined it will be derived from ActorSystem name and shard name, but that may result in too long lease names.

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

  3. 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 2.6.7) Use the ClusterShardingSettings factory methods or the constructor including rememberedEntitiesStore instead

  4. 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 2.6.18) Use the ClusterShardingSettings factory methods or the constructor including passivationStrategySettings instead

  5. 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 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. 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[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  8. val coordinatorSingletonOverrideRole: Boolean
  9. val coordinatorSingletonSettings: ClusterSingletonManagerSettings
  10. 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
  11. 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
  12. 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
  13. 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
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  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
    @HotSpotIntrinsicCandidate() @native()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  24. val passivationStrategySettings: PassivationStrategySettings
  25. val rememberEntities: Boolean
  26. val rememberEntitiesStore: String
  27. val role: Option[String]
  28. val shardRegionQueryTimeout: FiniteDuration
  29. val snapshotPluginId: String
  30. val stateStoreMode: String
  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(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  35. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  36. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  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 withJournalPluginId(journalPluginId: String): ClusterShardingSettings
  39. def withLeaseSettings(leaseSettings: LeaseUsageSettings): ClusterShardingSettings

    Note that if you define a custom lease name and have several sharding entity types each one must have a unique lease name.

    Note that if you define a custom lease name and have several sharding entity types each one must have a unique lease name. If the lease name is undefined it will be derived from ActorSystem name and shard name, but that may result in too long lease names.

  40. def withNoPassivationStrategy(): ClusterShardingSettings
  41. 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()
  42. def withRememberEntities(rememberEntities: Boolean): ClusterShardingSettings
  43. def withRole(role: Option[String]): ClusterShardingSettings
  44. def withRole(role: String): ClusterShardingSettings
  45. def withShardRegionQueryTimeout(duration: Duration): ClusterShardingSettings
  46. def withShardRegionQueryTimeout(duration: FiniteDuration): ClusterShardingSettings
  47. def withSnapshotPluginId(snapshotPluginId: String): ClusterShardingSettings
  48. def withStateStoreMode(stateStoreMode: String): ClusterShardingSettings
  49. 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 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
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def passivateIdleEntityAfter: FiniteDuration
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.18) See passivationStrategySettings.idleEntitySettings instead

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

    (Since version 2.6.18) Use withPassivationStrategy instead

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

    (Since version 2.6.18) Use withPassivationStrategy instead

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