c

akka.cluster.sharding.typed

GetClusterShardingStats

final case class GetClusterShardingStats(entityTypeKey: EntityTypeKey[_], timeout: FiniteDuration, replyTo: ActorRef[ClusterShardingStats]) extends ClusterShardingQuery with Product with 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.

timeout

the timeout applied to querying all alive regions

replyTo

the actor to send the result to

Source
ClusterShardingQuery.scala
Linear Supertypes
Serializable, Product, Equals, ClusterShardingQuery, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GetClusterShardingStats
  2. Serializable
  3. Product
  4. Equals
  5. ClusterShardingQuery
  6. AnyRef
  7. 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(entityTypeKey: EntityTypeKey[_], timeout: Duration, replyTo: [ClusterShardingStats])

    Java API

    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.

  2. new GetClusterShardingStats(entityTypeKey: EntityTypeKey[_], timeout: FiniteDuration, replyTo: [ClusterShardingStats])

    timeout

    the timeout applied to querying all alive regions

    replyTo

    the actor to send the result to

Value Members

  1. val entityTypeKey: EntityTypeKey[_]
  2. def productElementNames: Iterator[String]
    Definition Classes
    Product
  3. val replyTo: [ClusterShardingStats]
  4. val timeout: FiniteDuration