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

Class SnapshotIndexStatus

java.lang.Object

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

All Implemented Interfaces:

Iterable<SnapshotIndexShardStatus>, ToXContent, ToXContentFragment

public class SnapshotIndexStatus
extends Object
implements Iterable<SnapshotIndexShardStatus>, ToXContentFragment

Represents snapshot status of all shards in the index

Nested Class Summary

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
SnapshotIndexStatus(String index, Map<Integer,SnapshotIndexShardStatus> indexShards, SnapshotShardsStats shardsStats, SnapshotStats stats)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
static SnapshotIndexStatus	fromXContent(XContentParser parser)
String	getIndex()	Returns the index name
Map<Integer,SnapshotIndexShardStatus>	getShards()	A shard id to index snapshot shard status map
SnapshotShardsStats	getShardsStats()	Shards stats
SnapshotStats	getStats()	Returns snapshot stats
int	hashCode()
Iterator<SnapshotIndexShardStatus>	iterator()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Constructor Details

SnapshotIndexStatus

public SnapshotIndexStatus(String index,
 Map<Integer,SnapshotIndexShardStatus> indexShards,
 SnapshotShardsStats shardsStats,
 SnapshotStats stats)

Method Details

getIndex

public String getIndex()

Returns the index name

getShards

public Map<Integer,SnapshotIndexShardStatus> getShards()

A shard id to index snapshot shard status map

getShardsStats

public SnapshotShardsStats getShardsStats()

Shards stats

getStats

public SnapshotStats getStats()

Returns snapshot stats

iterator

public Iterator<SnapshotIndexShardStatus> iterator()

Specified by:

iterator in interface Iterable<SnapshotIndexShardStatus>

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

fromXContent

public static SnapshotIndexStatus 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