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

Class SnapshotStatus

java.lang.Object

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

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

public class SnapshotStatus
extends Object
implements ToXContentObject, Writeable

Status of a snapshot

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.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 inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
static SnapshotStatus	fromXContent(XContentParser parser)
Map<String,SnapshotIndexStatus>	getIndices()	Returns list of snapshot indices
List<SnapshotIndexShardStatus>	getShards()	Returns list of snapshot shards
SnapshotShardsStats	getShardsStats()
Snapshot	getSnapshot()	Returns snapshot
SnapshotsInProgress.State	getState()	Returns snapshot state
SnapshotStats	getStats()	Returns number of files in the snapshot
int	hashCode()
Boolean	includeGlobalState()	Returns true if global state is included in the snapshot, false otherwise.
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Method Details

getSnapshot

public Snapshot getSnapshot()

Returns snapshot

getState

public SnapshotsInProgress.State getState()

Returns snapshot state

includeGlobalState

public Boolean includeGlobalState()

Returns true if global state is included in the snapshot, false otherwise. Can be null if this information is unknown.

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

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

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

fromXContent

public static SnapshotStatus fromXContent(XContentParser parser)
                                   throws IOException

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object