Package org.apache.pekko.cluster.sharding.typed

Class GetShardRegionState

java.lang.Object
org.apache.pekko.cluster.sharding.typed.GetShardRegionState
All Implemented Interfaces:
Serializable, ClusterShardingQuery, scala.Equals, scala.Product
public final class GetShardRegionState extends Object implements ClusterShardingQuery, scala.Product, Serializable
Query the ShardRegion state for the given entity type key. This will get the state of the local ShardRegion's state.

Intended for testing purpose to see when cluster sharding is "ready" or to monitor the state of the shard regions.

For the statistics for the entire cluster, see GetClusterShardingStats.

See Also:

  • Constructor Details

    • GetShardRegionState

      public GetShardRegionState(EntityTypeKey<?> entityTypeKey, ActorRef<org.apache.pekko.cluster.sharding.ShardRegion.CurrentShardRegionState> replyTo)

    • GetShardRegionState

      public GetShardRegionState(EntityTypeKey<?> entityTypeKey, ActorRef<org.apache.pekko.cluster.sharding.ShardRegion.CurrentShardRegionState> replyTo)
      Java API

      Query the ShardRegion state for the given entity type key. This will get the state of the local ShardRegion's state.

  • Method Details

    • apply

      public static GetShardRegionState apply(EntityTypeKey<?> entityTypeKey, ActorRef<org.apache.pekko.cluster.sharding.ShardRegion.CurrentShardRegionState> replyTo)

    • unapply

      public static scala.Option<scala.Tuple2<EntityTypeKey<?>,ActorRef<org.apache.pekko.cluster.sharding.ShardRegion.CurrentShardRegionState>>> unapply(GetShardRegionState x$0)

    • entityTypeKey

      public EntityTypeKey<?> entityTypeKey()

    • replyTo

      public ActorRef<org.apache.pekko.cluster.sharding.ShardRegion.CurrentShardRegionState> replyTo()

    • copy

      public GetShardRegionState copy(EntityTypeKey<?> entityTypeKey, ActorRef<org.apache.pekko.cluster.sharding.ShardRegion.CurrentShardRegionState> replyTo)

    • copy$default$1

      public EntityTypeKey<?> copy$default$1()

    • copy$default$2

      public ActorRef<org.apache.pekko.cluster.sharding.ShardRegion.CurrentShardRegionState> copy$default$2()

    • productPrefix

      public String productPrefix()
      Specified by:
      productPrefix in interface scala.Product

    • productArity

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

    • productElement

      public Object productElement(int x$1)
      Specified by:
      productElement in interface scala.Product

    • productIterator

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

    • canEqual

      public boolean canEqual(Object x$1)
      Specified by:
      canEqual in interface scala.Equals

    • productElementName

      public String productElementName(int x$1)
      Specified by:
      productElementName in interface scala.Product

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • equals

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