Interface IExternalShardAllocationClient

API May Change Not for user extension

Namespace: Akka.Cluster.Sharding.External
Assembly: Akka.Cluster.Sharding.dll
Syntax
public interface IExternalShardAllocationClient

Methods

| Edit this page View Source

ShardLocations()

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

Declaration
Task<ShardLocations> ShardLocations()
Returns
Type Description
Task<ShardLocations>
| Edit this page View Source

UpdateShardLocation(string, Address)

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.

Declaration
Task<Done> UpdateShardLocation(string shard, Address location)
Parameters
Type Name Description
string shard

The shard identifier
Address location

Location (akka node) to allocate the shard to
Returns
Type Description
Task<Done>

Confirmation that the update has been propagated to a majority of cluster nodes
| Edit this page View Source

UpdateShardLocations(IImmutableDictionary<string, Address>)

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.

Declaration
Task<Done> UpdateShardLocations(IImmutableDictionary<string, Address> locations)
Parameters
Type Name Description
IImmutableDictionary<string, Address> locations

to update
Returns
Type Description
Task<Done>

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

Extension Methods