org.elasticsearch.cluster

Class SnapshotsInProgress

java.lang.Object

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

org.elasticsearch.cluster.SnapshotsInProgress

All Implemented Interfaces:

ClusterState.Custom, Diffable<ClusterState.Custom>, StreamableReader<ClusterState.Custom>, Writeable<ClusterState.Custom>, ToXContent

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

Meta data about snapshots that are currently executing

Nested Class Summary

Nested Classes

Modifier and Type	Class and 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

Field Summary

Fields

Modifier and Type	Field and Description
static SnapshotsInProgress	PROTO
static String	TYPE

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
SnapshotsInProgress(List<SnapshotsInProgress.Entry> entries)
SnapshotsInProgress(SnapshotsInProgress.Entry... entries)

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	completed(Collection<SnapshotsInProgress.ShardSnapshotStatus> shards) Checks if all shards in the list have completed
List<SnapshotsInProgress.Entry>	entries()
boolean	equals(Object o)
int	hashCode()
SnapshotsInProgress	readFrom(StreamInput in) Reads a copy of an object with the same type form the stream input The caller object remains unchanged.
SnapshotsInProgress.Entry	snapshot(SnapshotId snapshotId)
void	toXContent(SnapshotsInProgress.Entry entry, XContentBuilder builder, ToXContent.Params params)
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
String	type()
void	writeTo(StreamOutput out) Writes the current object into the output stream out

Methods inherited from class org.elasticsearch.cluster.AbstractDiffable

diff, get, readDiffFrom, readDiffFrom

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.cluster.Diffable

diff, readDiffFrom

Field Detail

TYPE

public static final String TYPE

See Also:

Constant Field Values

PROTO

public static final SnapshotsInProgress PROTO

Constructor Detail

SnapshotsInProgress

public SnapshotsInProgress(List<SnapshotsInProgress.Entry> entries)

SnapshotsInProgress

public SnapshotsInProgress(SnapshotsInProgress.Entry... entries)

Method Detail

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

completed

public static boolean completed(Collection<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 List<SnapshotsInProgress.Entry> entries()

snapshot

public SnapshotsInProgress.Entry snapshot(SnapshotId snapshotId)

type

public String type()

Specified by:

type in interface ClusterState.Custom

readFrom

public SnapshotsInProgress readFrom(StreamInput in)
                             throws IOException

Description copied from interface: StreamableReader

Reads a copy of an object with the same type form the stream input The caller object remains unchanged.

Specified by:

readFrom in interface StreamableReader<ClusterState.Custom>

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Writes the current object into the output stream out

Specified by:

writeTo in interface Writeable<ClusterState.Custom>

Throws:

IOException

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

toXContent

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

Throws:

IOException