Module org.elasticsearch.server

Package org.elasticsearch.cluster

Class RepositoryCleanupInProgress

java.lang.Object

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

org.elasticsearch.cluster.RepositoryCleanupInProgress

All Implemented Interfaces:

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

public final class RepositoryCleanupInProgress
extends AbstractNamedDiffable<ClusterState.Custom>
implements ClusterState.Custom

A repository cleanup request entry. Part of the cluster state.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	RepositoryCleanupInProgress.Entry

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 RepositoryCleanupInProgress	EMPTY
static final String	TYPE

Constructor Summary

Constructors

Constructor	Description
RepositoryCleanupInProgress(List<RepositoryCleanupInProgress.Entry> entries)

Method Summary

Modifier and Type	Method	Description
List<RepositoryCleanupInProgress.Entry>	entries()
static RepositoryCleanupInProgress	get(ClusterState state)
TransportVersion	getMinimalSupportedVersion()	The minimal version of the recipient this object can be sent to
String	getWriteableName()	Returns the name of the writeable object
boolean	hasCleanupInProgress()
static NamedDiff<ClusterState.Custom>	readDiffFrom(StreamInput in)
static RepositoryCleanupInProgress.Entry	startedEntry(String repository, long repositoryStateId)
String	toString()
Iterator<? extends ToXContent>	toXContentChunked(ToXContent.Params ignored)	Serialize this ClusterState.Custom for diagnostic purposes, exposed by the
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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

isFragment, toXContentChunked, toXContentChunkedV8

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 RepositoryCleanupInProgress EMPTY

TYPE

public static final String TYPE

See Also:

• Constant Field Values

Constructor Details

RepositoryCleanupInProgress

public RepositoryCleanupInProgress(List<RepositoryCleanupInProgress.Entry> entries)

Method Details

get

public static RepositoryCleanupInProgress get(ClusterState state)

readDiffFrom

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

Throws:

IOException

startedEntry

public static RepositoryCleanupInProgress.Entry startedEntry(String repository,
 long repositoryStateId)

hasCleanupInProgress

public boolean hasCleanupInProgress()

entries

public List<RepositoryCleanupInProgress.Entry> entries()

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

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

toString

public String toString()

Overrides:

toString in class Object

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