Package co.elastic.clients.elasticsearch.indices

Class RecoveryRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<RecoveryRequest.Builder>

co.elastic.clients.elasticsearch.indices.RecoveryRequest.Builder

All Implemented Interfaces:

WithJson<RecoveryRequest.Builder>, ObjectBuilder<RecoveryRequest>

Enclosing class:

RecoveryRequest

public static class RecoveryRequest.Builder
extends RequestBase.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)	Display only those recoveries that are currently on-going
RecoveryRequest	build()	Builds a RecoveryRequest.
final RecoveryRequest.Builder	detailed(Boolean value)	Whether to display detailed information about shard recovery
final RecoveryRequest.Builder	index(String value, String... values)	A comma-separated list of index names; use _all or empty string to perform the operation on all indices
final RecoveryRequest.Builder	index(List<String> list)	A comma-separated list of index names; use _all or empty string to perform the operation on all indices
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)

Display only those recoveries that are currently on-going

API name: active_only

detailed

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

Whether to display detailed information about shard recovery

API name: detailed

index

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

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

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 index names; use _all or empty string to perform the operation on all indices

API name: index

Adds one or more values to index.

self

protected RecoveryRequest.Builder self()

Specified by:

self in class RequestBase.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.