c

akka.cluster.sharding.ShardRegion

GetClusterShardingStats

case class GetClusterShardingStats(timeout: FiniteDuration) extends ShardRegionQuery with Product with Serializable

Send this message to the ShardRegion actor to request for ClusterShardingStats, which contains statistics about the currently running sharded entities in the entire cluster. If the 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.

Annotations
@SerialVersionUID()
Source
ShardRegion.scala
Linear Supertypes
Serializable, Serializable, Product, Equals, ShardRegionQuery, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GetClusterShardingStats
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. ShardRegionQuery
  7. AnyRef
  8. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new GetClusterShardingStats(timeout: FiniteDuration)

Value Members

  1. val timeout: FiniteDuration