ExternalShardAllocationClient

public interface ExternalShardAllocationClient

API May Change

Not for user extension

Method Summary

Modifier and Type

Method

Description

CompletionStage<ShardLocations>

getShardLocations()

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

CompletionStage<Done>

setShardLocation(String shard, Address location)

Update the given shard's location.

CompletionStage<Done>

setShardLocations(Map<String,Address> locations)

Update all of the provided ShardLocations.

Method Details
- getShardLocations
  
  CompletionStage<ShardLocations> getShardLocations()
  
  Get all the current shard locations that have been set via setShardLocation
- setShardLocation
  
  CompletionStage<Done> setShardLocation(String shard, Address location)
  
  Update the given shard's location. The pekko.actor.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.
  
  Parameters:
  
  shard - The shard identifier
  
  location - Location (Pekko node) to allocate the shard to
  
  Returns:
  
  Conformation that the update has been written to the local node
- setShardLocations
  
  CompletionStage<Done> setShardLocations(Map<String,Address> locations)
  
  Update all of the provided ShardLocations. The pekko.actor.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.
  
  Parameters:
  
  locations - to update
  
  Returns:
  
  Confirmation that the update has been written to the local node