Package co.elastic.clients.elasticsearch.cat

Class RecoveryRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.cat.CatRequestBase

co.elastic.clients.elasticsearch.cat.RecoveryRequest

public class RecoveryRequest
extends CatRequestBase

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:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RecoveryRequest.Builder	Builder for RecoveryRequest.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch.cat.CatRequestBase

CatRequestBase.AbstractBuilder<BuilderT extends CatRequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final Endpoint<RecoveryRequest,RecoveryResponse,ErrorResponse>	_ENDPOINT	Endpoint "cat.recovery".

Method Summary

Modifier and Type	Method	Description
final Boolean	activeOnly()	If true, the response only includes ongoing shard recoveries.
final Bytes	bytes()	The unit used to display byte values.
final Boolean	detailed()	If true, the response includes detailed information about shard recoveries.
final List<String>	index()	A comma-separated list of data streams, indices, and aliases used to limit the request.
static RecoveryRequest	of(Function<RecoveryRequest.Builder,ObjectBuilder<RecoveryRequest>> fn)

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

_ENDPOINT

public static final Endpoint<RecoveryRequest,RecoveryResponse,ErrorResponse> _ENDPOINT

Endpoint "cat.recovery".

Method Details

of

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

activeOnly

@Nullable
public final Boolean activeOnly()

If true, the response only includes ongoing shard recoveries.

API name: active_only

bytes

@Nullable
public final Bytes bytes()

The unit used to display byte values.

API name: bytes

detailed

@Nullable
public final Boolean detailed()

If true, the response includes detailed information about shard recoveries.

API name: detailed

index

public final List<String> 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