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

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

Represents snapshot status of all shards in the index

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

Methods

Modifier and Type	Method and Description
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
Iterator<SnapshotIndexShardStatus>	iterator()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)

Methods inherited from class java.lang.Object

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

Method Detail

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