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
Linear Supertypes
Type Hierarchy
Ordering
- Alphabetic
- By Inheritance
Inherited
- GetClusterShardingStats
- Serializable
- Product
- Equals
- ClusterShardingQuery
- AnyRef
- Any
Implicitly
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
Visibility
- Public
- Protected
Instance Constructors
- new GetClusterShardingStats(entityTypeKey: EntityTypeKey[_], timeout: Duration, replyTo: ActorRef[ClusterShardingStats])
Java API
Java API
Query the statistics about the currently running sharded entities in the entire cluster. If the given
timeoutis reached without answers from all shard regions the reply will contain an empty map of regions. - new GetClusterShardingStats(entityTypeKey: EntityTypeKey[_], timeout: FiniteDuration, replyTo: ActorRef[ClusterShardingStats])
- timeout
the timeout applied to querying all alive regions
- replyTo
the actor to send the result to
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- Implicit
- This member is added by an implicit conversion from GetClusterShardingStats toany2stringadd[GetClusterShardingStats] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (GetClusterShardingStats, B)
- Implicit
- This member is added by an implicit conversion from GetClusterShardingStats toArrowAssoc[GetClusterShardingStats] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- def ensuring(cond: (GetClusterShardingStats) => Boolean, msg: => Any): GetClusterShardingStats
- Implicit
- This member is added by an implicit conversion from GetClusterShardingStats toEnsuring[GetClusterShardingStats] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (GetClusterShardingStats) => Boolean): GetClusterShardingStats
- Implicit
- This member is added by an implicit conversion from GetClusterShardingStats toEnsuring[GetClusterShardingStats] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): GetClusterShardingStats
- Implicit
- This member is added by an implicit conversion from GetClusterShardingStats toEnsuring[GetClusterShardingStats] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): GetClusterShardingStats
- Implicit
- This member is added by an implicit conversion from GetClusterShardingStats toEnsuring[GetClusterShardingStats] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- val entityTypeKey: EntityTypeKey[_]
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val replyTo: ActorRef[ClusterShardingStats]
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val timeout: FiniteDuration
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from GetClusterShardingStats toStringFormat[GetClusterShardingStats] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)instead ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
- def →[B](y: B): (GetClusterShardingStats, B)
- Implicit
- This member is added by an implicit conversion from GetClusterShardingStats toArrowAssoc[GetClusterShardingStats] 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.