Package org.apache.pekko.cluster.sharding

Class ClusterShardingSettings

java.lang.Object

org.apache.pekko.cluster.sharding.ClusterShardingSettings

All Implemented Interfaces:

NoSerializationVerificationNeeded

public final class ClusterShardingSettings
extends Object
implements NoSerializationVerificationNeeded

param: 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. param: 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. param: 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. param: 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. param: passivationStrategySettings settings for automatic passivation strategy, see descriptions in reference.conf param: tuningParameters additional tuning parameters, see descriptions in reference.conf param: shardRegionQueryTimeout the timeout for querying a shard region, see descriptions in reference.conf

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ClusterShardingSettings.CompositePassivationStrategy$	INTERNAL API
static class	ClusterShardingSettings.IdlePassivationStrategy$	INTERNAL API
static class	ClusterShardingSettings.LeastFrequentlyUsedPassivationStrategy$	INTERNAL API
static class	ClusterShardingSettings.LeastRecentlyUsedPassivationStrategy$	INTERNAL API
static class	ClusterShardingSettings.MostRecentlyUsedPassivationStrategy$
static class	ClusterShardingSettings.NoPassivationStrategy$	INTERNAL API
static interface	ClusterShardingSettings.PassivationStrategy	INTERNAL API
static class	ClusterShardingSettings.PassivationStrategy$	INTERNAL API Determine the passivation strategy to use from settings.
static final class	ClusterShardingSettings.PassivationStrategySettings	API MAY CHANGE: Settings for passivation strategies may change after additional testing and feedback.
static class	ClusterShardingSettings.PassivationStrategySettings$	API MAY CHANGE: Settings for passivation strategies may change after additional testing and feedback.
static class	ClusterShardingSettings.TuningParameters

Constructor Summary

Constructors

Constructor

Description

ClusterShardingSettings(scala.Option<String> role, boolean rememberEntities, String journalPluginId, String snapshotPluginId, String stateStoreMode, String rememberEntitiesStore, ClusterShardingSettings.PassivationStrategySettings passivationStrategySettings, scala.concurrent.duration.FiniteDuration shardRegionQueryTimeout, ClusterShardingSettings.TuningParameters tuningParameters, boolean coordinatorSingletonOverrideRole, ClusterSingletonManagerSettings coordinatorSingletonSettings, scala.Option<LeaseUsageSettings> leaseSettings)

Method Summary

Modifier and Type	Method	Description
static ClusterShardingSettings	apply(com.typesafe.config.Config config)	Create settings from a configuration with the same layout as the default configuration pekko.cluster.sharding.
static ClusterShardingSettings	apply(ActorSystem system)	Create settings from the default configuration pekko.cluster.sharding.
boolean	coordinatorSingletonOverrideRole()
ClusterSingletonManagerSettings	coordinatorSingletonSettings()
static ClusterShardingSettings	create(com.typesafe.config.Config config)	Java API: Create settings from a configuration with the same layout as the default configuration pekko.cluster.sharding.
static ClusterShardingSettings	create(ActorSystem system)	Java API: Create settings from the default configuration pekko.cluster.sharding.
String	journalPluginId()
scala.Option<LeaseUsageSettings>	leaseSettings()
ClusterShardingSettings.PassivationStrategySettings	passivationStrategySettings()
boolean	rememberEntities()
String	rememberEntitiesStore()
scala.Option<String>	role()
scala.concurrent.duration.FiniteDuration	shardRegionQueryTimeout()
String	snapshotPluginId()
String	stateStoreMode()
static String	StateStoreModeDData()
static String	StateStoreModePersistence()
ClusterShardingSettings.TuningParameters	tuningParameters()
ClusterShardingSettings	withCoordinatorSingletonSettings(ClusterSingletonManagerSettings coordinatorSingletonSettings)	The role of the ClusterSingletonManagerSettings is not used.
ClusterShardingSettings	withJournalPluginId(String journalPluginId)
ClusterShardingSettings	withLeaseSettings(LeaseUsageSettings leaseSettings)
ClusterShardingSettings	withNoPassivationStrategy()
ClusterShardingSettings	withPassivationStrategy(ClusterShardingSettings.PassivationStrategySettings settings)	API MAY CHANGE: Settings for passivation strategies may change after additional testing and feedback.
ClusterShardingSettings	withRememberEntities(boolean rememberEntities)
ClusterShardingSettings	withRole(String role)
ClusterShardingSettings	withRole(scala.Option<String> role)
ClusterShardingSettings	withShardRegionQueryTimeout(Duration duration)
ClusterShardingSettings	withShardRegionQueryTimeout(scala.concurrent.duration.FiniteDuration duration)
ClusterShardingSettings	withSnapshotPluginId(String snapshotPluginId)
ClusterShardingSettings	withStateStoreMode(String stateStoreMode)
ClusterShardingSettings	withTuningParameters(ClusterShardingSettings.TuningParameters tuningParameters)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ClusterShardingSettings

