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 forRecoveryRequest
.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 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-goingjava.lang.Boolean
detailed()
Whether to display detailed information about shard recoveryjava.util.List<java.lang.String>
index()
A comma-separated list of index names; use_all
or empty string to perform the operation on all indicesstatic 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 Details
-
_ENDPOINT
Endpoint "indices.recovery
".
-
-
Method Details
-
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-goingAPI name:
active_only
-
detailed
@Nullable public final java.lang.Boolean detailed()Whether to display detailed information about shard recoveryAPI 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 indicesAPI name:
index
-