Package co.elastic.clients.elasticsearch.indices

Class PutSettingsRequest.Builder

java.lang.Object
co.elastic.clients.elasticsearch.indices.PutSettingsRequest.Builder
All Implemented Interfaces:
ObjectBuilder<PutSettingsRequest>
Enclosing class:
PutSettingsRequest
public static class PutSettingsRequest.Builder
extends java.lang.Object
implements ObjectBuilder<PutSettingsRequest>
Builder for PutSettingsRequest.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • index

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

      API name: index

    • index

      public PutSettingsRequest.Builder index​(java.lang.String... value)
      A comma-separated list of index names; use _all or empty string to perform the operation on all indices

      API name: index

    • addIndex

      public PutSettingsRequest.Builder addIndex​(java.lang.String value)
      Add a value to index(List), creating the list if needed.

    • allowNoIndices

      public PutSettingsRequest.Builder allowNoIndices​(@Nullable java.lang.Boolean value)
      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 PutSettingsRequest.Builder expandWildcards​(@Nullable java.util.List<ExpandWildcardOptions> value)
      Whether to expand wildcard expression to concrete indices that are open, closed or both.

      API name: expand_wildcards

    • expandWildcards

      public PutSettingsRequest.Builder expandWildcards​(ExpandWildcardOptions... value)
      Whether to expand wildcard expression to concrete indices that are open, closed or both.

      API name: expand_wildcards

    • addExpandWildcards

      public PutSettingsRequest.Builder addExpandWildcards​(ExpandWildcardOptions value)
      Add a value to expandWildcards(List), creating the list if needed.

    • flatSettings

      public PutSettingsRequest.Builder flatSettings​(@Nullable java.lang.Boolean value)
      Return settings in flat format (default: false)

      API name: flat_settings

    • ignoreUnavailable

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

      API name: ignore_unavailable

    • masterTimeout

      public PutSettingsRequest.Builder masterTimeout​(@Nullable java.lang.String value)
      Specify timeout for connection to master

      API name: master_timeout

    • preserveExisting

      public PutSettingsRequest.Builder preserveExisting​(@Nullable java.lang.Boolean value)
      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

      public PutSettingsRequest.Builder timeout​(@Nullable java.lang.String value)
      Explicit operation timeout

      API name: timeout

    • settings

      public PutSettingsRequest.Builder settings​(IndexSettings value)
      Required - Request body.

      API name: _value_body

    • settings

      public PutSettingsRequest.Builder settings​(java.util.function.Function<IndexSettings.Builder,​ObjectBuilder<IndexSettings>> fn)
      Required - Request body.

      API name: _value_body

    • build

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