public ClusterShardingSettings(scala.Option<String> role,
 boolean rememberEntities,
 String journalPluginId,
 String snapshotPluginId,
 String stateStoreMode,
 String rememberEntitiesStore,
 ClusterShardingSettings.PassivationStrategySettings passivationStrategySettings,
 scala.concurrent.duration.FiniteDuration shardRegionQueryTimeout,
 ClusterShardingSettings.TuningParameters tuningParameters,
 boolean coordinatorSingletonOverrideRole,
 ClusterSingletonManagerSettings coordinatorSingletonSettings,
 scala.Option<LeaseUsageSettings> leaseSettings)

Method Details

StateStoreModePersistence

public static String StateStoreModePersistence()

StateStoreModeDData

public static String StateStoreModeDData()

apply

public static ClusterShardingSettings apply(ActorSystem system)

Create settings from the default configuration pekko.cluster.sharding.

apply

public static ClusterShardingSettings apply(com.typesafe.config.Config config)

Create settings from a configuration with the same layout as the default configuration pekko.cluster.sharding.

create

public static ClusterShardingSettings create(ActorSystem system)

Java API: Create settings from the default configuration pekko.cluster.sharding.

create

public static ClusterShardingSettings create(com.typesafe.config.Config config)

Java API: Create settings from a configuration with the same layout as the default configuration pekko.cluster.sharding.

role

public scala.Option<String> role()

rememberEntities

public boolean rememberEntities()

journalPluginId

public String journalPluginId()

snapshotPluginId

public String snapshotPluginId()

stateStoreMode

public String stateStoreMode()

rememberEntitiesStore

public String rememberEntitiesStore()

passivationStrategySettings

public ClusterShardingSettings.PassivationStrategySettings passivationStrategySettings()

shardRegionQueryTimeout

public scala.concurrent.duration.FiniteDuration shardRegionQueryTimeout()

tuningParameters

public ClusterShardingSettings.TuningParameters tuningParameters()

coordinatorSingletonOverrideRole

public boolean coordinatorSingletonOverrideRole()

coordinatorSingletonSettings

public ClusterSingletonManagerSettings coordinatorSingletonSettings()

leaseSettings

public scala.Option<LeaseUsageSettings> leaseSettings()

withRole

public ClusterShardingSettings withRole(String role)

withRole

public ClusterShardingSettings withRole(scala.Option<String> role)

withRememberEntities

public ClusterShardingSettings withRememberEntities(boolean rememberEntities)

withJournalPluginId

public ClusterShardingSettings withJournalPluginId(String journalPluginId)

withSnapshotPluginId

public ClusterShardingSettings withSnapshotPluginId(String snapshotPluginId)

withTuningParameters

public ClusterShardingSettings withTuningParameters(ClusterShardingSettings.TuningParameters tuningParameters)

withStateStoreMode

public ClusterShardingSettings withStateStoreMode(String stateStoreMode)

withPassivationStrategy

public ClusterShardingSettings withPassivationStrategy(ClusterShardingSettings.PassivationStrategySettings settings)

API MAY CHANGE: Settings for passivation strategies may change after additional testing and feedback.

withNoPassivationStrategy

public ClusterShardingSettings withNoPassivationStrategy()

withShardRegionQueryTimeout

public ClusterShardingSettings withShardRegionQueryTimeout(scala.concurrent.duration.FiniteDuration duration)

withShardRegionQueryTimeout

public ClusterShardingSettings withShardRegionQueryTimeout(Duration duration)

withLeaseSettings

public ClusterShardingSettings withLeaseSettings(LeaseUsageSettings leaseSettings)

withCoordinatorSingletonSettings

public ClusterShardingSettings withCoordinatorSingletonSettings(ClusterSingletonManagerSettings coordinatorSingletonSettings)

The role of the ClusterSingletonManagerSettings is not used. The role of the coordinator singleton will be the same as the role of ClusterShardingSettings.