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
Get index information.

Get information about one or more indices. For data streams, the API returns information about the stream’s backing indices.

See Also:

  • Field Details

  • Method Details

    • of

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

    • allowNoIndices

      @Nullable public final Boolean allowNoIndices()
      A setting that does two separate checks on the index expression. If false, the request returns an error (1) if any wildcard expression (including _all and *) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If true, index expressions that resolve to no indices are allowed and the request returns an empty result.

      API name: allow_no_indices

    • expandWildcards

      public final 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 List<Feature> features()
      Return only information on specified index features

      API name: features

    • 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 concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If true, unavailable concrete targets are silently ignored.

      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()
      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 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

    • rebuild

      public GetIndexRequest.Builder rebuild()
      Returns:
      New GetIndexRequest.Builder initialized with field values of this instance