Class GetClusterShardingStats

  • All Implemented Interfaces:
    java.io.Serializable, ClusterShardingQuery, scala.Equals, scala.Product

    public final class GetClusterShardingStats
    extends java.lang.Object
    implements ClusterShardingQuery, scala.Product, java.io.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 Detail

      • GetClusterShardingStats

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

        public GetClusterShardingStats​(EntityTypeKey<?> entityTypeKey,
                                       java.time.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 Detail

      • 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)
      • timeout

        public scala.concurrent.duration.FiniteDuration timeout()
      • replyTo

        public ActorRef<org.apache.pekko.cluster.sharding.ShardRegion.ClusterShardingStats> replyTo()
      • 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 java.lang.String productPrefix()
        Specified by:
        productPrefix in interface scala.Product
      • productArity

        public int productArity()
        Specified by:
        productArity in interface scala.Product
      • productElement

        public java.lang.Object productElement​(int x$1)
        Specified by:
        productElement in interface scala.Product
      • productIterator

        public scala.collection.Iterator<java.lang.Object> productIterator()
        Specified by:
        productIterator in interface scala.Product
      • canEqual

        public boolean canEqual​(java.lang.Object x$1)
        Specified by:
        canEqual in interface scala.Equals
      • productElementName

        public java.lang.String productElementName​(int x$1)
        Specified by:
        productElementName in interface scala.Product
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
      • equals

        public boolean equals​(java.lang.Object x$1)
        Specified by:
        equals in interface scala.Equals
        Overrides:
        equals in class java.lang.Object