Package org.opensearch.snapshots

Class SnapshotInfo

java.lang.Object
org.opensearch.snapshots.SnapshotInfo
All Implemented Interfaces:
Comparable<SnapshotInfo>, org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContent
@PublicApi(since="1.0.0") public final class SnapshotInfo extends Object implements Comparable<SnapshotInfo>, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.common.io.stream.Writeable
Information about a snapshot
Opensearch.api:

  • Field Details

    • DATA_STREAMS_IN_SNAPSHOT

      public static final org.opensearch.Version DATA_STREAMS_IN_SNAPSHOT

    • CONTEXT_MODE_PARAM

      public static final String CONTEXT_MODE_PARAM
      See Also:

    • CONTEXT_MODE_SNAPSHOT

      public static final String CONTEXT_MODE_SNAPSHOT
      See Also:

    • METADATA_FIELD_INTRODUCED

      public static final org.opensearch.Version METADATA_FIELD_INTRODUCED

    • SNAPSHOT_INFO_PARSER

      public static final org.opensearch.core.xcontent.ObjectParser<SnapshotInfo.SnapshotInfoBuilder,Void> SNAPSHOT_INFO_PARSER

  • Constructor Details

  • 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 String reason()
      Returns snapshot failure reason; null if the snapshot succeeded.
      Returns:
      snapshot failure reason

    • indices

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

    • dataStreams

      public List<String> dataStreams()
      Returns:
      list of data streams that were included in this snapshot.

    • 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 Boolean includeGlobalState()

    • isRemoteStoreIndexShallowCopyEnabled

      @Nullable public Boolean isRemoteStoreIndexShallowCopyEnabled()

    • getPinnedTimestamp

      public long getPinnedTimestamp()

    • shardFailures

      public 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 org.opensearch.Version version()
      Returns the version of opensearch that the snapshot was created with. Will only return null if state() returns null or SnapshotState.INCOMPATIBLE.
      Returns:
      version of opensearch that the snapshot was created with

    • userMetadata

      @Nullable public Map<String,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 Comparable<SnapshotInfo>

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • status

      public org.opensearch.core.rest.RestStatus status()
      Returns snapshot REST status

    • 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

    • fromXContentInternal

      public static SnapshotInfo fromXContentInternal(org.opensearch.core.xcontent.XContentParser parser) throws 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:
      IOException

    • writeTo

      public void writeTo(org.opensearch.core.common.io.stream.StreamOutput out) throws IOException
      Specified by:
      writeTo in interface org.opensearch.core.common.io.stream.Writeable
      Throws:
      IOException

    • equals

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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object