Package co.elastic.clients.elasticsearch.searchable_snapshots

Class MountRequest.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • ignoreIndexSettings

      public final MountRequest.Builder ignoreIndexSettings(List<String> list)
      The names of settings that should be removed from the index when it is mounted.

      API name: ignore_index_settings

      Adds all elements of list to ignoreIndexSettings.

    • ignoreIndexSettings

      public final MountRequest.Builder ignoreIndexSettings(String value, String... values)
      The names of settings that should be removed from the index when it is mounted.

      API name: ignore_index_settings

      Adds one or more values to ignoreIndexSettings.

    • index

      public final MountRequest.Builder index(String value)
      Required - The name of the index contained in the snapshot whose data is to be mounted. If no renamed_index is specified, this name will also be used to create the new index.

      API name: index

    • indexSettings

      public final MountRequest.Builder indexSettings(Map<String,JsonData> map)
      The settings that should be added to the index when it is mounted.

      API name: index_settings

      Adds all entries of map to indexSettings.

    • indexSettings

      public final MountRequest.Builder indexSettings(String key, JsonData value)
      The settings that should be added to the index when it is mounted.

      API name: index_settings

      Adds an entry to indexSettings.

    • masterTimeout

      public final MountRequest.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 MountRequest.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

    • renamedIndex

      public final MountRequest.Builder renamedIndex(@Nullable String value)
      The name of the index that will be created.

      API name: renamed_index

    • repository

      public final MountRequest.Builder repository(String value)
      Required - The name of the repository containing the snapshot of the index to mount.

      API name: repository

    • snapshot

      public final MountRequest.Builder snapshot(String value)
      Required - The name of the snapshot of the index to mount.

      API name: snapshot

    • storage

      public final MountRequest.Builder storage(@Nullable String value)
      The mount option for the searchable snapshot index.

      API name: storage

    • waitForCompletion

      public final MountRequest.Builder waitForCompletion(@Nullable Boolean value)
      If true, the request blocks until the operation is complete.

      API name: wait_for_completion

    • self

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

    • build

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