Package co.elastic.clients.elasticsearch.snapshot

Class RestoreRequest.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<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 WithJsonObjectBuilderBase<RestoreRequest.Builder>
implements ObjectBuilder<RestoreRequest>
Builder for RestoreRequest.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • ignoreIndexSettings

      public final RestoreRequest.Builder ignoreIndexSettings​(java.util.List<java.lang.String> list)
      API name: ignore_index_settings

      Adds all elements of list to ignoreIndexSettings.

    • ignoreIndexSettings

      public final RestoreRequest.Builder ignoreIndexSettings​(java.lang.String value, java.lang.String... values)
      API name: ignore_index_settings

      Adds one or more values to ignoreIndexSettings.

    • ignoreUnavailable

      public final RestoreRequest.Builder ignoreUnavailable​(@Nullable java.lang.Boolean value)
      API name: ignore_unavailable

    • includeAliases

      public final RestoreRequest.Builder includeAliases​(@Nullable java.lang.Boolean value)
      API name: include_aliases

    • includeGlobalState

      public final RestoreRequest.Builder includeGlobalState​(@Nullable java.lang.Boolean value)
      API name: include_global_state

    • indexSettings

      public final RestoreRequest.Builder indexSettings​(@Nullable IndexSettings value)
      API name: index_settings

    • indexSettings

      public final RestoreRequest.Builder indexSettings​(java.util.function.Function<IndexSettings.Builder,​ObjectBuilder<IndexSettings>> fn)
      API name: index_settings

    • indices

      public final RestoreRequest.Builder indices​(java.util.List<java.lang.String> list)
      API name: indices

      Adds all elements of list to indices.

    • indices

      public final RestoreRequest.Builder indices​(java.lang.String value, java.lang.String... values)
      API name: indices

      Adds one or more values to indices.

    • masterTimeout

      public final RestoreRequest.Builder masterTimeout​(@Nullable Time value)
      Explicit operation timeout for connection to master node

      API name: master_timeout

    • masterTimeout

      public final RestoreRequest.Builder masterTimeout​(java.util.function.Function<Time.Builder,​ObjectBuilder<Time>> fn)
      Explicit operation timeout for connection to master node

      API name: master_timeout

    • partial

      public final RestoreRequest.Builder partial​(@Nullable java.lang.Boolean value)
      API name: partial

    • renamePattern

      public final RestoreRequest.Builder renamePattern​(@Nullable java.lang.String value)
      API name: rename_pattern

    • renameReplacement

      public final RestoreRequest.Builder renameReplacement​(@Nullable java.lang.String value)
      API name: rename_replacement

    • repository

      public final RestoreRequest.Builder repository​(java.lang.String value)
      Required - A repository name

      API name: repository

    • snapshot

      public final RestoreRequest.Builder snapshot​(java.lang.String value)
      Required - A snapshot name

      API name: snapshot

    • waitForCompletion

      public final RestoreRequest.Builder waitForCompletion​(@Nullable java.lang.Boolean value)
      Should this request wait until the operation has completed before returning

      API name: wait_for_completion

    • self

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

    • build

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