Package org.opensearch.client.opensearch.cat

Class RecoveryRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<RecoveryRequest.Builder>

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

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

All Implemented Interfaces:

CopyableBuilder<RecoveryRequest.Builder,RecoveryRequest>, MutableBuilder<RecoveryRequest.Builder,RecoveryRequest>, ObjectBuilder<RecoveryRequest>

Enclosing class:

RecoveryRequest

public static class RecoveryRequest.Builder
extends CatRequestBase.AbstractBuilder<RecoveryRequest.Builder>
implements CopyableBuilder<RecoveryRequest.Builder,RecoveryRequest>

Builder for RecoveryRequest.

Field Summary

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

headers, sort

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 units used to display byte values.
RecoveryRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final RecoveryRequest.Builder	detailed(Boolean value)	When true, includes detailed information about shard recoveries.
final RecoveryRequest.Builder	index(String value, String... values)	A comma-separated list of data streams, indexes, and aliases used to limit the request.
final RecoveryRequest.Builder	index(List<String> list)	A comma-separated list of data streams, indexes, and aliases used to limit the request.
protected RecoveryRequest.Builder	self()
final RecoveryRequest.Builder	time(TimeUnit value)	Specifies the time units, for example, 5d or 7h.

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

headers, headers, sort, sort

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder

errorTrace, human

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.util.MutableBuilder

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public RecoveryRequest.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<RecoveryRequest.Builder,RecoveryRequest>

Returns:

a new builder instance.

self

@Nonnull
protected RecoveryRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<RecoveryRequest.Builder>

activeOnly

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

If true, the response only includes ongoing shard recoveries.

API name: active_only

bytes

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

The units used to display byte values.

API name: bytes

detailed

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

When true, includes detailed information about shard recoveries.

API name: detailed

index

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

A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or _all.

API name: index

Adds all elements of list to index.

index

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

A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or _all.

API name: index

Adds one or more values to index.

time

@Nonnull
public final RecoveryRequest.Builder time(@Nullable
 TimeUnit value)

Specifies the time units, for example, 5d or 7h. For more information, see Supported units.

API name: time

build

@Nonnull
public RecoveryRequest build()

Builds a RecoveryRequest.

Specified by:

build in interface ObjectBuilder<RecoveryRequest>

Throws:

NullPointerException - if some of the required fields are null.