Package co.elastic.clients.elasticsearch.snapshot

Class RestoreRequest.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<RestoreRequest.Builder>
co.elastic.clients.elasticsearch.snapshot.RestoreRequest.Builder
All Implemented Interfaces:
WithJson<RestoreRequest.Builder>, ObjectBuilder<RestoreRequest>
Enclosing class:
RestoreRequest
public static class RestoreRequest.Builder extends RequestBase.AbstractBuilder<RestoreRequest.Builder> implements ObjectBuilder<RestoreRequest>
Builder for RestoreRequest.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • featureStates

      public final RestoreRequest.Builder featureStates(List<String> list)
      The feature states to restore. If include_global_state is true, the request restores all feature states in the snapshot by default. If include_global_state is false, the request restores no feature states by default. Note that specifying an empty array will result in the default behavior. To restore no feature states, regardless of the include_global_state value, specify an array containing only the value none (["none"]).

      API name: feature_states

      Adds all elements of list to featureStates.

    • featureStates

      public final RestoreRequest.Builder featureStates(String value, String... values)
      The feature states to restore. If include_global_state is true, the request restores all feature states in the snapshot by default. If include_global_state is false, the request restores no feature states by default. Note that specifying an empty array will result in the default behavior. To restore no feature states, regardless of the include_global_state value, specify an array containing only the value none (["none"]).

      API name: feature_states

      Adds one or more values to featureStates.

    • ignoreIndexSettings

      public final RestoreRequest.Builder ignoreIndexSettings(List<String> list)
      The index settings to not restore from the snapshot. You can't use this option to ignore index.number_of_shards.

      For data streams, this option applies only to restored backing indices. New backing indices are configured using the data stream's matching index template.

      API name: ignore_index_settings

      Adds all elements of list to ignoreIndexSettings.

    • ignoreIndexSettings

      public final RestoreRequest.Builder ignoreIndexSettings(String value, String... values)
      The index settings to not restore from the snapshot. You can't use this option to ignore index.number_of_shards.

      For data streams, this option applies only to restored backing indices. New backing indices are configured using the data stream's matching index template.

      API name: ignore_index_settings

      Adds one or more values to ignoreIndexSettings.

    • ignoreUnavailable

      public final RestoreRequest.Builder ignoreUnavailable(@Nullable Boolean value)
      If true, the request ignores any index or data stream in indices that's missing from the snapshot. If false, the request returns an error for any missing index or data stream.

      API name: ignore_unavailable

    • includeAliases

      public final RestoreRequest.Builder includeAliases(@Nullable Boolean value)
      If true, the request restores aliases for any restored data streams and indices. If false, the request doesn’t restore aliases.

      API name: include_aliases

    • includeGlobalState

      public final RestoreRequest.Builder includeGlobalState(@Nullable Boolean value)
      If true, restore the cluster state. The cluster state includes:
      • Persistent cluster settings
      • Index templates
      • Legacy index templates
      • Ingest pipelines
      • Index lifecycle management (ILM) policies
      • Stored scripts
      • For snapshots taken after 7.12.0, feature states

      If include_global_state is true, the restore operation merges the legacy index templates in your cluster with the templates contained in the snapshot, replacing any existing ones whose name matches one in the snapshot. It completely removes all persistent settings, non-legacy index templates, ingest pipelines, and ILM lifecycle policies that exist in your cluster and replaces them with the corresponding items from the snapshot.

      Use the feature_states parameter to configure how feature states are restored.

      If include_global_state is true and a snapshot was created without a global state then the restore request will fail.

      API name: include_global_state

    • indexSettings

      public final RestoreRequest.Builder indexSettings(@Nullable IndexSettings value)
      Index settings to add or change in restored indices, including backing indices. You can't use this option to change index.number_of_shards.

      For data streams, this option applies only to restored backing indices. New backing indices are configured using the data stream's matching index template.

      API name: index_settings

    • indexSettings

      public final RestoreRequest.Builder indexSettings(Function<IndexSettings.Builder,ObjectBuilder<IndexSettings>> fn)
      Index settings to add or change in restored indices, including backing indices. You can't use this option to change index.number_of_shards.

      For data streams, this option applies only to restored backing indices. New backing indices are configured using the data stream's matching index template.

      API name: index_settings

    • indices

      public final RestoreRequest.Builder indices(List<String> list)
      A comma-separated list of indices and data streams to restore. It supports a multi-target syntax. The default behavior is all regular indices and regular data streams in the snapshot.

      You can't use this parameter to restore system indices or system data streams. Use feature_states instead.

      API name: indices

      Adds all elements of list to indices.

    • indices

      public final RestoreRequest.Builder indices(String value, String... values)
      A comma-separated list of indices and data streams to restore. It supports a multi-target syntax. The default behavior is all regular indices and regular data streams in the snapshot.

      You can't use this parameter to restore system indices or system data streams. Use feature_states instead.

      API name: indices

      Adds one or more values to indices.

    • masterTimeout

      public final RestoreRequest.Builder masterTimeout(@Nullable Time value)
      The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to -1.

      API name: master_timeout

    • masterTimeout

      public final RestoreRequest.Builder masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)
      The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to -1.

      API name: master_timeout

    • partial

      public final RestoreRequest.Builder partial(@Nullable Boolean value)
      If false, the entire restore operation will fail if one or more indices included in the snapshot do not have all primary shards available.

      If true, it allows restoring 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.

      API name: partial

    • renamePattern

      public final RestoreRequest.Builder renamePattern(@Nullable String value)
      A rename pattern to apply to restored data streams and indices. Data streams and indices matching the rename pattern will be renamed according to rename_replacement.

      The rename pattern is applied as defined by the regular expression that supports referencing the original text, according to the appendReplacement logic.

      API name: rename_pattern

    • renameReplacement

      public final RestoreRequest.Builder renameReplacement(@Nullable String value)
      The rename replacement string that is used with the rename_pattern.

      API name: rename_replacement

    • repository

      public final RestoreRequest.Builder repository(String value)
      Required - The name of the repository to restore a snapshot from.

      API name: repository

    • snapshot

      public final RestoreRequest.Builder snapshot(String value)
      Required - The name of the snapshot to restore.

      API name: snapshot

    • waitForCompletion

      public final RestoreRequest.Builder waitForCompletion(@Nullable Boolean value)
      If true, the request returns a response when the restore operation completes. The operation is complete when it finishes all attempts to recover primary shards for restored indices. This applies even if one or more of the recovery attempts fail.

      If false, the request returns a response when the restore operation initializes.

      API name: wait_for_completion

    • self

      protected RestoreRequest.Builder self()
      Specified by:
      self in class RequestBase.AbstractBuilder<RestoreRequest.Builder>

    • build

      public RestoreRequest build()
      Builds a RestoreRequest.
      Specified by:
      build in interface ObjectBuilder<RestoreRequest>
      Throws:
      NullPointerException - if some of the required fields are null.