Package org.opensearch.client.opensearch.nodes

Class HotThreadsRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.nodes.HotThreadsRequest

public class HotThreadsRequest
extends RequestBase

Returns information about hot threads on each node in the cluster.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static Endpoint<HotThreadsRequest,HotThreadsResponse,ErrorResponse>	_ENDPOINT	Endpoint "nodes.hot_threads".

Method Summary

Modifier and Type	Method	Description
Time	clusterManagerTimeout()	Period to wait for a connection to the cluster-manager node.
java.lang.Boolean	ignoreIdleThreads()	If true, known idle threads (e.g.
Time	interval()	The interval to do the second sampling of threads.
Time	masterTimeout()	Deprecated.
java.util.List<java.lang.String>	nodeId()	List of node IDs or names used to limit returned information.
static HotThreadsRequest	of(java.util.function.Function<HotThreadsRequest.Builder,ObjectBuilder<HotThreadsRequest>> fn)
java.lang.Long	snapshots()	Number of samples of thread stacktrace.
java.lang.Long	threads()	Specifies the number of hot threads to provide information for.
Time	timeout()	Period to wait for a response.
ThreadType	type()	The type to sample.

Methods inherited from class java.lang.Object

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

Field Detail

_ENDPOINT

public static final Endpoint<HotThreadsRequest,HotThreadsResponse,ErrorResponse> _ENDPOINT

Endpoint "nodes.hot_threads".

Method Detail

of

public static HotThreadsRequest of(java.util.function.Function<HotThreadsRequest.Builder,ObjectBuilder<HotThreadsRequest>> fn)

ignoreIdleThreads

@Nullable
public final java.lang.Boolean ignoreIdleThreads()

If true, known idle threads (e.g. waiting in a socket select, or to get a task from an empty queue) are filtered out.

API name: ignore_idle_threads

interval

@Nullable
public final Time interval()

The interval to do the second sampling of threads.

API name: interval

masterTimeout

@Deprecated
@Nullable
public final Time masterTimeout()

Deprecated.

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

API name: master_timeout

clusterManagerTimeout

@Nullable
public final Time clusterManagerTimeout()

Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.

API name: cluster_manager_timeout

nodeId

public final java.util.List<java.lang.String> nodeId()

List of node IDs or names used to limit returned information.

API name: node_id

snapshots

@Nullable
public final java.lang.Long snapshots()

Number of samples of thread stacktrace.

API name: snapshots

threads

@Nullable
public final java.lang.Long threads()

Specifies the number of hot threads to provide information for.

API name: threads

timeout

@Nullable
public final Time timeout()

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

API name: timeout

type

@Nullable
public final ThreadType type()

The type to sample.

API name: type