Package org.opensearch.client.opensearch.cat

Class ShardsRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

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

org.opensearch.client.opensearch.cat.ShardsRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

ShardsRequest

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

Builder for ShardsRequest.

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
ShardsRequest	build()	Builds a ShardsRequest.
final ShardsRequest.Builder	bytes(Bytes value)	The units used to display byte values.
final ShardsRequest.Builder	clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	The amount of time allowed to establish a connection to the cluster manager node.
final ShardsRequest.Builder	clusterManagerTimeout(Time value)	The amount of time allowed to establish a connection to the cluster manager node.
ShardsRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final ShardsRequest.Builder	index(String value, String... values)	A comma-separated list of data streams, indexes, and aliases used to limit the request.
final ShardsRequest.Builder	index(List<String> list)	A comma-separated list of data streams, indexes, and aliases used to limit the request.
final ShardsRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Deprecated.
final ShardsRequest.Builder	masterTimeout(Time value)	Deprecated.
protected ShardsRequest.Builder	self()
final ShardsRequest.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 ShardsRequest.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<ShardsRequest.Builder,ShardsRequest>

Returns:

a new builder instance.

self

@Nonnull
protected ShardsRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<ShardsRequest.Builder>

bytes

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

The units used to display byte values.

API name: bytes

clusterManagerTimeout

@Nonnull
public final ShardsRequest.Builder clusterManagerTimeout(@Nullable
 Time value)

The amount of time allowed to establish a connection to the cluster manager node.

API name: cluster_manager_timeout

clusterManagerTimeout

@Nonnull
public final ShardsRequest.Builder clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

The amount of time allowed to establish a connection to the cluster manager node.

API name: cluster_manager_timeout

index

@Nonnull
public final ShardsRequest.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 ShardsRequest.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.

masterTimeout

@Deprecated
@Nonnull
public final ShardsRequest.Builder masterTimeout(@Nullable
 Time value)

Deprecated.

The amount of time allowed to establish a connection to the cluster manager node.

API name: master_timeout

masterTimeout

@Deprecated
@Nonnull
public final ShardsRequest.Builder masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

Deprecated.

The amount of time allowed to establish a connection to the cluster manager node.

API name: master_timeout

time

@Nonnull
public final ShardsRequest.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 ShardsRequest build()

Builds a ShardsRequest.

Specified by:

build in interface ObjectBuilder<ShardsRequest>

Throws:

NullPointerException - if some of the required fields are null.