Module org.elasticsearch.server

Package org.elasticsearch.cluster

Class SnapshotsInProgress

java.lang.Object

org.elasticsearch.cluster.AbstractNamedDiffable<ClusterState.Custom>

org.elasticsearch.cluster.SnapshotsInProgress

All Implemented Interfaces:

ClusterState.Custom, Diffable<ClusterState.Custom>, NamedDiffable<ClusterState.Custom>, NamedWriteable, VersionedNamedWriteable, Writeable, ChunkedToXContent

public class SnapshotsInProgress
extends AbstractNamedDiffable<ClusterState.Custom>
implements ClusterState.Custom

Meta data about snapshots that are currently executing

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SnapshotsInProgress.Entry
static final record	SnapshotsInProgress.ShardSnapshotStatus
static enum	SnapshotsInProgress.ShardState	The current stage/phase of the shard snapshot, and whether it has completed or failed.
static enum	SnapshotsInProgress.State

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ABORTED_FAILURE_TEXT
static final SnapshotsInProgress	EMPTY
static final String	TYPE

Constructor Summary

Constructors

Constructor	Description
SnapshotsInProgress(StreamInput in)

Method Summary

Modifier and Type	Method	Description
Stream<SnapshotsInProgress.Entry>	asStream()
static boolean	completed(Collection<SnapshotsInProgress.ShardSnapshotStatus> shards)	Checks if all shards in the list have completed
int	count()
Diff<ClusterState.Custom>	diff(ClusterState.Custom previousState)	Returns serializable object representing differences between this and previousState
Iterable<List<SnapshotsInProgress.Entry>>	entriesByRepo()
boolean	equals(Object o)
List<SnapshotsInProgress.Entry>	forRepo(String repository)	Returns the list of snapshots in the specified repository.
static SnapshotsInProgress	get(ClusterState state)	Returns the SnapshotInProgress metadata present within the given cluster state.
TransportVersion	getMinimalSupportedVersion()	The minimal version of the recipient this object can be sent to
String	getWriteableName()	Returns the name of the writeable object
int	hashCode()
boolean	isEmpty()
boolean	isNodeIdForRemoval(String nodeId)
boolean	nodeIdsForRemovalChanged(SnapshotsInProgress other)
Map<RepositoryShardId,Set<ShardGeneration>>	obsoleteGenerations(String repository, SnapshotsInProgress oldClusterStateSnapshots)	Computes a map of repository shard id to set of shard generations, containing all shard generations that became obsolete and may be deleted from the repository as the cluster state moves from the given old value of SnapshotsInProgress to this instance.
static NamedDiff<ClusterState.Custom>	readDiffFrom(StreamInput in)
SnapshotsInProgress.Entry	snapshot(Snapshot snapshot)
static SnapshotsInProgress.Entry	startClone(Snapshot snapshot, SnapshotId source, Map<String,IndexId> indices, long startTime, long repositoryStateId, IndexVersion version)	Creates the initial snapshot clone entry
static SnapshotsInProgress.Entry	startedEntry(Snapshot snapshot, boolean includeGlobalState, boolean partial, Map<String,IndexId> indices, List<String> dataStreams, long startTime, long repositoryStateId, Map<ShardId,SnapshotsInProgress.ShardSnapshotStatus> shards, Map<String,Object> userMetadata, IndexVersion version, List<SnapshotFeatureInfo> featureStates)	Creates the initial SnapshotsInProgress.Entry when starting a snapshot, if no shard-level snapshot work is to be done the resulting entry will be in state SnapshotsInProgress.State.SUCCESS right away otherwise it will be in state SnapshotsInProgress.State.STARTED.
String	toString()
Iterator<? extends ToXContent>	toXContentChunked(ToXContent.Params ignored)	Serialize this ClusterState.Custom for diagnostic purposes, exposed by the
SnapshotsInProgress	withAddedEntry(SnapshotsInProgress.Entry entry)
SnapshotsInProgress	withUpdatedEntriesForRepo(String repository, List<SnapshotsInProgress.Entry> updatedEntries)
SnapshotsInProgress	withUpdatedNodeIdsForRemoval(ClusterState clusterState)	Adds any new node IDs to nodesIdsForRemoval, and removes any node IDs that are no longer marked for shutdown if they have no running shard snapshots.
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.elasticsearch.cluster.AbstractNamedDiffable

get, readDiffFrom

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.common.xcontent.ChunkedToXContent

isFragment, toXContentChunkedV7

Methods inherited from interface org.elasticsearch.cluster.ClusterState.Custom

isPrivate

Field Details

EMPTY

public static final SnapshotsInProgress EMPTY

TYPE

public static final String TYPE

See Also:

• Constant Field Values

ABORTED_FAILURE_TEXT

public static final String ABORTED_FAILURE_TEXT

See Also:

• Constant Field Values

Constructor Details

SnapshotsInProgress

public SnapshotsInProgress(StreamInput in)
                    throws IOException

Throws:

IOException

Method Details

get

public static SnapshotsInProgress get(ClusterState state)

Returns the SnapshotInProgress metadata present within the given cluster state.

