Package akka.cluster.sharding
Class ClusterShardingSettings
- java.lang.Object
-
- akka.cluster.sharding.ClusterShardingSettings
-
- All Implemented Interfaces:
NoSerializationVerificationNeeded
public final class ClusterShardingSettings extends java.lang.Object implements NoSerializationVerificationNeeded
If true, this node should run the shard region, otherwise just a shard proxy should started on this node.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ClusterShardingSettings.TuningParameters
-
Constructor Summary
Constructors Constructor Description ClusterShardingSettings(scala.Option<java.lang.String> role, boolean rememberEntities, java.lang.String journalPluginId, java.lang.String snapshotPluginId, java.lang.String stateStoreMode, ClusterShardingSettings.TuningParameters tuningParameters, ClusterSingletonManagerSettings coordinatorSingletonSettings)
Deprecated.Use the ClusterShardingSettings factory methods or the constructor including passivateIdleEntityAfter instead.ClusterShardingSettings(scala.Option<java.lang.String> role, boolean rememberEntities, java.lang.String journalPluginId, java.lang.String snapshotPluginId, java.lang.String stateStoreMode, scala.concurrent.duration.FiniteDuration passivateIdleEntityAfter, ClusterShardingSettings.TuningParameters tuningParameters, ClusterSingletonManagerSettings coordinatorSingletonSettings)
ClusterShardingSettings(scala.Option<java.lang.String> role, boolean rememberEntities, java.lang.String journalPluginId, java.lang.String snapshotPluginId, java.lang.String stateStoreMode, scala.concurrent.duration.FiniteDuration passivateIdleEntityAfter, ClusterShardingSettings.TuningParameters tuningParameters, ClusterSingletonManagerSettings coordinatorSingletonSettings, scala.Option<LeaseUsageSettings> leaseSettings)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ClusterShardingSettings
apply(ActorSystem system)
Create settings from the default configurationakka.cluster.sharding
.static ClusterShardingSettings
apply(com.typesafe.config.Config config)
Create settings from a configuration with the same layout as the default configurationakka.cluster.sharding
.ClusterSingletonManagerSettings
coordinatorSingletonSettings()
static ClusterShardingSettings
create(ActorSystem system)
Java API: Create settings from the default configurationakka.cluster.sharding
.static ClusterShardingSettings
create(com.typesafe.config.Config config)
Java API: Create settings from a configuration with the same layout as the default configurationakka.cluster.sharding
.java.lang.String
journalPluginId()
scala.Option<LeaseUsageSettings>
leaseSettings()
scala.concurrent.duration.FiniteDuration
passivateIdleEntityAfter()
boolean
rememberEntities()
scala.Option<java.lang.String>
role()
static scala.Option<java.lang.String>
roleOption(java.lang.String role)
INTERNAL APIboolean
shouldHostShard(Cluster cluster)
If true, this node should run the shard region, otherwise just a shard proxy should started on this node.java.lang.String
snapshotPluginId()
java.lang.String
stateStoreMode()
static java.lang.String
StateStoreModeDData()
static java.lang.String
StateStoreModePersistence()
ClusterShardingSettings.TuningParameters
tuningParameters()
ClusterShardingSettings
withCoordinatorSingletonSettings(ClusterSingletonManagerSettings coordinatorSingletonSettings)
Therole
of theClusterSingletonManagerSettings
is not used.ClusterShardingSettings
withJournalPluginId(java.lang.String journalPluginId)
ClusterShardingSettings
withLeaseSettings(LeaseUsageSettings leaseSettings)
ClusterShardingSettings
withPassivateIdleAfter(java.time.Duration duration)
ClusterShardingSettings
withPassivateIdleAfter(scala.concurrent.duration.FiniteDuration duration)
ClusterShardingSettings
withRememberEntities(boolean rememberEntities)
ClusterShardingSettings
withRole(java.lang.String role)
ClusterShardingSettings
withRole(scala.Option<java.lang.String> role)
ClusterShardingSettings
withSnapshotPluginId(java.lang.String snapshotPluginId)
ClusterShardingSettings
withStateStoreMode(java.lang.String stateStoreMode)
ClusterShardingSettings
withTuningParameters(ClusterShardingSettings.TuningParameters tuningParameters)
-
-
-
Constructor Detail
-
ClusterShardingSettings
public ClusterShardingSettings(scala.Option<java.lang.String> role, boolean rememberEntities, java.lang.String journalPluginId, java.lang.String snapshotPluginId, java.lang.String stateStoreMode, scala.concurrent.duration.FiniteDuration passivateIdleEntityAfter, ClusterShardingSettings.TuningParameters tuningParameters, ClusterSingletonManagerSettings coordinatorSingletonSettings, scala.Option<LeaseUsageSettings> leaseSettings)
-
ClusterShardingSettings
public ClusterShardingSettings(scala.Option<java.lang.String> role, boolean rememberEntities, java.lang.String journalPluginId, java.lang.String snapshotPluginId, java.lang.String stateStoreMode, scala.concurrent.duration.FiniteDuration passivateIdleEntityAfter, ClusterShardingSettings.TuningParameters tuningParameters, ClusterSingletonManagerSettings coordinatorSingletonSettings)
-
ClusterShardingSettings
public ClusterShardingSettings(scala.Option<java.lang.String> role, boolean rememberEntities, java.lang.String journalPluginId, java.lang.String snapshotPluginId, java.lang.String stateStoreMode, ClusterShardingSettings.TuningParameters tuningParameters, ClusterSingletonManagerSettings coordinatorSingletonSettings)
Deprecated.Use the ClusterShardingSettings factory methods or the constructor including passivateIdleEntityAfter instead. Since 2.5.18.
-
-
Method Detail
-
StateStoreModePersistence
public static java.lang.String StateStoreModePersistence()
-
StateStoreModeDData
public static java.lang.String StateStoreModeDData()
-
apply
public static ClusterShardingSettings apply(ActorSystem system)
Create settings from the default configurationakka.cluster.sharding
.- Parameters:
system
- (undocumented)- Returns:
- (undocumented)
-
apply
public static ClusterShardingSettings apply(com.typesafe.config.Config config)
Create settings from a configuration with the same layout as the default configurationakka.cluster.sharding
.- Parameters:
config
- (undocumented)- Returns:
- (undocumented)
-
create
public static ClusterShardingSettings create(ActorSystem system)
Java API: Create settings from the default configurationakka.cluster.sharding
.- Parameters:
system
- (undocumented)- Returns:
- (undocumented)
-
create
public static ClusterShardingSettings create(com.typesafe.config.Config config)
Java API: Create settings from a configuration with the same layout as the default configurationakka.cluster.sharding
.- Parameters:
config
- (undocumented)- Returns:
- (undocumented)
-
roleOption
public static scala.Option<java.lang.String> roleOption(java.lang.String role)
INTERNAL API- Parameters:
role
- (undocumented)- Returns:
- (undocumented)
-
role
public scala.Option<java.lang.String> role()
-
rememberEntities
public boolean rememberEntities()
-
journalPluginId
public java.lang.String journalPluginId()
-
snapshotPluginId
public java.lang.String snapshotPluginId()
-
stateStoreMode
public java.lang.String stateStoreMode()
-
passivateIdleEntityAfter
public scala.concurrent.duration.FiniteDuration passivateIdleEntityAfter()
-
tuningParameters
public ClusterShardingSettings.TuningParameters tuningParameters()
-
coordinatorSingletonSettings
public ClusterSingletonManagerSettings coordinatorSingletonSettings()
-
leaseSettings
public scala.Option<LeaseUsageSettings> leaseSettings()
-
shouldHostShard
public boolean shouldHostShard(Cluster cluster)
If true, this node should run the shard region, otherwise just a shard proxy should started on this node.
-
withRole
public ClusterShardingSettings withRole(java.lang.String role)
-
withRole
public ClusterShardingSettings withRole(scala.Option<java.lang.String> role)
-
withRememberEntities
public ClusterShardingSettings withRememberEntities(boolean rememberEntities)
-
withJournalPluginId
public ClusterShardingSettings withJournalPluginId(java.lang.String journalPluginId)
-
withSnapshotPluginId
public ClusterShardingSettings withSnapshotPluginId(java.lang.String snapshotPluginId)
-
withTuningParameters
public ClusterShardingSettings withTuningParameters(ClusterShardingSettings.TuningParameters tuningParameters)
-
withStateStoreMode
public ClusterShardingSettings withStateStoreMode(java.lang.String stateStoreMode)
-
withPassivateIdleAfter
public ClusterShardingSettings withPassivateIdleAfter(scala.concurrent.duration.FiniteDuration duration)
-
withPassivateIdleAfter
public ClusterShardingSettings withPassivateIdleAfter(java.time.Duration duration)
-
withLeaseSettings
public ClusterShardingSettings withLeaseSettings(LeaseUsageSettings leaseSettings)
-
withCoordinatorSingletonSettings
public ClusterShardingSettings withCoordinatorSingletonSettings(ClusterSingletonManagerSettings coordinatorSingletonSettings)
Therole
of theClusterSingletonManagerSettings
is not used. Therole
of the coordinator singleton will be the same as therole
ofClusterShardingSettings
.- Parameters:
coordinatorSingletonSettings
- (undocumented)- Returns:
- (undocumented)
-
-