Package org.opensearch.client.opensearch.cat

Class PendingTasksRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

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

org.opensearch.client.opensearch.cat.PendingTasksRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

PendingTasksRequest

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

Builder for PendingTasksRequest.

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
PendingTasksRequest	build()	Builds a PendingTasksRequest.
final PendingTasksRequest.Builder	clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	The amount of time allowed to establish a connection to the cluster manager node.
final PendingTasksRequest.Builder	clusterManagerTimeout(Time value)	The amount of time allowed to establish a connection to the cluster manager node.
PendingTasksRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final PendingTasksRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Deprecated.
final PendingTasksRequest.Builder	masterTimeout(Time value)	Deprecated.
protected PendingTasksRequest.Builder	self()
final PendingTasksRequest.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 PendingTasksRequest.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<PendingTasksRequest.Builder,PendingTasksRequest>

Returns:

a new builder instance.

self

@Nonnull
protected PendingTasksRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<PendingTasksRequest.Builder>

clusterManagerTimeout

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

masterTimeout

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

Builds a PendingTasksRequest.

Specified by:

build in interface ObjectBuilder<PendingTasksRequest>

Throws:

NullPointerException - if some of the required fields are null.