akka.cluster.sharding.external
ExternalShardAllocationStrategy
Companion object ExternalShardAllocationStrategy
class ExternalShardAllocationStrategy extends StartableAllocationStrategy
- Alphabetic
- By Inheritance
- ExternalShardAllocationStrategy
- StartableAllocationStrategy
- ShardAllocationStrategy
- NoSerializationVerificationNeeded
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new ExternalShardAllocationStrategy(systemProvider: ClassicActorSystemProvider, typeName: String)(implicit timeout: Timeout = Timeout(5.seconds))
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 ExternalShardAllocationStrategy toany2stringadd[ExternalShardAllocationStrategy] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (ExternalShardAllocationStrategy, B)
- Implicit
- This member is added by an implicit conversion from ExternalShardAllocationStrategy toArrowAssoc[ExternalShardAllocationStrategy] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def allocateShard(requester: ExternalShardAllocationStrategy.ShardRegion, shardId: ShardId, currentShardAllocations: Map[ExternalShardAllocationStrategy.ShardRegion, IndexedSeq[ShardId]]): Future[ExternalShardAllocationStrategy.ShardRegion]
Invoked when the location of a new shard is to be decided.
Invoked when the location of a new shard is to be decided.
- requester
actor reference to the ShardRegion that requested the location of the shard, can be returned if preference should be given to the node where the shard was first accessed
- shardId
the id of the shard to allocate
- currentShardAllocations
all actor refs to
ShardRegionand their current allocated shards, in the order they were allocated- returns
a
Futureof the actor ref of the ShardRegion that is to be responsible for the shard, must be one of the references included in thecurrentShardAllocationsparameter
- Definition Classes
- ExternalShardAllocationStrategy → ShardAllocationStrategy
- 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: (ExternalShardAllocationStrategy) => Boolean, msg: => Any): ExternalShardAllocationStrategy
- Implicit
- This member is added by an implicit conversion from ExternalShardAllocationStrategy toEnsuring[ExternalShardAllocationStrategy] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (ExternalShardAllocationStrategy) => Boolean): ExternalShardAllocationStrategy
- Implicit
- This member is added by an implicit conversion from ExternalShardAllocationStrategy toEnsuring[ExternalShardAllocationStrategy] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): ExternalShardAllocationStrategy
- Implicit
- This member is added by an implicit conversion from ExternalShardAllocationStrategy toEnsuring[ExternalShardAllocationStrategy] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): ExternalShardAllocationStrategy
- Implicit
- This member is added by an implicit conversion from ExternalShardAllocationStrategy toEnsuring[ExternalShardAllocationStrategy] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def hashCode(): Int
- 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 rebalance(currentShardAllocations: Map[ActorRef, IndexedSeq[ShardId]], rebalanceInProgress: Set[ShardId]): Future[Set[ShardId]]
Invoked periodically to decide which shards to rebalance to another location.
Invoked periodically to decide which shards to rebalance to another location.
- currentShardAllocations
all actor refs to
ShardRegionand their current allocated shards, in the order they were allocated- rebalanceInProgress
set of shards that are currently being rebalanced, i.e. you should not include these in the returned set
- returns
a
Futureof the shards to be migrated, may be empty to skip rebalance in this round
- Definition Classes
- ExternalShardAllocationStrategy → ShardAllocationStrategy
- def start(): Unit
Called before any calls to allocate/rebalance.
Called before any calls to allocate/rebalance. Do not block. If asynchronous actions are required they can be started here and delay the Futures returned by allocate/rebalance.
- Definition Classes
- ExternalShardAllocationStrategy → StartableAllocationStrategy
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- implicit val timeout: Timeout
- def toString(): String
- Definition Classes
- AnyRef → Any
- 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 ExternalShardAllocationStrategy toStringFormat[ExternalShardAllocationStrategy] 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): (ExternalShardAllocationStrategy, B)
- Implicit
- This member is added by an implicit conversion from ExternalShardAllocationStrategy toArrowAssoc[ExternalShardAllocationStrategy] 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.