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

Class SnapshotStatus

java.lang.Object
org.elasticsearch.action.admin.cluster.snapshots.status.SnapshotStatus
All Implemented Interfaces:
Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject
public class SnapshotStatus extends Object implements org.elasticsearch.common.xcontent.ToXContentObject, Writeable
Status of a snapshot

  • Method Details

    • getSnapshot

      public Snapshot getSnapshot()
      Returns snapshot

    • getState

      public SnapshotsInProgress.State getState()
      Returns snapshot state

    • includeGlobalState

      public Boolean includeGlobalState()
      Returns true if global state is included in the snapshot, false otherwise. Can be null if this information is unknown.

    • getShards

      public List<SnapshotIndexShardStatus> getShards()
      Returns list of snapshot shards

    • getShardsStats

      public SnapshotShardsStats getShardsStats()

    • getIndices

      public Map<String,SnapshotIndexStatus> getIndices()
      Returns list of snapshot indices

    • writeTo

      public void writeTo(StreamOutput out) throws IOException
      Description copied from interface: Writeable
      Write this into the StreamOutput.
      Specified by:
      writeTo in interface Writeable
      Throws:
      IOException

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • getStats

      public SnapshotStats getStats()
      Returns number of files in the snapshot

    • 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 SnapshotStatus 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