Package org.opensearch.client.opensearch.nodes

Class HotThreadsRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.nodes.HotThreadsRequest.Builder

All Implemented Interfaces:

ObjectBuilder<HotThreadsRequest>

Enclosing class:

HotThreadsRequest

public static class HotThreadsRequest.Builder
extends ObjectBuilderBase
implements ObjectBuilder<HotThreadsRequest>

Builder for HotThreadsRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

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

Constructor Details

Builder

public Builder()

Method Details

ignoreIdleThreads

public final HotThreadsRequest.Builder ignoreIdleThreads(@Nullable
 Boolean value)

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

public final HotThreadsRequest.Builder interval(@Nullable
 Time value)

The interval to do the second sampling of threads.

API name: interval

interval

public final HotThreadsRequest.Builder interval(Function<Time.Builder,ObjectBuilder<Time>> fn)

The interval to do the second sampling of threads.

API name: interval

masterTimeout

@Deprecated
public final HotThreadsRequest.Builder masterTimeout(@Nullable
 Time value)

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

masterTimeout

@Deprecated
public final HotThreadsRequest.Builder masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

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

public final HotThreadsRequest.Builder clusterManagerTimeout(@Nullable
 Time value)

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

clusterManagerTimeout

public final HotThreadsRequest.Builder clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

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 HotThreadsRequest.Builder nodeId(List<String> list)

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

API name: node_id

Adds all elements of list to nodeId.

nodeId

public final HotThreadsRequest.Builder nodeId(String value,
 String... values)

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

API name: node_id

Adds one or more values to nodeId.

snapshots

public final HotThreadsRequest.Builder snapshots(@Nullable
 Long value)

Number of samples of thread stacktrace.

API name: snapshots

threads

public final HotThreadsRequest.Builder threads(@Nullable
 Long value)

Specifies the number of hot threads to provide information for.

API name: threads

timeout

public final HotThreadsRequest.Builder timeout(@Nullable
 Time value)

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

timeout

public final HotThreadsRequest.Builder timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

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

public final HotThreadsRequest.Builder type(@Nullable
 ThreadType value)

The type to sample.

API name: type

build

public HotThreadsRequest build()

Builds a HotThreadsRequest.

Specified by:

build in interface ObjectBuilder<HotThreadsRequest>

Throws:

NullPointerException - if some of the required fields are null.