Package org.elasticsearch.snapshots

Class SnapshotInfo

java.lang.Object
org.elasticsearch.snapshots.SnapshotInfo
All Implemented Interfaces:
java.lang.Comparable<SnapshotInfo>, Writeable, ToXContent
public final class SnapshotInfo
extends java.lang.Object
implements java.lang.Comparable<SnapshotInfo>, ToXContent, Writeable
Information about a snapshot

  • Field Details

  • Constructor Details

    • SnapshotInfo

      public SnapshotInfo​(SnapshotId snapshotId, java.util.List<java.lang.String> indices, SnapshotState state)

    • SnapshotInfo

      public SnapshotInfo​(SnapshotId snapshotId, java.util.List<java.lang.String> indices, SnapshotState state, Version version)

    • SnapshotInfo

      public SnapshotInfo​(SnapshotId snapshotId, java.util.List<java.lang.String> indices, long startTime, java.lang.Boolean includeGlobalState, java.util.Map<java.lang.String,​java.lang.Object> userMetadata)

    • SnapshotInfo

      public SnapshotInfo​(SnapshotId snapshotId, java.util.List<java.lang.String> indices, long startTime, java.lang.String reason, long endTime, int totalShards, java.util.List<SnapshotShardFailure> shardFailures, java.lang.Boolean includeGlobalState, java.util.Map<java.lang.String,​java.lang.Object> userMetadata)

    • SnapshotInfo

      public SnapshotInfo​(StreamInput in) throws java.io.IOException
      Constructs snapshot information from stream input
      Throws:
      java.io.IOException

  • Method Details

    • basic

      public SnapshotInfo basic()
      Gets a new SnapshotInfo instance from the given SnapshotInfo with all information stripped out except the snapshot id, state, and indices.

    • snapshotId

      public SnapshotId snapshotId()
      Returns snapshot id
      Returns:
      snapshot id

    • state

      @Nullable public SnapshotState state()
      Returns snapshot state; null if the state is unknown.
      Returns:
      snapshot state

    • reason

      @Nullable public java.lang.String reason()
      Returns snapshot failure reason; null if the snapshot succeeded.
      Returns:
      snapshot failure reason

    • indices

      public java.util.List<java.lang.String> indices()
      Returns indices that were included in this snapshot.
      Returns:
      list of indices

    • startTime

      public long startTime()
      Returns time when snapshot started; a value of 0L will be returned if state() returns null.
      Returns:
      snapshot start time

    • endTime

      public long endTime()
      Returns time when snapshot ended; a value of 0L will be returned if the snapshot is still running or if state() returns null.
      Returns:
      snapshot end time

    • totalShards

      public int totalShards()
      Returns total number of shards that were snapshotted; a value of 0 will be returned if state() returns null.
      Returns:
      number of shards

    • failedShards

      public int failedShards()
      Number of failed shards; a value of 0 will be returned if there were no failed shards, or if state() returns null.
      Returns:
      number of failed shards

    • successfulShards

      public int successfulShards()
      Returns total number of shards that were successfully snapshotted; a value of 0 will be returned if state() returns null.
      Returns:
      number of successful shards

    • includeGlobalState

      public java.lang.Boolean includeGlobalState()

    • shardFailures

      public java.util.List<SnapshotShardFailure> shardFailures()
      Returns shard failures; an empty list will be returned if there were no shard failures, or if state() returns null.
      Returns:
      shard failures

    • version

      @Nullable public Version version()
      Returns the version of elasticsearch that the snapshot was created with. Will only return null if state() returns null or SnapshotState.INCOMPATIBLE.
      Returns:
      version of elasticsearch that the snapshot was created with

    • userMetadata

      @Nullable public java.util.Map<java.lang.String,​java.lang.Object> userMetadata()
      Returns the custom metadata that was attached to this snapshot at creation time.
      Returns:
      custom metadata

    • compareTo

      public int compareTo​(SnapshotInfo o)
      Compares two snapshots by their start time; if the start times are the same, then compares the two snapshots by their snapshot ids.
      Specified by:
      compareTo in interface java.lang.Comparable<SnapshotInfo>

    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.lang.Object

    • status

      public RestStatus status()
      Returns snapshot REST status

    • toXContent

      public XContentBuilder toXContent​(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException
      Specified by:
      toXContent in interface ToXContent
      Throws:
      java.io.IOException

    • fromXContentInternal

      public static SnapshotInfo fromXContentInternal​(XContentParser parser) throws java.io.IOException
      This method creates a SnapshotInfo from internal x-content. It does not handle x-content written with the external version as external x-content is only for display purposes and does not need to be parsed.
      Throws:
      java.io.IOException

    • 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

    • 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