Package org.opensearch.cluster

Interface Summary

Interface	Description
AckedClusterStateTaskListener
ClusterInfoService	Interface for a class used to gather information about a cluster periodically.
ClusterState.Custom
ClusterState.FeatureAware	An interface that implementors use when a class requires a client to maybe have a feature.
ClusterStateApplier	A component that is in charge of applying an incoming cluster state to the node internal data structures.
ClusterStateListener	A listener to be notified when a cluster state changes.
ClusterStateObserver.Listener
ClusterStateTaskConfig	Cluster state update task configuration for timeout and priority
ClusterStateTaskExecutor<T>
ClusterStateTaskListener
Diff<T>	Represents difference between states of cluster state parts
Diffable<T>	Cluster state part, changes in which can be serialized
DiffableUtils.KeySerializer<K>	Provides read and write operations to serialize keys of map
DiffableUtils.ValueSerializer<K,V>	Provides read and write operations to serialize map values.
LocalNodeMasterListener	Enables listening to master changes events of the local node (when the local node becomes the master, and when the local node cease being a master).
MergableCustomMetadata<T extends Metadata.Custom>	Interface to allow merging Metadata.Custom.
NamedDiff<T extends Diffable<T>>	Diff that also support NamedWriteable interface
NamedDiffable<T>	Diff that also support VersionedNamedWriteable interface
TimeoutClusterStateListener	An exception to cluster state listener that allows for timeouts and for post added notifications.

Class Summary

Class	Description
AbstractDiffable<T extends Diffable<T>>	Abstract diffable object with simple diffs implementation that sends the entire object if object has changed or nothing if object remained the same.
AbstractNamedDiffable<T extends NamedDiffable<T>>	Abstract diffable object with simple diffs implementation that sends the entire object if object has changed or nothing is object remained the same.
AckedClusterStateUpdateTask<Response>	An extension interface to ClusterStateUpdateTask that allows to be notified when all the nodes have acknowledged a cluster state update request
ClusterChangedEvent	An event received by the local node, signaling that the cluster state has changed.
ClusterInfo	ClusterInfo is an object representing a map of nodes to DiskUsage and a map of shard ids to shard sizes, see InternalClusterInfoService.shardIdentifierFromRouting(String) for the key used in the shardSizes map
ClusterInfo.NodeAndPath	Represents a data path on a node
ClusterInfo.ReservedSpace	Represents the total amount of "reserved" space on a particular data path, together with the set of shards considered.
ClusterInfo.ReservedSpace.Builder
ClusterModule	Configures classes and services that affect the entire cluster.
ClusterName
ClusterState	Represents the current state of the cluster.
ClusterState.Builder
ClusterStateObserver	A utility class which simplifies interacting with the cluster state in cases where one tries to take action based on the current state but may want to wait for a new state and retry upon failure.
ClusterStateTaskConfig.Basic
ClusterStateTaskExecutor.ClusterTasksResult<T>	Represents the result of a batched execution of cluster state update tasks
ClusterStateTaskExecutor.ClusterTasksResult.Builder<T>
ClusterStateTaskExecutor.TaskResult
ClusterStateUpdateTask	A task that can update the cluster state.
DiffableUtils
DiffableUtils.DiffableValueReader<K,V extends Diffable<V>>	Implementation of the ValueSerializer that wraps value and diff readers.
DiffableUtils.DiffableValueSerializer<K,V extends Diffable<V>>	Serializer for Diffable map values.
DiffableUtils.ImmutableOpenMapDiff<K,T>	Represents differences between two ImmutableOpenMap of (possibly diffable) objects
DiffableUtils.MapDiff<K,T,M>	Represents differences between two maps of objects and is used as base class for different map implementations.
DiffableUtils.NonDiffableValueSerializer<K,V>	Serializer for non-diffable map values
DiffableUtils.StringSetValueSerializer<K>	Implementation of ValueSerializer that serializes immutable sets
DiskUsage	Encapsulation class used to represent the amount of disk used on a node.
EmptyClusterInfoService	ClusterInfoService that provides empty maps for disk usage and shard sizes
InternalClusterInfoService	InternalClusterInfoService provides the ClusterInfoService interface, routinely updated on a timer.
LocalClusterUpdateTask	Used to apply state updates on nodes that are not necessarily master
MasterNodeChangePredicate
NamedDiffableValueSerializer<T extends NamedDiffable<T>>	Value Serializer for named diffables
NodeConnectionsService	This component is responsible for maintaining connections from this node to all the nodes listed in the cluster state, and for disconnecting from nodes once they are removed from the cluster state.
RepositoryCleanupInProgress
RepositoryCleanupInProgress.Entry
RestoreInProgress	Meta data about restore processes that are currently executing
RestoreInProgress.Builder
RestoreInProgress.Entry	Restore metadata
RestoreInProgress.ShardRestoreStatus	Represents status of a restored shard
SnapshotDeletionsInProgress	A class that represents the snapshot deletions that are in progress in the cluster.
SnapshotDeletionsInProgress.Entry	A class representing a snapshot deletion request entry in the cluster state.
SnapshotsInProgress	Meta data about snapshots that are currently executing
SnapshotsInProgress.Entry
SnapshotsInProgress.ShardSnapshotStatus

Enum Summary

Enum	Description
ClusterState.Metric
RestoreInProgress.State	Shard restore process state
SnapshotDeletionsInProgress.State
SnapshotsInProgress.ShardState
SnapshotsInProgress.State

Exception Summary

Exception	Description
IncompatibleClusterStateVersionException	Thrown by Diff.apply(T) method
NotMasterException	Thrown when a node join request or a master ping reaches a node which is not currently acting as a master or when a cluster state update task is to be executed on a node that is no longer master.