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>, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentFragment

public class SnapshotIndexStatus
extends Object
implements Iterable<SnapshotIndexShardStatus>, org.elasticsearch.common.xcontent.ToXContentFragment

Represents snapshot status of all shards in the index

Nested Class Summary

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

org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params

Field Summary

Fields inherited from interface org.elasticsearch.common.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(org.elasticsearch.common.xcontent.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()
org.elasticsearch.common.xcontent.XContentBuilder	toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.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.common.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 org.elasticsearch.common.xcontent.XContentBuilder toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder,
 org.elasticsearch.common.xcontent.ToXContent.Params params)
                                                             throws IOException

Specified by:

toXContent in interface org.elasticsearch.common.xcontent.ToXContent

Throws:

IOException

fromXContent

public static SnapshotIndexStatus fromXContent(org.elasticsearch.common.xcontent.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