c

akka.cluster.sharding.ShardRegion

GetClusterShardingStats

case class GetClusterShardingStats(timeout: FiniteDuration) extends ShardRegionQuery with ClusterShardingSerializable 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
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GetClusterShardingStats
  2. Product
  3. Equals
  4. ClusterShardingSerializable
  5. Serializable
  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. Protected

Instance Constructors

  1. new GetClusterShardingStats(timeout: FiniteDuration)

Value Members

  1. def productElementNames: Iterator[String]
    Definition Classes
    Product
  2. val timeout: FiniteDuration