Package org.opensearch.cluster.routing

package org.opensearch.cluster.routing

Cluster level shard routing and recovery classes.

Related Packages

Package	Description
org.opensearch.cluster	Cluster level classes.
org.opensearch.cluster.routing.allocation	Shard Allocation Foundation Classes.

Class	Description
AllocationId	Uniquely identifies an allocation.
BatchedRerouteService	A BatchedRerouteService is a RerouteService that batches together reroute requests to avoid unnecessary extra reroutes.
DelayedAllocationService	The DelayedAllocationService listens to cluster state changes and checks if there are unassigned shards with delayed allocation (unassigned shards that have the delay marker).
FailAwareWeightedRouting	This class contains logic to find next shard to retry search request in case of failure from other shard copy.
GroupShardsIterator<ShardIt extends Comparable<ShardIt> & Countable>	This class implements a compilation of ShardIterators.
IllegalShardRoutingStateException	This exception defines illegal states of shard routing
IndexRoutingTable	The IndexRoutingTable represents routing information for a single index.
IndexRoutingTable.Builder	Builder of a routing table.
IndexShardRoutingTable	IndexShardRoutingTable encapsulates all instances of a single shard.
IndexShardRoutingTable.Builder	Builder of an index shard routing table.
IndexShardRoutingTable.WeightedRoutingKey	Key for WeightedRouting Shard Iterator
Murmur3HashFunction	Hash function based on the Murmur3 algorithm, which is the default for OpenSearch.
NodeWeighedAwayException	This exception is thrown if the node is weighed away by @WeightedRoutingService
OperationRouting	Routes cluster operations
PlainShardIterator	The PlainShardIterator is a ShardsIterator which iterates all shards or a given shard id
PlainShardsIterator	A simple ShardsIterator that iterates a list or sub-list of shard indexRoutings.
Preference	Routing Preference Type
PreferenceBasedSearchNotAllowedException	Thrown to disallow preference based search with strict weighted shard routing.
RecoverySource	Represents the recovery source of a shard.
RecoverySource.EmptyStoreRecoverySource	Recovery from a fresh copy
RecoverySource.ExistingStoreRecoverySource	Recovery from an existing on-disk store
RecoverySource.LocalShardsRecoverySource	recovery from other shards on same node (shrink index action)
RecoverySource.PeerRecoverySource	peer recovery from a primary shard
RecoverySource.RemoteStoreRecoverySource	Recovery from remote store
RecoverySource.SnapshotRecoverySource	recovery from a snapshot
RecoverySource.Type	Type of recovery.
RerouteService	Asynchronously performs a cluster reroute, updating any shard states and rebalancing the cluster if appropriate.
RotationShardShuffler	Basic ShardShuffler implementation that uses an AtomicInteger to generate seeds and uses a rotation to permute shards.
RoutingChangesObserver	Records changes made to RoutingNodes during an allocation round.
RoutingChangesObserver.AbstractRoutingChangesObserver	Abstract implementation of RoutingChangesObserver that does not take any action.
RoutingChangesObserver.DelegatingRoutingChangesObserver	Observer of routing changes.
RoutingException	A base Exceptions for all exceptions thrown by routing related operations.
RoutingNode	A RoutingNode represents a cluster node associated with a single DiscoveryNode including all shards that are hosted on that nodes.
RoutingNodes	RoutingNodes represents a copy the routing information contained in the cluster state.
RoutingNodes.UnassignedShards	Unassigned shard list.
RoutingPool	RoutingPool defines the different node types based on the assigned capabilities.
RoutingTable	Represents a global cluster-wide routing table for all indices including the version of the current routing state.
RoutingTable.Builder	Builder for the routing table.
ShardIterator	Allows to iterate over a set of shard instances (routing) within a shard id group.
ShardMovementStrategy	ShardMovementStrategy defines the order in which shard movement occurs.
ShardRouting	ShardRouting immutably encapsulates information about shard indexRoutings like id, state, version, etc.
ShardRoutingState	Represents the current state of a ShardRouting as defined by the cluster.
ShardShuffler	A shuffler for shards whose primary goal is to balance load.
ShardsIterator	Allows to iterate over unrelated shards.
UnassignedInfo	Holds additional information as to why the shard is in unassigned state.
UnassignedInfo.AllocationStatus	Captures the status of an unsuccessful allocation attempt for the shard, causing it to remain in the unassigned state.
UnassignedInfo.Reason	Reason why the shard is in unassigned state.
UnsupportedWeightedRoutingStateException	Thrown when failing to update the routing weight due to an unsupported state.
WeightedRoundRobin<T>	Weighted Round Robin Scheduling policy
WeightedRouting	Entity for Weighted Round Robin weights
WeightedRoutingService	* Service responsible for updating cluster state metadata with weighted routing weights
WeightedRoutingStats	Captures weighted shard routing stats per node.
WeightedRoutingUtils	Utils for Weighted Routing