org.elasticsearch.action.admin.cluster.snapshots.status

Class SnapshotStatus

java.lang.Object

org.elasticsearch.action.admin.cluster.snapshots.status.SnapshotStatus

All Implemented Interfaces:

Streamable, ToXContent

public class SnapshotStatus
extends Object
implements ToXContent, Streamable

Status of a snapshot

Nested Class Summary

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

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

EMPTY_PARAMS

Method Summary

Modifier and Type	Method and Description
Map<String,SnapshotIndexStatus>	getIndices() Returns list of snapshot indices
List<SnapshotIndexShardStatus>	getShards() Returns list of snapshot shards
SnapshotShardsStats	getShardsStats()
SnapshotId	getSnapshotId() Returns snapshot id
SnapshotsInProgress.State	getState() Returns snapshot state
SnapshotStats	getStats() Returns number of files in the snapshot
void	readFrom(StreamInput in)
static SnapshotStatus	readSnapshotStatus(StreamInput in) Reads snapshot status from stream input
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getSnapshotId

public SnapshotId getSnapshotId()

Returns snapshot id

getState

public SnapshotsInProgress.State getState()

Returns snapshot state

getShards

public List<SnapshotIndexShardStatus> getShards()

Returns list of snapshot shards

getShardsStats

public SnapshotShardsStats getShardsStats()

getIndices

public Map<String,SnapshotIndexStatus> getIndices()

Returns list of snapshot indices

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Throws:

IOException

readSnapshotStatus

public static SnapshotStatus readSnapshotStatus(StreamInput in)
                                         throws IOException

Reads snapshot status from stream input

Parameters:

in - stream input

Returns:

deserialized snapshot status

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object

getStats

public SnapshotStats getStats()

Returns number of files in the snapshot

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException