Package org.elasticsearch.cluster

Class SnapshotDeletionsInProgress

java.lang.Object

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

org.elasticsearch.cluster.SnapshotDeletionsInProgress

All Implemented Interfaces:

ClusterState.Custom, ClusterState.FeatureAware, Diffable<ClusterState.Custom>, NamedDiffable<ClusterState.Custom>, NamedWriteable, VersionedNamedWriteable, Writeable, ToXContent, ToXContentFragment

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

A class that represents the snapshot deletions that are in progress in the cluster.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SnapshotDeletionsInProgress.Entry	A class representing a snapshot deletion request entry in the cluster state.

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

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 java.lang.String	TYPE
static Version	VERSION_INTRODUCED

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
SnapshotDeletionsInProgress()
SnapshotDeletionsInProgress(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object o)
java.util.List<SnapshotDeletionsInProgress.Entry>	getEntries()	Returns an unmodifiable list of snapshot deletion entries.
Version	getMinimalSupportedVersion()	The minimal version of the recipient this object can be sent to
java.lang.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.
int	hashCode()
static SnapshotDeletionsInProgress	newInstance(SnapshotDeletionsInProgress.Entry entry)	Returns a new instance of SnapshotDeletionsInProgress with the given SnapshotDeletionsInProgress.Entry added.
static NamedDiff<ClusterState.Custom>	readDiffFrom(StreamInput in)
java.lang.String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
SnapshotDeletionsInProgress	withAddedEntry(SnapshotDeletionsInProgress.Entry entry)	Returns a new instance of SnapshotDeletionsInProgress which adds the given SnapshotDeletionsInProgress.Entry to the invoking instance.
SnapshotDeletionsInProgress	withRemovedEntry(SnapshotDeletionsInProgress.Entry entry)	Returns a new instance of SnapshotDeletionsInProgress which removes the given entry from the invoking instance.
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.elasticsearch.cluster.AbstractNamedDiffable

diff, get, readDiffFrom

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

isPrivate

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

getRequiredFeature

Methods inherited from interface org.elasticsearch.cluster.Diffable

diff

Methods inherited from class java.lang.Object

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

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

isFragment

Field Detail

TYPE

public static final java.lang.String TYPE

See Also:

Constant Field Values

VERSION_INTRODUCED

public static final Version VERSION_INTRODUCED

Constructor Detail

SnapshotDeletionsInProgress

public SnapshotDeletionsInProgress()

SnapshotDeletionsInProgress

public SnapshotDeletionsInProgress(StreamInput in)
                            throws java.io.IOException

Throws:

java.io.IOException

Method Detail

newInstance

public static SnapshotDeletionsInProgress newInstance(SnapshotDeletionsInProgress.Entry entry)

Returns a new instance of SnapshotDeletionsInProgress with the given SnapshotDeletionsInProgress.Entry added.

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(SnapshotDeletionsInProgress.Entry entry)

Returns a new instance of SnapshotDeletionsInProgress which removes the given entry from the invoking instance.

getEntries

public java.util.List<SnapshotDeletionsInProgress.Entry> getEntries()

Returns an unmodifiable list of snapshot deletion entries.

hasDeletionsInProgress

public boolean hasDeletionsInProgress()

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

getWriteableName

public java.lang.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(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

writeTo

public void writeTo(StreamOutput out)
             throws java.io.IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

java.io.IOException

readDiffFrom

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

Throws:

java.io.IOException

getMinimalSupportedVersion

public Version getMinimalSupportedVersion()

Description copied from interface: VersionedNamedWriteable

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

Specified by:

getMinimalSupportedVersion in interface VersionedNamedWriteable

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
                                  ToXContent.Params params)
                           throws java.io.IOException

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object