Package org.opensearch.client.opensearch.cat.snapshots

Class SnapshotsRecord

java.lang.Object
org.opensearch.client.opensearch.cat.snapshots.SnapshotsRecord
All Implemented Interfaces:
ToJsonp
public final class SnapshotsRecord
extends java.lang.Object
implements ToJsonp

  • Nested Class Summary

    Nested Classes 
    Modifier and Type Class Description
    static class  SnapshotsRecord.Builder
    Builder for SnapshotsRecord.

  • Field Summary

    Fields 
    Modifier and Type Field Description
    static JsonpDeserializer<SnapshotsRecord> DESERIALIZER
    Json deserializer for SnapshotsRecord

  • Constructor Summary

    Constructors 
    Modifier Constructor Description
    protected SnapshotsRecord​(SnapshotsRecord.Builder builder)  

  • Method Summary

    Modifier and Type Method Description
    jakarta.json.JsonValue duration()
    duration API name: duration
    jakarta.json.JsonValue endEpoch()
    end time in seconds since 1970-01-01 00:00:00 API name: end_epoch
    java.lang.String endTime()
    end time in HH:MM:SS API name: end_time
    java.lang.String failedShards()
    number of failed shards API name: failed_shards
    java.lang.String id()
    unique snapshot API name: id
    java.lang.String indices()
    number of indices API name: indices
    java.lang.String reason()
    reason for failures API name: reason
    java.lang.String repository()
    repository name API name: repository
    protected static void setupSnapshotsRecordDeserializer​(DelegatingDeserializer<SnapshotsRecord.Builder> op)  
    jakarta.json.JsonValue startEpoch()
    start time in seconds since 1970-01-01 00:00:00 API name: start_epoch
    java.lang.String startTime()
    start time in HH:MM:SS API name: start_time
    java.lang.String status()
    snapshot name API name: status
    java.lang.String successfulShards()
    number of successful shards API name: successful_shards
    void toJsonp​(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
    Serialize this object to JSON.
    protected void toJsonpInternal​(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)  
    java.lang.String totalShards()
    number of total shards API name: total_shards

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

  • Constructor Details

  • Method Details

    • id

      @Nullable public java.lang.String id()
      unique snapshot API name: id

    • repository

      @Nullable public java.lang.String repository()
      repository name API name: repository

    • status

      @Nullable public java.lang.String status()
      snapshot name API name: status

    • startEpoch

      @Nullable public jakarta.json.JsonValue startEpoch()
      start time in seconds since 1970-01-01 00:00:00 API name: start_epoch

    • startTime

      @Nullable public java.lang.String startTime()
      start time in HH:MM:SS API name: start_time

    • endEpoch

      @Nullable public jakarta.json.JsonValue endEpoch()
      end time in seconds since 1970-01-01 00:00:00 API name: end_epoch

    • endTime

      @Nullable public java.lang.String endTime()
      end time in HH:MM:SS API name: end_time

    • duration

      @Nullable public jakarta.json.JsonValue duration()
      duration API name: duration

    • indices

      @Nullable public java.lang.String indices()
      number of indices API name: indices

    • successfulShards

      @Nullable public java.lang.String successfulShards()
      number of successful shards API name: successful_shards

    • failedShards

      @Nullable public java.lang.String failedShards()
      number of failed shards API name: failed_shards

    • totalShards

      @Nullable public java.lang.String totalShards()
      number of total shards API name: total_shards

    • reason

      @Nullable public java.lang.String reason()
      reason for failures API name: reason

    • toJsonp

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

    • toJsonpInternal

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

    • setupSnapshotsRecordDeserializer

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