Package org.opensearch.cluster

Class SnapshotsInProgress

java.lang.Object

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

org.opensearch.cluster.SnapshotsInProgress

All Implemented Interfaces:

ClusterState.Custom, ClusterState.FeatureAware, Diffable<ClusterState.Custom>, NamedDiffable<ClusterState.Custom>, org.opensearch.core.common.io.stream.NamedWriteable, org.opensearch.core.common.io.stream.VersionedNamedWriteable, org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentFragment

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

Meta data about snapshots that are currently executing

Opensearch.internal:

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SnapshotsInProgress.Entry	Entry in the collection.
static class	SnapshotsInProgress.ShardSnapshotStatus	Status of shard snapshots.
static enum	SnapshotsInProgress.ShardState	The shard state.
static enum	SnapshotsInProgress.State	State of the snapshots.

Nested classes/interfaces inherited from interface org.opensearch.core.xcontent.ToXContent

org.opensearch.core.xcontent.ToXContent.DelegatingMapParams, org.opensearch.core.xcontent.ToXContent.MapParams, org.opensearch.core.xcontent.ToXContent.Params

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

org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.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

Fields inherited from interface org.opensearch.core.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
SnapshotsInProgress(org.opensearch.core.common.io.stream.StreamInput in)

Method Summary

Modifier and Type	Method	Description
static boolean	completed(Collection<SnapshotsInProgress.ShardSnapshotStatus> shards)	Checks if all shards in the list have completed
List<SnapshotsInProgress.Entry>	entries()
boolean	equals(Object o)
org.opensearch.Version	getMinimalSupportedVersion()
String	getWriteableName()
int	hashCode()
static SnapshotsInProgress	of(List<SnapshotsInProgress.Entry> entries)
static NamedDiff<ClusterState.Custom>	readDiffFrom(org.opensearch.core.common.io.stream.StreamInput in)
SnapshotsInProgress.Entry	snapshot(Snapshot snapshot)
static SnapshotsInProgress.Entry	startClone(Snapshot snapshot, SnapshotId source, List<IndexId> indices, long startTime, long repositoryStateId, org.opensearch.Version version)	Creates the initial snapshot clone entry
static SnapshotsInProgress.Entry	startedEntry(Snapshot snapshot, boolean includeGlobalState, boolean partial, List<IndexId> indices, List<String> dataStreams, long startTime, long repositoryStateId, Map<org.opensearch.core.index.shard.ShardId,SnapshotsInProgress.ShardSnapshotStatus> shards, Map<String,Object> userMetadata, org.opensearch.Version version, boolean remoteStoreIndexShallowCopy)	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()
org.opensearch.core.xcontent.XContentBuilder	toXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
void	writeTo(org.opensearch.core.common.io.stream.StreamOutput out)

Methods inherited from class org.opensearch.cluster.AbstractNamedDiffable

diff, get, readDiffFrom

Methods inherited from class java.lang.Object

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

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

isPrivate

Methods inherited from interface org.opensearch.cluster.ClusterState.FeatureAware

getRequiredFeature

Methods inherited from interface org.opensearch.cluster.Diffable

diff

Methods inherited from interface org.opensearch.core.xcontent.ToXContentFragment

isFragment

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(org.opensearch.core.common.io.stream.StreamInput in)
                    throws IOException

Throws:

IOException

Method Details

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,
 List<IndexId> indices,
 List<String> dataStreams,
 long startTime,
 long repositoryStateId,
 Map<org.opensearch.core.index.shard.ShardId,SnapshotsInProgress.ShardSnapshotStatus> shards,
 Map<String,Object> userMetadata,
 org.opensearch.Version version,
 boolean remoteStoreIndexShallowCopy)

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,
 List<IndexId> indices,
 long startTime,
 long repositoryStateId,
 org.opensearch.Version 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

of

public static SnapshotsInProgress of(List<SnapshotsInProgress.Entry> entries)

entries

public List<SnapshotsInProgress.Entry> entries()

snapshot

public SnapshotsInProgress.Entry snapshot(Snapshot snapshot)

getWriteableName

public String getWriteableName()

Specified by:

getWriteableName in interface org.opensearch.core.common.io.stream.NamedWriteable

Specified by:

getWriteableName in interface org.opensearch.core.common.io.stream.VersionedNamedWriteable

getMinimalSupportedVersion

public org.opensearch.Version getMinimalSupportedVersion()

Specified by:

getMinimalSupportedVersion in interface org.opensearch.core.common.io.stream.VersionedNamedWriteable

readDiffFrom

public static NamedDiff<ClusterState.Custom> readDiffFrom(org.opensearch.core.common.io.stream.StreamInput in)
                                                   throws IOException

Throws:

IOException

writeTo

public void writeTo(org.opensearch.core.common.io.stream.StreamOutput out)
             throws IOException

Specified by:

writeTo in interface org.opensearch.core.common.io.stream.Writeable

Throws:

IOException

toXContent

public org.opensearch.core.xcontent.XContentBuilder toXContent(org.opensearch.core.xcontent.XContentBuilder builder,
 org.opensearch.core.xcontent.ToXContent.Params params)
                                                        throws IOException

Specified by:

toXContent in interface org.opensearch.core.xcontent.ToXContent

Throws:

IOException