Package co.elastic.clients.elasticsearch.cat.snapshots

Class SnapshotsRecord

java.lang.Object
co.elastic.clients.elasticsearch.cat.snapshots.SnapshotsRecord
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class SnapshotsRecord extends Object implements JsonpSerializable
See Also:

  • Field Details

  • Method Details

    • of

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

    • id

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

      API name: id

    • repository

      @Nullable public final String repository()
      The repository name.

      API name: repository

    • status

      @Nullable public final String status()
      The state of the snapshot process. Returned values include: FAILED: The snapshot process failed. INCOMPATIBLE: The snapshot process is incompatible with the current cluster version. IN_PROGRESS: The snapshot process started but has not completed. PARTIAL: The snapshot process completed with a partial success. SUCCESS: The snapshot process completed with a full success.

      API name: status

    • startEpoch

      @Nullable public final Long startEpoch()
      The Unix epoch time (seconds since 1970-01-01 00:00:00) at which the snapshot process started.

      API name: start_epoch

    • startTime

      @Nullable public final ScheduleTimeOfDay startTime()
      The time (HH:MM:SS) at which the snapshot process started.

      API name: start_time

    • endEpoch

      @Nullable public final Long endEpoch()
      The Unix epoch time (seconds since 1970-01-01 00:00:00) at which the snapshot process ended.

      API name: end_epoch

    • endTime

      @Nullable public final String endTime()
      The time (HH:MM:SS) at which the snapshot process ended.

      API name: end_time

    • duration

      @Nullable public final Time duration()
      The time it took the snapshot process to complete, in time units.

      API name: duration

    • indices

      @Nullable public final String indices()
      The number of indices in the snapshot.

      API name: indices

    • successfulShards

      @Nullable public final String successfulShards()
      The number of successful shards in the snapshot.

      API name: successful_shards

    • failedShards

      @Nullable public final String failedShards()
      The number of failed shards in the snapshot.

      API name: failed_shards

    • totalShards

      @Nullable public final String totalShards()
      The total number of shards in the snapshot.

      API name: total_shards

    • reason

      @Nullable public final String reason()
      The reason for any snapshot failures.

      API name: reason

    • 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)

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • setupSnapshotsRecordDeserializer

      protected static void setupSnapshotsRecordDeserializer(ObjectDeserializer<SnapshotsRecord.Builder> op)