Package org.opensearch.client.opensearch.cat

Class ThreadPoolRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.cat.CatRequestBase

org.opensearch.client.opensearch.cat.ThreadPoolRequest

All Implemented Interfaces:

ToCopyableBuilder<ThreadPoolRequest.Builder,ThreadPoolRequest>

@Generated("org.opensearch.client.codegen.CodeGenerator")
public final class ThreadPoolRequest
extends CatRequestBase
implements ToCopyableBuilder<ThreadPoolRequest.Builder,ThreadPoolRequest>

Returns cluster-wide thread pool statistics per node. By default the active, queued, and rejected statistics are returned for all thread pools.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ThreadPoolRequest.Builder	Builder for ThreadPoolRequest.

Nested classes/interfaces inherited from class org.opensearch.client.opensearch.cat.CatRequestBase

CatRequestBase.AbstractBuilder<BuilderT extends CatRequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final Endpoint<ThreadPoolRequest,ThreadPoolResponse,ErrorResponse>	_ENDPOINT	Endpoint "cat.thread_pool".

Method Summary

Modifier and Type	Method	Description
protected void	applyQueryParameters(Map<String,String> params)
static ThreadPoolRequest.Builder	builder()
final Time	clusterManagerTimeout()	A timeout for connection to the cluster manager node.
boolean	equals(Object o)
int	hashCode()
final Time	masterTimeout()	Deprecated.
static ThreadPoolRequest	of(Function<ThreadPoolRequest.Builder,ObjectBuilder<ThreadPoolRequest>> fn)
final Integer	size()	The multiplier in which to display values.
final List<String>	threadPoolPatterns()	A comma-separated list of thread pool names used to limit the request.
ThreadPoolRequest.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

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

headers, sort

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

errorTrace, human

Methods inherited from class java.lang.Object

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

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

copy

Field Details

_ENDPOINT

public static final Endpoint<ThreadPoolRequest,ThreadPoolResponse,ErrorResponse> _ENDPOINT

Endpoint "cat.thread_pool".

Method Details

of

public static ThreadPoolRequest of(Function<ThreadPoolRequest.Builder,ObjectBuilder<ThreadPoolRequest>> fn)

clusterManagerTimeout

@Nullable
public final Time clusterManagerTimeout()

A timeout for connection to the cluster manager node.

API name: cluster_manager_timeout

masterTimeout

@Deprecated
@Nullable
public final Time masterTimeout()

Deprecated.

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

API name: master_timeout

size

@Nullable
public final Integer size()

The multiplier in which to display values.

API name: size

threadPoolPatterns

@Nonnull
public final List<String> threadPoolPatterns()

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

API name: thread_pool_patterns

toBuilder

@Nonnull
public ThreadPoolRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<ThreadPoolRequest.Builder,ThreadPoolRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static ThreadPoolRequest.Builder builder()

applyQueryParameters

protected void applyQueryParameters(@Nonnull
 Map<String,String> params)

Overrides:

applyQueryParameters in class CatRequestBase

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object