Package co.elastic.clients.elasticsearch.cat

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

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final RecoveryRequest.Builder	activeOnly(Boolean value)	If true, the response only includes ongoing shard recoveries.
RecoveryRequest	build()	Builds a RecoveryRequest.
final RecoveryRequest.Builder	bytes(Bytes value)	The unit used to display byte values.
final RecoveryRequest.Builder	detailed(Boolean value)	If true, the response includes detailed information about shard recoveries.
final RecoveryRequest.Builder	index(String value, String... values)	A comma-separated list of data streams, indices, and aliases used to limit the request.
final RecoveryRequest.Builder	index(List<String> list)	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

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

activeOnly

public final RecoveryRequest.Builder activeOnly(@Nullable
 Boolean value)

If true, the response only includes ongoing shard recoveries.

API name: active_only

bytes

public final RecoveryRequest.Builder bytes(@Nullable
 Bytes value)

The unit used to display byte values.

API name: bytes

detailed

public final RecoveryRequest.Builder detailed(@Nullable
 Boolean value)

If true, the response includes detailed information about shard recoveries.

API name: detailed

index

public final RecoveryRequest.Builder index(List<String> list)

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 to index.

index

public final RecoveryRequest.Builder index(String value,
 String... values)

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

protected RecoveryRequest.Builder self()

Specified by:

self in class CatRequestBase.AbstractBuilder<RecoveryRequest.Builder>

build

public RecoveryRequest build()

Builds a RecoveryRequest.

Specified by:

build in interface ObjectBuilder<RecoveryRequest>

Throws:

NullPointerException - if some of the required fields are null.