Package org.opensearch.client.opensearch.indices

Class RecoveryRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.indices.RecoveryRequest

public class RecoveryRequest
extends RequestBase

Returns information about ongoing index shard recoveries.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
java.lang.Boolean	activeOnly()	Display only those recoveries that are currently on-going
java.lang.Boolean	detailed()	Whether to display detailed information about shard recovery
java.util.List<java.lang.String>	index()	A comma-separated list of index names; use _all or empty string to perform the operation on all indices
static RecoveryRequest	of(java.util.function.Function<RecoveryRequest.Builder,ObjectBuilder<RecoveryRequest>> fn)

Methods inherited from class java.lang.Object

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

Field Detail

_ENDPOINT

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

Endpoint "indices.recovery".

Method Detail

of

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

activeOnly

@Nullable
public final java.lang.Boolean activeOnly()

Display only those recoveries that are currently on-going

API name: active_only

detailed

@Nullable
public final java.lang.Boolean detailed()

Whether to display detailed information about shard recovery

API name: detailed

index

public final java.util.List<java.lang.String> index()

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

API name: index