Package org.opensearch.client.opensearch.cat

Class ThreadPoolRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

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

org.opensearch.client.opensearch.cat.ThreadPoolRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

ThreadPoolRequest

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

Builder for ThreadPoolRequest.

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
ThreadPoolRequest	build()	Builds a ThreadPoolRequest.
final ThreadPoolRequest.Builder	clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	A timeout for connection to the cluster manager node.
final ThreadPoolRequest.Builder	clusterManagerTimeout(Time value)	A timeout for connection to the cluster manager node.
ThreadPoolRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final ThreadPoolRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Deprecated.
final ThreadPoolRequest.Builder	masterTimeout(Time value)	Deprecated.
protected ThreadPoolRequest.Builder	self()
final ThreadPoolRequest.Builder	size(Integer value)	The multiplier in which to display values.
final ThreadPoolRequest.Builder	threadPoolPatterns(String value, String... values)	A comma-separated list of thread pool names used to limit the request.
final ThreadPoolRequest.Builder	threadPoolPatterns(List<String> list)	A comma-separated list of thread pool names used to limit the request.

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 ThreadPoolRequest.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<ThreadPoolRequest.Builder,ThreadPoolRequest>

Returns:

a new builder instance.

self

@Nonnull
protected ThreadPoolRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<ThreadPoolRequest.Builder>

clusterManagerTimeout

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

A timeout for connection to the cluster manager node.

API name: cluster_manager_timeout

clusterManagerTimeout

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

A timeout for connection to the cluster manager node.

API name: cluster_manager_timeout

masterTimeout

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

size

@Nonnull
public final ThreadPoolRequest.Builder size(@Nullable
 Integer value)

The multiplier in which to display values.

API name: size

threadPoolPatterns

@Nonnull
public final ThreadPoolRequest.Builder threadPoolPatterns(List<String> list)

A comma-separated list of thread pool names used to limit the request. Accepts wildcard expressions.

API name: thread_pool_patterns

Adds all elements of list to threadPoolPatterns.

threadPoolPatterns

@Nonnull
public final ThreadPoolRequest.Builder threadPoolPatterns(String value,
 String... values)

A comma-separated list of thread pool names used to limit the request. Accepts wildcard expressions.

API name: thread_pool_patterns

Adds one or more values to threadPoolPatterns.

build

@Nonnull
public ThreadPoolRequest build()

Builds a ThreadPoolRequest.

Specified by:

build in interface ObjectBuilder<ThreadPoolRequest>

Throws:

NullPointerException - if some of the required fields are null.