Package co.elastic.clients.elasticsearch.snapshot

Class Status

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

  • Field Details

  • Method Details

    • of

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

    • includeGlobalState

      public final boolean includeGlobalState()
      Required - Indicates whether the current cluster state is included in the snapshot.

      API name: include_global_state

    • indices

      public final Map<String,SnapshotIndexStats> indices()
      Required - API name: indices

    • repository

      public final String repository()
      Required - The name of the repository that includes the snapshot.

      API name: repository

    • shardsStats

      public final ShardsStats shardsStats()
      Required - Statistics for the shards in the snapshot.

      API name: shards_stats

    • snapshot

      public final String snapshot()
      Required - The name of the snapshot.

      API name: snapshot

    • state

      public final String state()
      Required - The current snapshot state:
      • FAILED: The snapshot finished with an error and failed to store any data.
      • STARTED: The snapshot is currently running.
      • SUCCESS: The snapshot completed.

      API name: state

    • stats

      public final SnapshotStats stats()
      Required - Details about the number (file_count) and size (size_in_bytes) of files included in the snapshot.

      API name: stats

    • uuid

      public final String uuid()
      Required - The universally unique identifier (UUID) for the snapshot.

      API name: uuid

    • 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

    • setupStatusDeserializer

      protected static void setupStatusDeserializer(ObjectDeserializer<Status.Builder> op)