Package co.elastic.clients.elasticsearch.snapshot

Class CreateSnapshotRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.snapshot.CreateSnapshotRequest
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class CreateSnapshotRequest extends RequestBase implements JsonpSerializable
Create a snapshot. Take a snapshot of a cluster or of data streams and indices.
See Also:

  • Field Details

  • Method Details

    • of

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

    • expandWildcards

      public final List<ExpandWildcard> expandWildcards()
      Determines how wildcard patterns in the indices parameter match data streams and indices. It supports comma-separated values such as open,hidden.

      API name: expand_wildcards

    • featureStates

      public final List<String> featureStates()
      The feature states to include in the snapshot. Each feature state includes one or more system indices containing related data. You can view a list of eligible features using the get features API.

      If include_global_state is true, all current feature states are included by default. If include_global_state is false, no feature states are included by default.

      Note that specifying an empty array will result in the default behavior. To exclude all feature states, regardless of the include_global_state value, specify an array with only the value none (["none"]).

      API name: feature_states

    • ignoreUnavailable

      @Nullable public final Boolean ignoreUnavailable()
      If true, the request ignores data streams and indices in indices that are missing or closed. If false, the request returns an error for any data stream or index that is missing or closed.

      API name: ignore_unavailable

    • includeGlobalState

      @Nullable public final Boolean includeGlobalState()
      If true, the current cluster state is included in the snapshot. The cluster state includes persistent cluster settings, composable index templates, legacy index templates, ingest pipelines, and ILM policies. It also includes data stored in system indices, such as Watches and task records (configurable via feature_states).

      API name: include_global_state

    • indices

      public final List<String> indices()
      A comma-separated list of data streams and indices to include in the snapshot. It supports a multi-target syntax. The default is an empty array ([]), which includes all regular data streams and regular indices. To exclude all data streams and indices, use -*.

      You can't use this parameter to include or exclude system indices or system data streams from a snapshot. Use feature_states instead.

      API name: indices

    • masterTimeout

      @Nullable public final Time masterTimeout()
      The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      API name: master_timeout

    • metadata

      public final Map<String,JsonData> metadata()
      Arbitrary metadata to the snapshot, such as a record of who took the snapshot, why it was taken, or any other useful data. It can have any contents but it must be less than 1024 bytes. This information is not automatically generated by Elasticsearch.

      API name: metadata

    • partial

      @Nullable public final Boolean partial()
      If true, it enables you to restore a partial snapshot of indices with unavailable shards. Only shards that were successfully included in the snapshot will be restored. All missing shards will be recreated as empty.

      If false, the entire restore operation will fail if one or more indices included in the snapshot do not have all primary shards available.

      API name: partial

    • repository

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

      API name: repository

    • snapshot

      public final String snapshot()
      Required - The name of the snapshot. It supportes date math. It must be unique in the repository.

      API name: snapshot

    • waitForCompletion

      @Nullable public final Boolean waitForCompletion()
      If true, the request returns a response when the snapshot is complete. If false, the request returns a response when the snapshot initializes.

      API name: wait_for_completion

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

    • setupCreateSnapshotRequestDeserializer

      protected static void setupCreateSnapshotRequestDeserializer(ObjectDeserializer<CreateSnapshotRequest.Builder> op)