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

Class SnapshotShardsStats

java.lang.Object
org.opensearch.action.admin.cluster.snapshots.status.SnapshotShardsStats
All Implemented Interfaces:
org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentObject
@PublicApi(since="1.0.0") public class SnapshotShardsStats extends Object implements org.opensearch.core.xcontent.ToXContentObject
Status of a snapshot shards
Opensearch.api:

  • Nested Class Summary

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

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

  • Field Summary

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

    EMPTY_PARAMS

  • Constructor Summary

    Constructors
    Constructor
    Description
    SnapshotShardsStats(int initializingShards, int startedShards, int finalizingShards, int doneShards, int failedShards, int totalShards)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object o)
     
    static SnapshotShardsStats
    fromXContent(org.opensearch.core.xcontent.XContentParser parser)
     
    int
    getDoneShards()
    Number of shards with completed snapshot
    int
    getFailedShards()
    Number of shards with failed snapshot
    int
    getFinalizingShards()
    Number of shards with the snapshot in the finalizing stage
    int
    getInitializingShards()
    Number of shards with the snapshot in the initializing stage
    int
    getStartedShards()
    Number of shards with the snapshot in the started stage
    int
    getTotalShards()
    Total number of shards
    int
    hashCode()
     
    org.opensearch.core.xcontent.XContentBuilder
    toXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
     

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.opensearch.core.xcontent.ToXContentObject

    isFragment

  • Constructor Details

    • SnapshotShardsStats

      public SnapshotShardsStats(int initializingShards, int startedShards, int finalizingShards, int doneShards, int failedShards, int totalShards)

  • Method Details

    • getInitializingShards

      public int getInitializingShards()
      Number of shards with the snapshot in the initializing stage

    • getStartedShards

      public int getStartedShards()
      Number of shards with the snapshot in the started stage

    • getFinalizingShards

      public int getFinalizingShards()
      Number of shards with the snapshot in the finalizing stage

    • getDoneShards

      public int getDoneShards()
      Number of shards with completed snapshot

    • getFailedShards

      public int getFailedShards()
      Number of shards with failed snapshot

    • getTotalShards

      public int getTotalShards()
      Total number of shards

    • toXContent

      public org.opensearch.core.xcontent.XContentBuilder toXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params) throws IOException
      Specified by:
      toXContent in interface org.opensearch.core.xcontent.ToXContent
      Throws:
      IOException

    • fromXContent

      public static SnapshotShardsStats fromXContent(org.opensearch.core.xcontent.XContentParser parser)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object