withUpdatedEntriesForRepo

public SnapshotsInProgress withUpdatedEntriesForRepo(String repository,
 List<SnapshotsInProgress.Entry> updatedEntries)

withAddedEntry

public SnapshotsInProgress withAddedEntry(SnapshotsInProgress.Entry entry)

forRepo

public List<SnapshotsInProgress.Entry> forRepo(String repository)

Returns the list of snapshots in the specified repository.

isEmpty

public boolean isEmpty()

count

public int count()

entriesByRepo

public Iterable<List<SnapshotsInProgress.Entry>> entriesByRepo()

asStream

public Stream<SnapshotsInProgress.Entry> asStream()

snapshot

@Nullable
public SnapshotsInProgress.Entry snapshot(Snapshot snapshot)

obsoleteGenerations

public Map<RepositoryShardId,Set<ShardGeneration>> obsoleteGenerations(String repository,
 SnapshotsInProgress oldClusterStateSnapshots)

Computes a map of repository shard id to set of shard generations, containing all shard generations that became obsolete and may be deleted from the repository as the cluster state moves from the given old value of SnapshotsInProgress to this instance.

An unique shard generation is created for every in-progress shard snapshot. The shard generation file contains information about all the files needed by pre-existing and any new shard snapshots that were in-progress. When a shard snapshot is finalized, its file list is promoted to the official shard snapshot list for the index shard. This final list will contain metadata about any other in-progress shard snapshots that were not yet finalized when it began. All these other in-progress shard snapshot lists are scheduled for deletion now.

getWriteableName

public String getWriteableName()

Description copied from interface: VersionedNamedWriteable

Returns the name of the writeable object

Specified by:

getWriteableName in interface NamedWriteable

Specified by:

getWriteableName in interface VersionedNamedWriteable

getMinimalSupportedVersion

public TransportVersion getMinimalSupportedVersion()

Description copied from interface: VersionedNamedWriteable

The minimal version of the recipient this object can be sent to

Specified by:

getMinimalSupportedVersion in interface VersionedNamedWriteable

readDiffFrom

public static NamedDiff<ClusterState.Custom> readDiffFrom(StreamInput in)
                                                   throws IOException

Throws:

IOException

diff

public Diff<ClusterState.Custom> diff(ClusterState.Custom previousState)

Description copied from interface: Diffable

Returns serializable object representing differences between this and previousState

Specified by:

diff in interface Diffable<ClusterState.Custom>

Overrides:

diff in class AbstractNamedDiffable<ClusterState.Custom>

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

toXContentChunked

public Iterator<? extends ToXContent> toXContentChunked(ToXContent.Params ignored)

Description copied from interface: ClusterState.Custom

Serialize this ClusterState.Custom for diagnostic purposes, exposed by the

GET _cluster/state

API etc. The XContent representation does not need to be 100% faithful since we never reconstruct a cluster state from its XContent representation, but the more faithful it is the more useful it is for diagnostics.

Specified by:

toXContentChunked in interface ChunkedToXContent

Specified by:

toXContentChunked in interface ClusterState.Custom

Returns:

iterator over chunks of ToXContent

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

startedEntry

public static SnapshotsInProgress.Entry startedEntry(Snapshot snapshot,
 boolean includeGlobalState,
 boolean partial,
 Map<String,IndexId> indices,
 List<String> dataStreams,
 long startTime,
 long repositoryStateId,
 Map<ShardId,SnapshotsInProgress.ShardSnapshotStatus> shards,
 Map<String,Object> userMetadata,
 IndexVersion version,
 List<SnapshotFeatureInfo> featureStates)

Creates the initial SnapshotsInProgress.Entry when starting a snapshot, if no shard-level snapshot work is to be done the resulting entry will be in state SnapshotsInProgress.State.SUCCESS right away otherwise it will be in state SnapshotsInProgress.State.STARTED.

startClone

public static SnapshotsInProgress.Entry startClone(Snapshot snapshot,
 SnapshotId source,
 Map<String,IndexId> indices,
 long startTime,
 long repositoryStateId,
 IndexVersion version)

Creates the initial snapshot clone entry

Parameters:

snapshot - snapshot to clone into

source - snapshot to clone from

indices - indices to clone

startTime - start time

repositoryStateId - repository state id that this clone is based on

version - repository metadata version to write

Returns:

snapshot clone entry

completed

public static boolean completed(Collection<SnapshotsInProgress.ShardSnapshotStatus> shards)

Checks if all shards in the list have completed

Parameters:

shards - list of shard statuses

Returns:

true if all shards have completed (either successfully or failed), false otherwise

isNodeIdForRemoval

public boolean isNodeIdForRemoval(String nodeId)

withUpdatedNodeIdsForRemoval

public SnapshotsInProgress withUpdatedNodeIdsForRemoval(ClusterState clusterState)

Adds any new node IDs to nodesIdsForRemoval, and removes any node IDs that are no longer marked for shutdown if they have no running shard snapshots.

nodeIdsForRemovalChanged

public boolean nodeIdsForRemovalChanged(SnapshotsInProgress other)