Package org.apache.pekko.cluster.sharding.typed

Class GetClusterShardingStats

java.lang.Object

org.apache.pekko.cluster.sharding.typed.GetClusterShardingStats

All Implemented Interfaces:

Serializable, ClusterShardingQuery, scala.Equals, scala.Product

public final class GetClusterShardingStats
extends Object
implements ClusterShardingQuery, scala.Product, Serializable

Query the statistics about the currently running sharded entities in the entire cluster. If the given timeout is reached without answers from all shard regions the reply will contain an empty map of regions.

Intended for testing purpose to see when cluster sharding is "ready" or to monitor the state of the shard regions.

param: timeout the timeout applied to querying all alive regions param: replyTo the actor to send the result to

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
GetClusterShardingStats(EntityTypeKey<?> entityTypeKey, Duration timeout, ActorRef<org.apache.pekko.cluster.sharding.ShardRegion.ClusterShardingStats> replyTo)	Java API
GetClusterShardingStats(EntityTypeKey<?> entityTypeKey, scala.concurrent.duration.FiniteDuration timeout, ActorRef<org.apache.pekko.cluster.sharding.ShardRegion.ClusterShardingStats> replyTo)

Method Summary

Modifier and Type	Method	Description
static GetClusterShardingStats	apply(EntityTypeKey<?> entityTypeKey, scala.concurrent.duration.FiniteDuration timeout, ActorRef<org.apache.pekko.cluster.sharding.ShardRegion.ClusterShardingStats> replyTo)
boolean	canEqual(Object x$1)
GetClusterShardingStats	copy(EntityTypeKey<?> entityTypeKey, scala.concurrent.duration.FiniteDuration timeout, ActorRef<org.apache.pekko.cluster.sharding.ShardRegion.ClusterShardingStats> replyTo)
EntityTypeKey<?>	copy$default$1()
scala.concurrent.duration.FiniteDuration	copy$default$2()
ActorRef<org.apache.pekko.cluster.sharding.ShardRegion.ClusterShardingStats>	copy$default$3()
EntityTypeKey<?>	entityTypeKey()
boolean	equals(Object x$1)
int	hashCode()
int	productArity()
Object	productElement(int x$1)
String	productElementName(int x$1)
scala.collection.Iterator<Object>	productIterator()
String	productPrefix()
ActorRef<org.apache.pekko.cluster.sharding.ShardRegion.ClusterShardingStats>	replyTo()
scala.concurrent.duration.FiniteDuration	timeout()
String	toString()
static scala.Option<scala.Tuple3<EntityTypeKey<?>,scala.concurrent.duration.FiniteDuration,ActorRef<org.apache.pekko.cluster.sharding.ShardRegion.ClusterShardingStats>>>	unapply(GetClusterShardingStats x$0)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface scala.Product

productElementNames

Constructor Details

GetClusterShardingStats

public GetClusterShardingStats(EntityTypeKey<?> entityTypeKey,
 scala.concurrent.duration.FiniteDuration timeout,
 ActorRef<org.apache.pekko.cluster.sharding.ShardRegion.ClusterShardingStats> replyTo)

GetClusterShardingStats

public GetClusterShardingStats(EntityTypeKey<?> entityTypeKey,
 Duration timeout,
 ActorRef<org.apache.pekko.cluster.sharding.ShardRegion.ClusterShardingStats> replyTo)

Java API

Query the statistics about the currently running sharded entities in the entire cluster. If the given timeout is reached without answers from all shard regions the reply will contain an empty map of regions.

Method Details

apply

public static GetClusterShardingStats apply(EntityTypeKey<?> entityTypeKey,
 scala.concurrent.duration.FiniteDuration timeout,
 ActorRef<org.apache.pekko.cluster.sharding.ShardRegion.ClusterShardingStats> replyTo)

unapply

public static scala.Option<scala.Tuple3<EntityTypeKey<?>,scala.concurrent.duration.FiniteDuration,ActorRef<org.apache.pekko.cluster.sharding.ShardRegion.ClusterShardingStats>>> unapply(GetClusterShardingStats x$0)

entityTypeKey

public EntityTypeKey<?> entityTypeKey()

timeout

public scala.concurrent.duration.FiniteDuration timeout()

replyTo

public ActorRef<org.apache.pekko.cluster.sharding.ShardRegion.ClusterShardingStats> replyTo()

copy

public GetClusterShardingStats copy(EntityTypeKey<?> entityTypeKey,
 scala.concurrent.duration.FiniteDuration timeout,
 ActorRef<org.apache.pekko.cluster.sharding.ShardRegion.ClusterShardingStats> replyTo)

copy$default$1

public EntityTypeKey<?> copy$default$1()

copy$default$2

public scala.concurrent.duration.FiniteDuration copy$default$2()

copy$default$3

public ActorRef<org.apache.pekko.cluster.sharding.ShardRegion.ClusterShardingStats> copy$default$3()

productPrefix

public String productPrefix()

Specified by:

productPrefix in interface scala.Product

productArity

public int productArity()

Specified by:

productArity in interface scala.Product

productElement

public Object productElement(int x$1)

Specified by:

productElement in interface scala.Product

productIterator

public scala.collection.Iterator<Object> productIterator()

Specified by:

productIterator in interface scala.Product

canEqual

public boolean canEqual(Object x$1)

Specified by:

canEqual in interface scala.Equals

productElementName

public String productElementName(int x$1)

Specified by:

productElementName in interface scala.Product

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object x$1)

Specified by:

equals in interface scala.Equals

Overrides:

equals in class Object