Package co.elastic.clients.elasticsearch.indices

Class GetSettingsRequest.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • index

      public GetSettingsRequest.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 GetSettingsRequest.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 GetSettingsRequest.Builder addIndex​(java.lang.String value)
      Add a value to index(List), creating the list if needed.

    • name

      public GetSettingsRequest.Builder name​(@Nullable java.util.List<java.lang.String> value)
      The name of the settings that should be included

      API name: name

    • name

      public GetSettingsRequest.Builder name​(java.lang.String... value)
      The name of the settings that should be included

      API name: name

    • addName

      public GetSettingsRequest.Builder addName​(java.lang.String value)
      Add a value to name(List), creating the list if needed.

    • allowNoIndices

      public GetSettingsRequest.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 GetSettingsRequest.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 GetSettingsRequest.Builder expandWildcards​(ExpandWildcardOptions... value)
      Whether to expand wildcard expression to concrete indices that are open, closed or both.

      API name: expand_wildcards

    • addExpandWildcards

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

    • flatSettings

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

      API name: flat_settings

    • ignoreUnavailable

      public GetSettingsRequest.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 GetSettingsRequest.Builder includeDefaults​(@Nullable java.lang.Boolean value)
      Whether to return all default setting for each of the indices.

      API name: include_defaults

    • local

      public GetSettingsRequest.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 GetSettingsRequest.Builder masterTimeout​(@Nullable java.lang.String value)
      Specify timeout for connection to master

      API name: master_timeout

    • build

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