c

org.apache.pekko.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()
Linear Supertypes
Product, Equals, ClusterShardingSerializable, Serializable, ShardRegionQuery, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GetClusterShardingStats
  2. Product
  3. Equals
  4. ClusterShardingSerializable
  5. Serializable
  6. ShardRegionQuery
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new GetClusterShardingStats(timeout: FiniteDuration)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  8. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  9. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  11. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  12. def productElementNames: Iterator[String]
    Definition Classes
    Product
  13. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  14. val timeout: FiniteDuration
  15. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  16. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated @Deprecated
    Deprecated

Inherited from Product

Inherited from Equals

Inherited from ClusterShardingSerializable

Inherited from Serializable

Inherited from ShardRegionQuery

Inherited from AnyRef

Inherited from Any

Ungrouped