Package co.elastic.clients.elasticsearch.indices

Class PutIndicesSettingsRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.indices.PutIndicesSettingsRequest
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable
public class PutIndicesSettingsRequest
extends RequestBase
implements JsonpSerializable
Updates the index settings.
See Also:
API specification

  • Field Details

  • Method Details

    • of

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

    • allowNoIndices

      @Nullable public final java.lang.Boolean allowNoIndices()
      Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes _all string or when no indices have been specified)

      API name: allow_no_indices

    • expandWildcards

      public final java.util.List<ExpandWildcard> expandWildcards()
      Whether to expand wildcard expression to concrete indices that are open, closed or both.

      API name: expand_wildcards

    • flatSettings

      @Nullable public final java.lang.Boolean flatSettings()
      Return settings in flat format (default: false)

      API name: flat_settings

    • ignoreUnavailable

      @Nullable public final java.lang.Boolean ignoreUnavailable()
      Whether specified concrete indices should be ignored when unavailable (missing or closed)

      API name: ignore_unavailable

    • index

      public final java.util.List<java.lang.String> index()
      A comma-separated list of index names; use _all or empty string to perform the operation on all indices

      API name: index

    • masterTimeout

      @Nullable public final Time masterTimeout()
      Specify timeout for connection to master

      API name: master_timeout

    • preserveExisting

      @Nullable public final java.lang.Boolean preserveExisting()
      Whether to update existing settings. If set to true existing settings on an index remain unchanged, the default is false

      API name: preserve_existing

    • timeout

      @Nullable public final Time timeout()
      Explicit operation timeout

      API name: timeout

    • settings

      public final IndexSettings settings()
      Required - Request body.

    • serialize

      public void serialize​(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
      Serialize this value to JSON.
      Specified by:
      serialize in interface JsonpSerializable

    • createPutIndicesSettingsRequestDeserializer

      protected static JsonpDeserializer<PutIndicesSettingsRequest> createPutIndicesSettingsRequestDeserializer()