org.elasticsearch.cluster.routing

Class RoutingNodes

java.lang.Object

org.elasticsearch.cluster.routing.RoutingNodes

All Implemented Interfaces:

java.lang.Iterable<RoutingNode>

public class RoutingNodes
extends java.lang.Object
implements java.lang.Iterable<RoutingNode>

RoutingNodes represents a copy the routing information contained in the cluster state.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	RoutingNodes.RoutingNodeIterator
class	RoutingNodes.RoutingNodesIterator
static class	RoutingNodes.UnassignedShards

Constructor Summary

Constructors

Constructor and Description
RoutingNodes(ClusterState clusterState)
RoutingNodes(ClusterState clusterState, boolean readOnly)

Method Summary

Modifier and Type	Method and Description
ShardRouting	activePrimary(ShardRouting shard) Returns the active primary shard for the given ShardRouting or null if no primary is found or the primary is not active.
ShardRouting	activeReplica(ShardRouting shard) Returns one active replica shard for the given ShardRouting shard ID or null if no active replica is found.
void	addInitialRecovery(ShardRouting routing)
void	addNode(DiscoveryNode node)
boolean	allReplicasActive(ShardRouting shardRouting) Returns true iff all replicas are active for the given shard routing.
static boolean	assertShardStats(RoutingNodes routingNodes) Calculates RoutingNodes statistics by iterating over all ShardRoutings in the cluster to ensure the book-keeping is correct.
java.lang.Iterable<ShardRouting>	assignedShards(ShardRouting shard) Returns all shards that are not in the state UNASSIGNED with the same shard ID as the given shard.
ClusterBlocks	blocks()
void	cancelRelocation(ShardRouting shard) Cancels a relocation of a shard that shard must relocating.
<T extends ClusterState.Custom> T	custom(java.lang.String type)
ImmutableOpenMap<java.lang.String,ClusterState.Custom>	customs()
ClusterBlocks	getBlocks()
int	getIncomingRecoveries(java.lang.String nodeId)
MetaData	getMetaData()
int	getOutgoingRecoveries(java.lang.String nodeId)
int	getRelocatingShardCount()
RoutingTable	getRoutingTable()
boolean	hasInactivePrimaries()
boolean	hasInactiveShards()
boolean	hasUnassignedPrimaries() Returns true iff this RoutingNodes instance has any unassigned primaries even if the primaries are marked as temporarily ignored.
boolean	hasUnassignedShards() Returns true iff this RoutingNodes instance has any unassigned shards even if the shards are marked as temporarily ignored.
void	initialize(ShardRouting shard, java.lang.String nodeId, java.lang.String existingAllocationId, long expectedSize) Moves a shard from unassigned to initialize state
boolean	isKnown(DiscoveryNode node)
java.util.Iterator<RoutingNode>	iterator()
MetaData	metaData()
RoutingNode	node(java.lang.String nodeId)
RoutingNodes.RoutingNodesIterator	nodes()
com.carrotsearch.hppc.ObjectIntHashMap<java.lang.String>	nodesPerAttributesCounts(java.lang.String attributeName)
java.lang.String	prettyPrint()
void	reinitShadowPrimary(ShardRouting candidate)
ShardRouting	relocate(ShardRouting shard, java.lang.String nodeId, long expectedShardSize) Relocate a shard to another node, adding the target initializing shard as well as assigning it.
RoutingNodes.RoutingNodeIterator	routingNodeIter(java.lang.String nodeId)
RoutingTable	routingTable()
java.util.List<ShardRouting>	shards(java.util.function.Predicate<ShardRouting> predicate)
java.util.List<ShardRouting>	shardsWithState(ShardRoutingState... state)
java.util.List<ShardRouting>	shardsWithState(java.lang.String index, ShardRoutingState... state)
int	size() Returns the number of routing nodes
void	started(ShardRouting shard) Mark a shard as started and adjusts internal statistics.
void	swapPrimaryFlag(ShardRouting... shards) swaps the status of a shard, making replicas primary and vice versa.
RoutingNode[]	toArray()
RoutingNodes.UnassignedShards	unassigned()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

RoutingNodes

public RoutingNodes(ClusterState clusterState)

RoutingNodes

public RoutingNodes(ClusterState clusterState,
                    boolean readOnly)

Method Detail

addInitialRecovery

public void addInitialRecovery(ShardRouting routing)

getIncomingRecoveries

public int getIncomingRecoveries(java.lang.String nodeId)

getOutgoingRecoveries

