c

akka.cluster.sharding.typed

GetShardRegionState

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

Source
ClusterShardingQuery.scala
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GetShardRegionState
  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 GetShardRegionState(entityTypeKey: EntityTypeKey[_], replyTo: ActorRef[CurrentShardRegionState])

    Java API

    Java API

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

  2. new GetShardRegionState(entityTypeKey: EntityTypeKey[_], replyTo: ActorRef[CurrentShardRegionState])

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from GetShardRegionState toany2stringadd[GetShardRegionState] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (GetShardRegionState, B)
    Implicit
    This member is added by an implicit conversion from GetShardRegionState toArrowAssoc[GetShardRegionState] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  8. def ensuring(cond: (GetShardRegionState) => Boolean, msg: => Any): GetShardRegionState
    Implicit
    This member is added by an implicit conversion from GetShardRegionState toEnsuring[GetShardRegionState] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (GetShardRegionState) => Boolean): GetShardRegionState
    Implicit
    This member is added by an implicit conversion from GetShardRegionState toEnsuring[GetShardRegionState] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): GetShardRegionState
    Implicit
    This member is added by an implicit conversion from GetShardRegionState toEnsuring[GetShardRegionState] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): GetShardRegionState
    Implicit
    This member is added by an implicit conversion from GetShardRegionState toEnsuring[GetShardRegionState] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. val entityTypeKey: EntityTypeKey[_]
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. def productElementNames: Iterator[String]
    Definition Classes
    Product
  20. val replyTo: ActorRef[CurrentShardRegionState]
  21. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  24. 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
  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from GetShardRegionState toStringFormat[GetShardRegionState] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def [B](y: B): (GetShardRegionState, B)
    Implicit
    This member is added by an implicit conversion from GetShardRegionState toArrowAssoc[GetShardRegionState] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from ClusterShardingQuery

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromGetShardRegionState to any2stringadd[GetShardRegionState]

Inherited by implicit conversion StringFormat fromGetShardRegionState to StringFormat[GetShardRegionState]

Inherited by implicit conversion Ensuring fromGetShardRegionState to Ensuring[GetShardRegionState]

Inherited by implicit conversion ArrowAssoc fromGetShardRegionState to ArrowAssoc[GetShardRegionState]

Ungrouped