Package co.elastic.clients.elasticsearch.indices

Class GetIndexRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.indices.GetIndexRequest
public class GetIndexRequest
extends RequestBase
Returns information about one or more indices. For data streams, the API returns information about the stream’s backing indices.
See Also:
API specification

  • Field Details

  • Method Details

    • of

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

    • allowNoIndices

      @Nullable public final java.lang.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 java.util.List<ExpandWildcard> expandWildcards()
      Type of index that wildcard expressions 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

    • features

      public final java.util.List<Feature> features()
      Return only information on specified index features

      API name: features

    • flatSettings

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

      API name: flat_settings

    • ignoreUnavailable

      @Nullable public final java.lang.Boolean ignoreUnavailable()
      If false, requests that target a missing index return an error.

      API name: ignore_unavailable

    • includeDefaults

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

      API name: include_defaults

    • index

      public final java.util.List<java.lang.String> index()
      Required - Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (*) are supported.

      API name: index

    • local

      @Nullable public final java.lang.Boolean local()
      If true, the request retrieves information from the local node only. Defaults to false, which means 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