Package org.opensearch.cluster

Class RepositoryCleanupInProgress

java.lang.Object

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

org.opensearch.cluster.RepositoryCleanupInProgress

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 final class RepositoryCleanupInProgress
extends AbstractNamedDiffable<ClusterState.Custom>
implements ClusterState.Custom

Information passed during repository cleanup

Opensearch.internal:

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	RepositoryCleanupInProgress.Entry	Entry in the collection.

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

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

EMPTY_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
List<RepositoryCleanupInProgress.Entry>	entries()
org.opensearch.Version	getMinimalSupportedVersion()
String	getWriteableName()
boolean	hasCleanupInProgress()
static NamedDiff<ClusterState.Custom>	readDiffFrom(org.opensearch.core.common.io.stream.StreamInput in)
static RepositoryCleanupInProgress.Entry	startedEntry(String repository, long repositoryStateId)
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, equals, finalize, getClass, hashCode, 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 RepositoryCleanupInProgress EMPTY

TYPE

public static final String TYPE

See Also:

• Constant Field Values

Constructor Details

RepositoryCleanupInProgress

public RepositoryCleanupInProgress(List<RepositoryCleanupInProgress.Entry> entries)

Method Details

readDiffFrom

public static NamedDiff<ClusterState.Custom> readDiffFrom(org.opensearch.core.common.io.stream.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()

Specified by:

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

Specified by:

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

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

toString

public String toString()

Overrides:

toString in class Object

getMinimalSupportedVersion

public org.opensearch.Version getMinimalSupportedVersion()

Specified by:

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