Package co.elastic.clients.elasticsearch.snapshot

Class RestoreRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.snapshot.RestoreRequest
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable
public class RestoreRequest
extends RequestBase
implements JsonpSerializable
Restores a snapshot.
See Also:
API specification

  • Field Details

  • Method Details

    • of

      public static RestoreRequest of​(java.util.function.Function<RestoreRequest.Builder,​ObjectBuilder<RestoreRequest>> fn)

    • ignoreIndexSettings

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

    • ignoreUnavailable

      @Nullable public final java.lang.Boolean ignoreUnavailable()
      API name: ignore_unavailable

    • includeAliases

      @Nullable public final java.lang.Boolean includeAliases()
      API name: include_aliases

    • includeGlobalState

      @Nullable public final java.lang.Boolean includeGlobalState()
      API name: include_global_state

    • indexSettings

      @Nullable public final PutIndicesSettingsRequest indexSettings()
      API name: index_settings

    • indices

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

    • masterTimeout

      @Nullable public final Time masterTimeout()
      Explicit operation timeout for connection to master node

      API name: master_timeout

    • partial

      @Nullable public final java.lang.Boolean partial()
      API name: partial

    • renamePattern

      @Nullable public final java.lang.String renamePattern()
      API name: rename_pattern

    • renameReplacement

      @Nullable public final java.lang.String renameReplacement()
      API name: rename_replacement

    • repository

      public final java.lang.String repository()
      Required - A repository name

      API name: repository

    • snapshot

      public final java.lang.String snapshot()
      Required - A snapshot name

      API name: snapshot

    • waitForCompletion

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

      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)

    • setupRestoreRequestDeserializer

      protected static void setupRestoreRequestDeserializer​(ObjectDeserializer<RestoreRequest.Builder> op)