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

Class SnapshotIndexStatus

java.lang.Object

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

All Implemented Interfaces:

java.lang.Iterable<SnapshotIndexShardStatus>, ToXContent, ToXContentFragment

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

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

Modifier and Type	Method	Description
java.lang.String	getIndex()	Returns the index name
java.util.Map<java.lang.Integer,SnapshotIndexShardStatus>	getShards()	A shard id to index snapshot shard status map
SnapshotShardsStats	getShardsStats()	Shards stats
SnapshotStats	getStats()	Returns snapshot stats
java.util.Iterator<SnapshotIndexShardStatus>	iterator()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentFragment

isFragment

Method Detail

getIndex

public java.lang.String getIndex()

Returns the index name

getShards

public java.util.Map<java.lang.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 java.util.Iterator<SnapshotIndexShardStatus> iterator()

Specified by:

iterator in interface java.lang.Iterable<SnapshotIndexShardStatus>

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException