Class RecoveryRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<BuilderT>
co.elastic.clients.elasticsearch.cat.CatRequestBase.AbstractBuilder<RecoveryRequest.Builder>
co.elastic.clients.elasticsearch.cat.RecoveryRequest.Builder
- All Implemented Interfaces:
WithJson<RecoveryRequest.Builder>
,ObjectBuilder<RecoveryRequest>
- Enclosing class:
- RecoveryRequest
public static class RecoveryRequest.Builder
extends CatRequestBase.AbstractBuilder<RecoveryRequest.Builder>
implements ObjectBuilder<RecoveryRequest>
Builder for
RecoveryRequest
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal RecoveryRequest.Builder
activeOnly
(Boolean value) Iftrue
, the response only includes ongoing shard recoveries.build()
Builds aRecoveryRequest
.final RecoveryRequest.Builder
The unit used to display byte values.final RecoveryRequest.Builder
Iftrue
, the response includes detailed information about shard recoveries.final RecoveryRequest.Builder
A comma-separated list of data streams, indices, and aliases used to limit the request.final RecoveryRequest.Builder
A comma-separated list of data streams, indices, and aliases used to limit the request.protected RecoveryRequest.Builder
self()
Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
activeOnly
Iftrue
, the response only includes ongoing shard recoveries.API name:
active_only
-
bytes
The unit used to display byte values.API name:
bytes
-
detailed
Iftrue
, the response includes detailed information about shard recoveries.API name:
detailed
-
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
Adds all elements of
list
toindex
. -
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
Adds one or more values to
index
. -
self
- Specified by:
self
in classCatRequestBase.AbstractBuilder<RecoveryRequest.Builder>
-
build
Builds aRecoveryRequest
.- Specified by:
build
in interfaceObjectBuilder<RecoveryRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-