Class IndicesRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.cat.CatRequestBase
co.elastic.clients.elasticsearch.cat.IndicesRequest
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:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch.cat.CatRequestBase
CatRequestBase.AbstractBuilder<BuilderT extends CatRequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final Endpoint<IndicesRequest,
IndicesResponse, ErrorResponse> Endpoint "cat.indices
". -
Method Summary
Modifier and TypeMethodDescriptionfinal Bytes
bytes()
The unit used to display byte values.final List<ExpandWildcard>
The type of index that wildcard patterns can match.final HealthStatus
health()
The health status used to limit returned indices.final Boolean
If true, the response includes information from segments that are not loaded into memory.index()
Comma-separated list of data streams, indices, and aliases used to limit the request.static IndicesRequest
final Boolean
pri()
If true, the response only includes information from primary shards.final TimeUnit
time()
The unit used to display time values.Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_ENDPOINT
Endpoint "cat.indices
".
-
-
Method Details
-
of
-
bytes
The unit used to display byte values.API name:
bytes
-
expandWildcards
The type of index that wildcard patterns can match.API name:
expand_wildcards
-
health
The health status used to limit returned indices. By default, the response includes indices of any health status.API name:
health
-
includeUnloadedSegments
If true, the response includes information from segments that are not loaded into memory.API name:
include_unloaded_segments
-
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
If true, the response only includes information from primary shards.API name:
pri
-
time
The unit used to display time values.API name:
time
-