Package co.elastic.clients.elasticsearch.cat

Class IndicesRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.cat.CatRequestBase
co.elastic.clients.elasticsearch.cat.IndicesRequest
public class IndicesRequest extends CatRequestBase
Returns high-level information about indices in a cluster, including backing indices for data streams. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get index API. Use the cat indices API to get the following information for each index in a cluster: shard count; document count; deleted document count; primary store size; total store size of all shards, including shard replicas. These metrics are retrieved directly from Lucene, which Elasticsearch uses internally to power indexing and search. As a result, all document counts include hidden nested documents. To get an accurate count of Elasticsearch documents, use the cat count or count APIs.
See Also:

  • Field Details

  • Method Details

    • of

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

    • bytes

      @Nullable public final Bytes bytes()
      The unit used to display byte values.

      API name: bytes

    • expandWildcards

      public final List<ExpandWildcard> expandWildcards()
      The type of index that wildcard patterns can match.

      API name: expand_wildcards

    • health

      @Nullable public final HealthStatus health()
      The health status used to limit returned indices. By default, the response includes indices of any health status.

      API name: health

    • includeUnloadedSegments

      @Nullable public final Boolean includeUnloadedSegments()
      If true, the response includes information from segments that are not loaded into memory.

      API name: include_unloaded_segments

    • 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

    • pri

      @Nullable public final Boolean pri()
      If true, the response only includes information from primary shards.

      API name: pri

    • time

      @Nullable public final TimeUnit time()
      The unit used to display time values.

      API name: time