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

Class SnapshotIndexStatus

java.lang.Object
org.opensearch.action.admin.cluster.snapshots.status.SnapshotIndexStatus
All Implemented Interfaces:
java.lang.Iterable<SnapshotIndexShardStatus>, org.opensearch.common.xcontent.ToXContent, org.opensearch.common.xcontent.ToXContentFragment
public class SnapshotIndexStatus
extends java.lang.Object
implements java.lang.Iterable<SnapshotIndexShardStatus>, org.opensearch.common.xcontent.ToXContentFragment
Represents snapshot status of all shards in the index

  • Nested Class Summary

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

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

  • Field Summary

    Fields inherited from interface org.opensearch.common.xcontent.ToXContent

    EMPTY_PARAMS

  • Constructor Summary

    Constructors 
    Constructor Description
    SnapshotIndexStatus​(java.lang.String index, java.util.Map<java.lang.Integer,​SnapshotIndexShardStatus> indexShards, SnapshotShardsStats shardsStats, SnapshotStats stats)  

  • Method Summary

    Modifier and Type Method Description
    boolean equals​(java.lang.Object o)  
    static SnapshotIndexStatus fromXContent​(org.opensearch.common.xcontent.XContentParser parser)  
    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
    int hashCode()  
    java.util.Iterator<SnapshotIndexShardStatus> iterator()  
    org.opensearch.common.xcontent.XContentBuilder toXContent​(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.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.opensearch.common.xcontent.ToXContentFragment

    isFragment

  • Constructor Details

  • Method Details

    • 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 org.opensearch.common.xcontent.XContentBuilder toXContent​(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params) throws java.io.IOException
      Specified by:
      toXContent in interface org.opensearch.common.xcontent.ToXContent
      Throws:
      java.io.IOException

    • fromXContent

      public static SnapshotIndexStatus fromXContent​(org.opensearch.common.xcontent.XContentParser parser) throws java.io.IOException
      Throws:
      java.io.IOException

    • equals

      public boolean equals​(java.lang.Object o)
      Overrides:
      equals in class java.lang.Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class java.lang.Object