Packages

t

akka.cluster.sharding.external.scaladsl

ExternalShardAllocationClient

trait ExternalShardAllocationClient extends AnyRef

Not for user extension

Annotations
@DoNotInherit()
Source
ExternalShardAllocationClient.scala
Linear Supertypes
AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ExternalShardAllocationClient
  2. AnyRef
  3. 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

Abstract Value Members

  1. abstract def shardLocations(): Future[ShardLocations]

    Get all the current shard locations that have been set via updateShardLocation

  2. abstract def updateShardLocation(shard: ShardId, location: Address): Future[Done]

    Update the given shard's location.

    Update the given shard's location. The Address should match one of the nodes in the cluster. If the node has not joined the cluster yet it will be moved to that node after the first cluster sharding rebalance it does.

    shard

    The shard identifier

    location

    Location (akka node) to allocate the shard to

    returns

    Confirmation that the update has been propagated to a majority of cluster nodes

  3. abstract def updateShardLocations(locations: Map[ShardId, Address]): Future[Done]

    Update all of the provided ShardLocations.

    Update all of the provided ShardLocations. The Address should match one of the nodes in the cluster. If the node has not joined the cluster yet it will be moved to that node after the first cluster sharding rebalance it does.

    locations

    to update

    returns

    Confirmation that the update has been propagates to a majority of cluster nodes