Package co.elastic.clients.elasticsearch.cat

Class ThreadPoolRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.cat.CatRequestBase

co.elastic.clients.elasticsearch.cat.ThreadPoolRequest

public class ThreadPoolRequest
extends CatRequestBase

Get thread pool statistics.

Get thread pool statistics for each node in a cluster. Returned information includes all built-in thread pools and custom thread pools. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch.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
final Boolean	local()	If true, the request computes the list of selected nodes from the local cluster state.
final Time	masterTimeout()	Period to wait for a connection to the master node.
static ThreadPoolRequest	of(Function<ThreadPoolRequest.Builder,ObjectBuilder<ThreadPoolRequest>> fn)
final List<String>	threadPoolPatterns()	A comma-separated list of thread pool names used to limit the request.
final TimeUnit	time()	The unit used to display time values.

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

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

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)

local

@Nullable
public final Boolean local()

If true, the request computes the list of selected nodes from the local cluster state. If false the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node.

API name: local

masterTimeout

@Nullable
public final Time masterTimeout()

Period to wait for a connection to the master node.

API name: master_timeout

threadPoolPatterns

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

time

@Nullable
public final TimeUnit time()

The unit used to display time values.

API name: time