Package co.elastic.clients.elasticsearch.indices

Class GetIndicesSettingsRequest.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • allowNoIndices

      public final GetIndicesSettingsRequest.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 final GetIndicesSettingsRequest.Builder expandWildcards​(java.util.List<ExpandWildcard> list)
      Whether to expand wildcard expression to concrete indices that are open, closed or both.

      API name: expand_wildcards

      Adds all elements of list to expandWildcards.

    • expandWildcards

      public final GetIndicesSettingsRequest.Builder expandWildcards​(ExpandWildcard value, ExpandWildcard... values)
      Whether to expand wildcard expression to concrete indices that are open, closed or both.

      API name: expand_wildcards

      Adds one or more values to expandWildcards.

    • flatSettings

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

      API name: flat_settings

    • ignoreUnavailable

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

      API name: ignore_unavailable

    • includeDefaults

      public final GetIndicesSettingsRequest.Builder includeDefaults​(@Nullable java.lang.Boolean value)
      Whether to return all default setting for each of the indices.

      API name: include_defaults

    • index

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

      API name: index

      Adds all elements of list to index.

    • index

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

      API name: index

      Adds one or more values to index.

    • local

      public final GetIndicesSettingsRequest.Builder local​(@Nullable java.lang.Boolean value)
      Return local information, do not retrieve the state from master node (default: false)

      API name: local

    • masterTimeout

      public final GetIndicesSettingsRequest.Builder masterTimeout​(@Nullable Time value)
      Specify timeout for connection to master

      API name: master_timeout

    • masterTimeout

      public final GetIndicesSettingsRequest.Builder masterTimeout​(java.util.function.Function<Time.Builder,​ObjectBuilder<Time>> fn)
      Specify timeout for connection to master

      API name: master_timeout

    • name

      public final GetIndicesSettingsRequest.Builder name​(java.util.List<java.lang.String> list)
      The name of the settings that should be included

      API name: name

      Adds all elements of list to name.

    • name

      public final GetIndicesSettingsRequest.Builder name​(java.lang.String value, java.lang.String... values)
      The name of the settings that should be included

      API name: name

      Adds one or more values to name.

    • build

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