Package co.elastic.clients.elasticsearch.indices

Class RecoveryRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.indices.RecoveryRequest

public class RecoveryRequest
extends RequestBase

Returns information about ongoing index shard recoveries.

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._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
final Boolean	activeOnly()	Display only those recoveries that are currently on-going
final Boolean	detailed()	Whether to display detailed information about shard recovery
final List<String>	index()	A comma-separated list of index names; use _all or empty string to perform the operation on all indices
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 "indices.recovery".

Method Details

of

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

activeOnly

@Nullable
public final Boolean activeOnly()

Display only those recoveries that are currently on-going

API name: active_only

detailed

@Nullable
public final Boolean detailed()

Whether to display detailed information about shard recovery

API name: detailed

index

public final List<String> index()

A comma-separated list of index names; use _all or empty string to perform the operation on all indices

API name: index