Class ShardsRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.cat.CatRequestBase
co.elastic.clients.elasticsearch.cat.ShardsRequest
Returns information about the shards in a cluster. For data streams, the API
returns information about the backing indices. IMPORTANT: cat APIs are only
intended for human consumption using the command line or Kibana console. They
are not intended for use by applications.
- 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<ShardsRequest,
ShardsResponse, ErrorResponse> Endpoint "cat.shards
". -
Method Summary
Modifier and TypeMethodDescriptionfinal Bytes
bytes()
The unit used to display byte values.index()
A comma-separated list of data streams, indices, and aliases used to limit the request.static ShardsRequest
Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_ENDPOINT
Endpoint "cat.shards
".
-
-
Method Details
-
of
-
bytes
The unit used to display byte values.API name:
bytes
-
index
A 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
-