Package co.elastic.clients.elasticsearch.indices

Class GetIndicesSettingsRequest.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<GetIndicesSettingsRequest.Builder>
co.elastic.clients.elasticsearch.indices.GetIndicesSettingsRequest.Builder
All Implemented Interfaces:
WithJson<GetIndicesSettingsRequest.Builder>, ObjectBuilder<GetIndicesSettingsRequest>
Enclosing class:
GetIndicesSettingsRequest
public static class GetIndicesSettingsRequest.Builder extends RequestBase.AbstractBuilder<GetIndicesSettingsRequest.Builder> implements ObjectBuilder<GetIndicesSettingsRequest>
Builder for GetIndicesSettingsRequest.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • allowNoIndices

      public final GetIndicesSettingsRequest.Builder allowNoIndices(@Nullable Boolean value)
      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 GetIndicesSettingsRequest.Builder expandWildcards(List<ExpandWildcard> list)
      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

      Adds all elements of list to expandWildcards.

    • expandWildcards

      public final GetIndicesSettingsRequest.Builder expandWildcards(ExpandWildcard value, ExpandWildcard... values)
      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

      Adds one or more values to expandWildcards.

    • flatSettings

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

      API name: flat_settings

    • ignoreUnavailable

      public final GetIndicesSettingsRequest.Builder ignoreUnavailable(@Nullable Boolean value)
      If false, the request returns an error if it targets a missing or closed index.

      API name: ignore_unavailable

    • includeDefaults

      public final GetIndicesSettingsRequest.Builder includeDefaults(@Nullable Boolean value)
      If true, return all default settings in the response.

      API name: include_defaults

    • index

      public final GetIndicesSettingsRequest.Builder index(List<String> list)
      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

      Adds all elements of list to index.

    • index

      public final GetIndicesSettingsRequest.Builder index(String value, String... values)
      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

      Adds one or more values to index.

    • local

      public final GetIndicesSettingsRequest.Builder local(@Nullable Boolean value)
      If true, the request retrieves information from the local node only. If false, information is retrieved from the master node.

      API name: local

    • masterTimeout

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

    • masterTimeout

      public final GetIndicesSettingsRequest.Builder masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)
      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

    • name

      public final GetIndicesSettingsRequest.Builder name(List<String> list)
      Comma-separated list or wildcard expression of settings to retrieve.

      API name: name

      Adds all elements of list to name.

    • name

      public final GetIndicesSettingsRequest.Builder name(String value, String... values)
      Comma-separated list or wildcard expression of settings to retrieve.

      API name: name

      Adds one or more values to name.

    • self

      protected GetIndicesSettingsRequest.Builder self()
      Specified by:
      self in class RequestBase.AbstractBuilder<GetIndicesSettingsRequest.Builder>

    • build

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