Package co.elastic.clients.elasticsearch.searchable_snapshots

Class MountRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.searchable_snapshots.MountRequest
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class MountRequest extends RequestBase implements JsonpSerializable
Mount a snapshot. Mount a snapshot as a searchable snapshot index. Do not use this API for snapshots managed by index lifecycle management (ILM). Manually mounting ILM-managed snapshots can interfere with ILM processes.
See Also:

  • Field Details

  • Method Details

    • of

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

    • ignoreIndexSettings

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

      API name: ignore_index_settings

    • index

      public final String index()
      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 Map<String,JsonData> indexSettings()
      The settings that should be added to the index when it is mounted.

      API name: index_settings

    • masterTimeout

      @Nullable public final Time masterTimeout()
      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

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

      API name: renamed_index

    • repository

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

      API name: repository

    • snapshot

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

      API name: snapshot

    • storage

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

      API name: storage

    • waitForCompletion

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

      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)

    • setupMountRequestDeserializer

      protected static void setupMountRequestDeserializer(ObjectDeserializer<MountRequest.Builder> op)