Package org.opensearch.client.opensearch.snapshot

Class SnapshotInfo

java.lang.Object
org.opensearch.client.opensearch.snapshot.SnapshotInfo
All Implemented Interfaces:
JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<SnapshotInfo.Builder,SnapshotInfo>
@JsonpDeserializable @Generated("org.opensearch.client.codegen.CodeGenerator") public class SnapshotInfo extends Object implements PlainJsonSerializable, ToCopyableBuilder<SnapshotInfo.Builder,SnapshotInfo>

  • Field Details

  • Method Details

    • of

      public static SnapshotInfo of(Function<SnapshotInfo.Builder,ObjectBuilder<SnapshotInfo>> fn)

    • dataStreams

      @Nonnull public final List<String> dataStreams()
      The list of data streams included in the snapshot.

      API name: data_streams

    • duration

      @Nullable public final Time duration()
      The total time taken to complete the snapshot.

      API name: duration

    • durationInMillis

      @Nullable public final Long durationInMillis()
      The total time taken to complete the snapshot in milliseconds.

      API name: duration_in_millis

    • endTime

      @Nullable public final String endTime()
      The time when the snapshot completed.

      API name: end_time

    • endTimeInMillis

      @Nullable public final Long endTimeInMillis()
      The time when the snapshot completed in milliseconds.

      API name: end_time_in_millis

    • failures

      @Nonnull public final List<SnapshotShardFailure> failures()
      The list of shard failures that occurred during the snapshot.

      API name: failures

    • includeGlobalState

      @Nullable public final Boolean includeGlobalState()
      Whether the snapshot includes the cluster state.

      API name: include_global_state

    • indices

      @Nonnull public final List<String> indices()
      The list of indexes included in the snapshot.

      API name: indices

    • metadata

      @Nonnull public final Map<String,JsonData> metadata()
      The custom metadata attached to the snapshot.

      API name: metadata

    • pinnedTimestamp

      @Nullable public final Long pinnedTimestamp()
      The timestamp when the snapshot was pinned.

      API name: pinned_timestamp

    • reason

      @Nullable public final String reason()
      The reason for the snapshot creation.

      API name: reason

    • remoteStoreIndexShallowCopy

      @Nullable public final Boolean remoteStoreIndexShallowCopy()
      Whether the snapshot uses remote store index shallow copy.

      API name: remote_store_index_shallow_copy

    • shards

      @Nullable public final ShardStatistics shards()
      The statistics about the shards included in the snapshot.

      API name: shards

    • snapshot

      @Nullable public final String snapshot()
      The name of the snapshot.

      API name: snapshot

    • startTime

      @Nullable public final String startTime()
      The time when the snapshot started.

      API name: start_time

    • startTimeInMillis

      @Nullable public final Long startTimeInMillis()
      The time when the snapshot started in milliseconds.

      API name: start_time_in_millis

    • state

      @Nullable public final String state()
      The current state of the snapshot.

      API name: state

    • uuid

      @Nullable public final String uuid()
      The unique identifier for the snapshot.

      API name: uuid

    • version

      @Nullable public final String version()
      The version of OpenSearch when the snapshot was created.

      API name: version

    • versionId

      @Nullable public final Long versionId()
      The internal version number of OpenSearch when the snapshot was created.

      API name: version_id

    • serialize

      public void serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
      Serialize this object to JSON.
      Specified by:
      serialize in interface JsonpSerializable

    • serializeInternal

      protected void serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

    • toBuilder

      @Nonnull public SnapshotInfo.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<SnapshotInfo.Builder,SnapshotInfo>
      Returns:
      a new builder instance.

    • builder

      @Nonnull public static SnapshotInfo.Builder builder()

    • setupSnapshotInfoDeserializer

      protected static void setupSnapshotInfoDeserializer(ObjectDeserializer<SnapshotInfo.Builder> op)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

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