public int getOutgoingRecoveries(java.lang.String nodeId)

iterator

public java.util.Iterator<RoutingNode> iterator()

Specified by:

iterator in interface java.lang.Iterable<RoutingNode>

routingTable

public RoutingTable routingTable()

getRoutingTable

public RoutingTable getRoutingTable()

metaData

public MetaData metaData()

getMetaData

public MetaData getMetaData()

blocks

public ClusterBlocks blocks()

getBlocks

public ClusterBlocks getBlocks()

customs

public ImmutableOpenMap<java.lang.String,ClusterState.Custom> customs()

custom

public <T extends ClusterState.Custom> T custom(java.lang.String type)

unassigned

public RoutingNodes.UnassignedShards unassigned()

nodes

public RoutingNodes.RoutingNodesIterator nodes()

node

public RoutingNode node(java.lang.String nodeId)

nodesPerAttributesCounts

public com.carrotsearch.hppc.ObjectIntHashMap<java.lang.String> nodesPerAttributesCounts(java.lang.String attributeName)

hasUnassignedPrimaries

public boolean hasUnassignedPrimaries()

Returns true iff this RoutingNodes instance has any unassigned primaries even if the primaries are marked as temporarily ignored.

hasUnassignedShards

public boolean hasUnassignedShards()

Returns true iff this RoutingNodes instance has any unassigned shards even if the shards are marked as temporarily ignored.

See Also:

RoutingNodes.UnassignedShards.isEmpty(), RoutingNodes.UnassignedShards.isIgnoredEmpty()

hasInactivePrimaries

public boolean hasInactivePrimaries()

hasInactiveShards

public boolean hasInactiveShards()

getRelocatingShardCount

public int getRelocatingShardCount()

activePrimary

public ShardRouting activePrimary(ShardRouting shard)

Returns the active primary shard for the given ShardRouting or null if no primary is found or the primary is not active.

activeReplica

public ShardRouting activeReplica(ShardRouting shard)

Returns one active replica shard for the given ShardRouting shard ID or null if no active replica is found.

assignedShards

public java.lang.Iterable<ShardRouting> assignedShards(ShardRouting shard)

Returns all shards that are not in the state UNASSIGNED with the same shard ID as the given shard.

allReplicasActive

public boolean allReplicasActive(ShardRouting shardRouting)

Returns true iff all replicas are active for the given shard routing. Otherwise false

shards

public java.util.List<ShardRouting> shards(java.util.function.Predicate<ShardRouting> predicate)

shardsWithState

public java.util.List<ShardRouting> shardsWithState(ShardRoutingState... state)

shardsWithState

public java.util.List<ShardRouting> shardsWithState(java.lang.String index,
                                                    ShardRoutingState... state)

prettyPrint

public java.lang.String prettyPrint()

initialize

public void initialize(ShardRouting shard,
                       java.lang.String nodeId,
                       @Nullable
                       java.lang.String existingAllocationId,
                       long expectedSize)

Moves a shard from unassigned to initialize state

Parameters:

existingAllocationId - allocation id to use. If null, a fresh allocation id is generated.

relocate

public ShardRouting relocate(ShardRouting shard,
                             java.lang.String nodeId,
                             long expectedShardSize)

Relocate a shard to another node, adding the target initializing shard as well as assigning it. And returning the target initializing shard.

started

public void started(ShardRouting shard)

Mark a shard as started and adjusts internal statistics.

cancelRelocation

public void cancelRelocation(ShardRouting shard)

Cancels a relocation of a shard that shard must relocating.

swapPrimaryFlag

public void swapPrimaryFlag(ShardRouting... shards)

swaps the status of a shard, making replicas primary and vice versa.

Parameters:

shards - the shard to have its primary status swapped.

isKnown

public boolean isKnown(DiscoveryNode node)

addNode

public void addNode(DiscoveryNode node)

routingNodeIter

public RoutingNodes.RoutingNodeIterator routingNodeIter(java.lang.String nodeId)

toArray

public RoutingNode[] toArray()

reinitShadowPrimary

public void reinitShadowPrimary(ShardRouting candidate)

size

public int size()

Returns the number of routing nodes

assertShardStats

public static boolean assertShardStats(RoutingNodes routingNodes)

Calculates RoutingNodes statistics by iterating over all ShardRoutings in the cluster to ensure the book-keeping is correct. For performance reasons, this should only be called from asserts

Returns:

this method always returns true or throws an assertion error. If assertion are not enabled this method does nothing.