Interface ExternalShardAllocationClient


  • public interface ExternalShardAllocationClient
    API May Change

    Not for user extension

    • Method Detail

      • shardLocations

        scala.concurrent.Future<ShardLocations> shardLocations()
        Get all the current shard locations that have been set via updateShardLocation
      • updateShardLocation

        scala.concurrent.Future<Done> updateShardLocation​(java.lang.String shard,
                                                          Address 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.

        Parameters:
        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
      • updateShardLocations

        scala.concurrent.Future<Done> updateShardLocations​(scala.collection.immutable.Map<java.lang.String,​Address> locations)
        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.

        Parameters:
        locations - to update
        Returns:
        Confirmation that the update has been propagates to a majority of cluster nodes