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
Update index settings. Changes dynamic index settings in real time. For data streams, index setting changes are applied to all backing indices by default.
See Also:

  • Field Details

  • Method Details

    • of

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

    • allowNoIndices

      @Nullable public final Boolean allowNoIndices()
      If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.

      API name: allow_no_indices

    • expandWildcards

      public final List<ExpandWildcard> expandWildcards()
      Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden.

      API name: expand_wildcards

    • flatSettings

      @Nullable public final Boolean flatSettings()
      If true, returns settings in flat format.

      API name: flat_settings

    • ignoreUnavailable

      @Nullable public final Boolean ignoreUnavailable()
      If true, returns settings in flat format.

      API name: ignore_unavailable

    • index

      public final List<String> index()
      Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all.

      API name: index

    • masterTimeout

      @Nullable public final Time masterTimeout()
      Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      API name: master_timeout

    • preserveExisting

      @Nullable public final Boolean preserveExisting()
      If true, existing index settings remain unchanged.

      API name: preserve_existing

    • timeout

      @Nullable public final Time timeout()
      Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

      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()