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 java.lang.Object
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 equals​(java.lang.Object o)  
    static SnapshotStatus fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser)  
    java.util.Map<java.lang.String,​SnapshotIndexStatus> getIndices()
    Returns list of snapshot indices
    java.util.List<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()  
    java.lang.Boolean includeGlobalState()
    Returns true if global state is included in the snapshot, false otherwise.
    java.lang.String 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.Object

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

    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 java.lang.Boolean includeGlobalState()
      Returns true if global state is included in the snapshot, false otherwise. Can be null if this information is unknown.

    • getShards

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

    • getShardsStats

      public SnapshotShardsStats getShardsStats()

    • getIndices

      public java.util.Map<java.lang.String,​SnapshotIndexStatus> getIndices()
      Returns list of snapshot indices

    • writeTo

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

    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.lang.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 java.io.IOException
      Specified by:
      toXContent in interface org.elasticsearch.common.xcontent.ToXContent
      Throws:
      java.io.IOException

    • fromXContent

      public static SnapshotStatus fromXContent​(org.elasticsearch.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