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
Get index settings. Get setting information for one or more indices. For data streams, it returns setting information for the stream's backing indices.
See Also:

  • Field Details

  • Method Details

    • of

      public static GetIndicesSettingsRequest of(Function<GetIndicesSettingsRequest.Builder,ObjectBuilder<GetIndicesSettingsRequest>> fn)

    • allowNoIndices

      @Nullable public final Boolean allowNoIndices()
      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 List<ExpandWildcard> expandWildcards()
      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

    • flatSettings

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

      API name: flat_settings

    • ignoreUnavailable

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

      API name: ignore_unavailable

    • includeDefaults

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

      API name: include_defaults

    • index

      public final List<String> index()
      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

    • local

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

      API name: local

    • masterTimeout

      @Nullable public final Time masterTimeout()
      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 List<String> name()
      Comma-separated list or wildcard expression of settings to retrieve.

      API name: name