Package org.opensearch.client.opensearch.cat

Class RecoveryRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.cat.CatRequestBase.CatRequestBaseBuilder<RecoveryRequest.Builder>

org.opensearch.client.opensearch.cat.RecoveryRequest.Builder

All Implemented Interfaces:

ObjectBuilder

Enclosing class:

RecoveryRequest

public static class RecoveryRequest.Builder
extends CatRequestBase.CatRequestBaseBuilder<RecoveryRequest.Builder>

Builder for RecoveryRequest.

Field Summary

Fields inherited from class org.opensearch.client.opensearch.cat.CatRequestBase.CatRequestBaseBuilder

headers, sort

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
RecoveryRequest.Builder	activeOnly(java.lang.Boolean value)	If true, the response only includes ongoing shard recoveries
RecoveryRequest	build()	Builds a RecoveryRequest.
RecoveryRequest.Builder	bytes(Bytes value)	The unit in which to display byte values
RecoveryRequest.Builder	detailed(java.lang.Boolean value)	If true, the response includes detailed information about shard recoveries
RecoveryRequest.Builder	index(java.lang.String value, java.lang.String... values)	Comma-separated list or wildcard expression of index names to limit the returned information
RecoveryRequest.Builder	index(java.util.List<java.lang.String> list)	Comma-separated list or wildcard expression of index names to limit the returned information
protected RecoveryRequest.Builder	self()

Methods inherited from class org.opensearch.client.opensearch.cat.CatRequestBase.CatRequestBaseBuilder

headers, sort

Methods inherited from class org.opensearch.client.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

Constructor Detail

Builder

public Builder()

Method Detail

activeOnly

public final RecoveryRequest.Builder activeOnly(@Nullable
                                                java.lang.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 in which to display byte values

API name: bytes

detailed

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

If true, the response includes detailed information about shard recoveries

API name: detailed

index

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

Comma-separated list or wildcard expression of index names to limit the returned information

API name: index

Adds all elements of list to index.

index

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

Comma-separated list or wildcard expression of index names to limit the returned information

API name: index

Adds one or more values to index.

build

public RecoveryRequest build()

Builds a RecoveryRequest.

Throws:

java.lang.NullPointerException - if some of the required fields are null.

self

protected RecoveryRequest.Builder self()

Specified by:

self in class CatRequestBase.CatRequestBaseBuilder<RecoveryRequest.Builder>