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

Class SnapshotStatus

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 implements org.elasticsearch.common.xcontent.ToXContentObject, Writeable
Status of a snapshot

  • Nested Class Summary

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

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

    Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

    Writeable.Reader<V>, Writeable.Writer<V>

  • Field Summary

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

    EMPTY_PARAMS

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
     o)
     
    static SnapshotStatus
    fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser)
     
    <,​SnapshotIndexStatus>
    getIndices()
    Returns list of snapshot indices
    <SnapshotIndexShardStatus>
    getShards()
    Returns list of snapshot shards
    SnapshotShardsStats
    getShardsStats()
     
    Snapshot
    getSnapshot()
    Returns snapshot
    SnapshotsInProgress.State
    getState()
    Returns snapshot state
    SnapshotStats
    getStats()
    Returns number of files in the snapshot
    int
    hashCode()
     
    includeGlobalState()
    Returns true if global state is included in the snapshot, false otherwise.
    toString()
     
    org.elasticsearch.common.xcontent.XContentBuilder
    toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
     
    void
    writeTo​(StreamOutput out)
    Write this into the StreamOutput.

    Methods inherited from class java.lang.

    , , , , , , ,

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

    isFragment

  • Method Details

    • getSnapshot

      public Snapshot getSnapshot()
      Returns snapshot

    • getState

      public SnapshotsInProgress.State getState()
      Returns snapshot state

    • includeGlobalState

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

    • getShards

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

    • getShardsStats

      public SnapshotShardsStats getShardsStats()

    • getIndices

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

    • writeTo

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

    • toString

      public  toString()
      Overrides:
       in class 

    • 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
      Specified by:
      toXContent in interface org.elasticsearch.common.xcontent.ToXContent
      Throws:

    • fromXContent

      public static SnapshotStatus fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser) throws
      Throws:

    • equals

      public boolean equals​( o)
      Overrides:
       in class 

    • hashCode

      public int hashCode()
      Overrides:
       in class