Class RecoveryRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.cat.CatRequestBase
co.elastic.clients.elasticsearch.cat.RecoveryRequest
Returns information about ongoing and completed shard recoveries. Shard
recovery is the process of initializing a shard copy, such as restoring a
primary shard from a snapshot or syncing a replica shard from a primary
shard. When a shard recovery completes, the recovered shard is available for
search and indexing. For data streams, the API returns information about the
stream’s 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. For application consumption, use the index recovery
API.
- 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<RecoveryRequest,
RecoveryResponse, ErrorResponse> Endpoint "cat.recovery
". -
Method Summary
Modifier and TypeMethodDescriptionfinal Boolean
Iftrue
, the response only includes ongoing shard recoveries.final Bytes
bytes()
The unit used to display byte values.final Boolean
detailed()
Iftrue
, the response includes detailed information about shard recoveries.index()
A comma-separated list of data streams, indices, and aliases used to limit the request.static RecoveryRequest
Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_ENDPOINT
Endpoint "cat.recovery
".
-
-
Method Details
-
of
public static RecoveryRequest of(Function<RecoveryRequest.Builder, ObjectBuilder<RecoveryRequest>> fn) -
activeOnly
Iftrue
, the response only includes ongoing shard recoveries.API name:
active_only
-
bytes
The unit used to display byte values.API name:
bytes
-
detailed
Iftrue
, the response includes detailed information about shard recoveries.API name:
detailed
-
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
-