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 index shard recoveries, both on-going completed.
- 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.cat.CatRequestBase
CatRequestBase.AbstractBuilder<BuilderT extends CatRequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Fields Modifier and Type Field Description static Endpoint<RecoveryRequest,RecoveryResponse,ErrorResponse>
_ENDPOINT
Endpoint "cat.recovery
". -
Method Summary
Modifier and Type Method Description java.lang.Boolean
activeOnly()
Iftrue
, the response only includes ongoing shard recoveriesBytes
bytes()
The unit in which to display byte valuesjava.lang.Boolean
detailed()
Iftrue
, the response includes detailed information about shard recoveriesjava.util.List<java.lang.String>
index()
Comma-separated list or wildcard expression of index names to limit the returned informationstatic RecoveryRequest
of(java.util.function.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
Endpoint "cat.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()Iftrue
, the response only includes ongoing shard recoveriesAPI name:
active_only
-
bytes
The unit in which to display byte valuesAPI name:
bytes
-
detailed
@Nullable public final java.lang.Boolean detailed()Iftrue
, the response includes detailed information about shard recoveriesAPI name:
detailed
-
index
public final java.util.List<java.lang.String> index()Comma-separated list or wildcard expression of index names to limit the returned informationAPI name:
index
-