Package co.elastic.clients.elasticsearch.indices

Class GetIndicesSettingsRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.indices.GetIndicesSettingsRequest
public class GetIndicesSettingsRequest
extends RequestBase
Returns settings for one or more indices.
See Also:
API specification

  • Field Details

  • Method Details

    • of

      public static GetIndicesSettingsRequest of​(java.util.function.Function<GetIndicesSettingsRequest.Builder,​ObjectBuilder<GetIndicesSettingsRequest>> fn)

    • allowNoIndices

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

      API name: expand_wildcards

    • flatSettings

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

      API name: flat_settings

    • ignoreUnavailable

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

      API name: ignore_unavailable

    • includeDefaults

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

      API name: include_defaults

    • index

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

      API name: index

    • local

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

      API name: local

    • masterTimeout

      @Nullable public final Time masterTimeout()
      Specify timeout for connection to master

      API name: master_timeout

    • name

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

      API name: name