Package org.elasticsearch.cluster

Class SnapshotsInProgress

java.lang.Object

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

org.elasticsearch.cluster.SnapshotsInProgress

All Implemented Interfaces:

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

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

Meta data about snapshots that are currently executing

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SnapshotsInProgress.Entry
static class	SnapshotsInProgress.ShardSnapshotStatus
static class	SnapshotsInProgress.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 long	UNDEFINED_REPOSITORY_STATE_ID

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
SnapshotsInProgress(java.util.List<SnapshotsInProgress.Entry> entries)
SnapshotsInProgress(SnapshotsInProgress.Entry... entries)
SnapshotsInProgress(StreamInput in)

Method Summary

Modifier and Type	Method	Description
static boolean	completed(com.carrotsearch.hppc.ObjectContainer<SnapshotsInProgress.ShardSnapshotStatus> shards)	Checks if all shards in the list have completed
java.util.List<SnapshotsInProgress.Entry>	entries()
boolean	equals(java.lang.Object o)
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
int	hashCode()
static NamedDiff<ClusterState.Custom>	readDiffFrom(StreamInput in)
SnapshotsInProgress.Entry	snapshot(Snapshot snapshot)
java.lang.String	toString()
void	toXContent(SnapshotsInProgress.Entry entry, XContentBuilder builder, ToXContent.Params params)
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
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

UNDEFINED_REPOSITORY_STATE_ID

public static final long UNDEFINED_REPOSITORY_STATE_ID

See Also:

Constant Field Values

Constructor Detail

SnapshotsInProgress

public SnapshotsInProgress(java.util.List<SnapshotsInProgress.Entry> entries)

SnapshotsInProgress

public SnapshotsInProgress(SnapshotsInProgress.Entry... entries)

SnapshotsInProgress

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

Throws:

java.io.IOException

Method Detail

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

completed

public static boolean completed(com.carrotsearch.hppc.ObjectContainer<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

entries

public java.util.List<SnapshotsInProgress.Entry> entries()

snapshot

public SnapshotsInProgress.Entry snapshot(Snapshot snapshot)

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

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

readDiffFrom

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

Throws:

java.io.IOException

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

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException

toXContent

public void toXContent(SnapshotsInProgress.Entry entry,
                       XContentBuilder builder,
                       ToXContent.Params params)
                throws java.io.IOException

Throws:

java.io.IOException