Module org.elasticsearch.server

Package org.elasticsearch.cluster

Class SnapshotDeletionsInProgress

java.lang.Object

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

org.elasticsearch.cluster.SnapshotDeletionsInProgress

All Implemented Interfaces:

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

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

Represents the in-progress snapshot deletions in the cluster state.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	SnapshotDeletionsInProgress.Entry	A class representing a snapshot deletion request entry in the cluster state.
static enum	SnapshotDeletionsInProgress.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 SnapshotDeletionsInProgress	EMPTY
static final String	TYPE

Constructor Summary

Constructors

Constructor	Description
SnapshotDeletionsInProgress(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
static SnapshotDeletionsInProgress	get(ClusterState state)
List<SnapshotDeletionsInProgress.Entry>	getEntries()	Returns an unmodifiable list of snapshot deletion entries.
TransportVersion	getMinimalSupportedVersion()	The minimal version of the recipient this object can be sent to
String	getWriteableName()	Returns the name of the writeable object
boolean	hasDeletionsInProgress()	Returns true if there are snapshot deletions in progress in the cluster, returns false otherwise.
boolean	hasExecutingDeletion(String repository)	Checks if there is an actively executing delete operation for the given repository
int	hashCode()
static SnapshotDeletionsInProgress	of(List<SnapshotDeletionsInProgress.Entry> entries)
static NamedDiff<ClusterState.Custom>	readDiffFrom(StreamInput in)
String	toString()
Iterator<? extends ToXContent>	toXContentChunked(ToXContent.Params ignored)	Serialize this ClusterState.Custom for diagnostic purposes, exposed by the
SnapshotDeletionsInProgress	withAddedEntry(SnapshotDeletionsInProgress.Entry entry)	Returns a new instance of SnapshotDeletionsInProgress which adds the given SnapshotDeletionsInProgress.Entry to the invoking instance.
SnapshotDeletionsInProgress	withRemovedEntry(String deleteUUID)	Returns a new instance of SnapshotDeletionsInProgress that has the entry with the given deleteUUID removed from its entries.
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.elasticsearch.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.elasticsearch.common.xcontent.ChunkedToXContent

isFragment, toXContentChunkedV7

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

isPrivate

Methods inherited from interface org.elasticsearch.cluster.Diffable

diff

Field Details

EMPTY

public static final SnapshotDeletionsInProgress EMPTY

TYPE

public static final String TYPE

See Also:

• Constant Field Values

Constructor Details

SnapshotDeletionsInProgress

public SnapshotDeletionsInProgress(StreamInput in)
                            throws IOException

Throws:

IOException

Method Details

of

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

get

public static SnapshotDeletionsInProgress get(ClusterState state)

withAddedEntry

public SnapshotDeletionsInProgress withAddedEntry(SnapshotDeletionsInProgress.Entry entry)

Returns a new instance of SnapshotDeletionsInProgress which adds the given SnapshotDeletionsInProgress.Entry to the invoking instance.

withRemovedEntry

public SnapshotDeletionsInProgress withRemovedEntry(String deleteUUID)

Returns a new instance of SnapshotDeletionsInProgress that has the entry with the given deleteUUID removed from its entries.

getEntries

public List<SnapshotDeletionsInProgress.Entry> getEntries()

Returns an unmodifiable list of snapshot deletion entries.

hasExecutingDeletion

public boolean hasExecutingDeletion(String repository)

Checks if there is an actively executing delete operation for the given repository

Parameters:

repository - repository name

hasDeletionsInProgress

public boolean hasDeletionsInProgress()

Returns true if there are snapshot deletions in progress in the cluster, returns false otherwise.

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

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

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

readDiffFrom

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

Throws:

IOException

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

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

toString

public String toString()

Overrides:

toString in class Object