Package org.opensearch.client.opensearch.cat.thread_pool

Class ThreadPoolRecord.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.cat.thread_pool.ThreadPoolRecord.Builder

All Implemented Interfaces:

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

Enclosing class:

ThreadPoolRecord

public static class ThreadPoolRecord.Builder
extends ObjectBuilderBase
implements CopyableBuilder<ThreadPoolRecord.Builder,ThreadPoolRecord>

Builder for ThreadPoolRecord.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final ThreadPoolRecord.Builder	active(String value)	The number of active threads in the current thread pool.
ThreadPoolRecord	build()	Builds a ThreadPoolRecord.
final ThreadPoolRecord.Builder	completed(String value)	The number of completed tasks.
ThreadPoolRecord.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final ThreadPoolRecord.Builder	core(String value)	The core number of active threads allowed in a scaling thread pool.
final ThreadPoolRecord.Builder	ephemeralNodeId(String value)	The ephemeral node identifier.
final ThreadPoolRecord.Builder	host(String value)	The hostname for the current node.
final ThreadPoolRecord.Builder	ip(String value)	The IP address for the current node.
final ThreadPoolRecord.Builder	keepAlive(String value)	The thread keep alive time.
final ThreadPoolRecord.Builder	largest(String value)	The highest number of active threads in the current thread pool.
final ThreadPoolRecord.Builder	max(String value)	The maximum number of active threads allowed in a scaling thread pool.
final ThreadPoolRecord.Builder	name(String value)	The thread pool name.
final ThreadPoolRecord.Builder	nodeId(String value)	API name: node_id
final ThreadPoolRecord.Builder	nodeName(String value)	The node name.
final ThreadPoolRecord.Builder	pid(String value)	The process identifier.
final ThreadPoolRecord.Builder	poolSize(String value)	The number of threads in the current thread pool.
final ThreadPoolRecord.Builder	port(String value)	The bound transport port for the current node.
final ThreadPoolRecord.Builder	queue(String value)	The number of tasks currently in queue.
final ThreadPoolRecord.Builder	queueSize(String value)	The maximum number of tasks permitted in the queue.
final ThreadPoolRecord.Builder	rejected(String value)	The number of rejected tasks.
final ThreadPoolRecord.Builder	size(String value)	The number of active threads allowed in a fixed thread pool.
final ThreadPoolRecord.Builder	totalWaitTime(String value)	API name: total_wait_time
final ThreadPoolRecord.Builder	type(String value)	The thread pool type.

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

Returns:

a new builder instance.

active

@Nonnull
public final ThreadPoolRecord.Builder active(@Nullable
 String value)

The number of active threads in the current thread pool.

API name: active

completed

@Nonnull
public final ThreadPoolRecord.Builder completed(@Nullable
 String value)

The number of completed tasks.

API name: completed

core

@Nonnull
public final ThreadPoolRecord.Builder core(@Nullable
 String value)

The core number of active threads allowed in a scaling thread pool.

API name: core

ephemeralNodeId

@Nonnull
public final ThreadPoolRecord.Builder ephemeralNodeId(@Nullable
 String value)

The ephemeral node identifier.

API name: ephemeral_node_id

host

@Nonnull
public final ThreadPoolRecord.Builder host(@Nullable
 String value)

The hostname for the current node.

API name: host

ip

@Nonnull
public final ThreadPoolRecord.Builder ip(@Nullable
 String value)

The IP address for the current node.

API name: ip

keepAlive

@Nonnull
public final ThreadPoolRecord.Builder keepAlive(@Nullable
 String value)

The thread keep alive time.

API name: keep_alive

largest

@Nonnull
public final ThreadPoolRecord.Builder largest(@Nullable
 String value)

The highest number of active threads in the current thread pool.

API name: largest

max

@Nonnull
public final ThreadPoolRecord.Builder max(@Nullable
 String value)

The maximum number of active threads allowed in a scaling thread pool.

API name: max

name

@Nonnull
public final ThreadPoolRecord.Builder name(@Nullable
 String value)

The thread pool name.

API name: name

nodeId

@Nonnull
public final ThreadPoolRecord.Builder nodeId(@Nullable
 String value)

API name: node_id

nodeName

@Nonnull
public final ThreadPoolRecord.Builder nodeName(@Nullable
 String value)

The node name.

API name: node_name

pid

@Nonnull
public final ThreadPoolRecord.Builder pid(@Nullable
 String value)

The process identifier.

API name: pid

poolSize

@Nonnull
public final ThreadPoolRecord.Builder poolSize(@Nullable
 String value)

The number of threads in the current thread pool.

API name: pool_size

port

@Nonnull
public final ThreadPoolRecord.Builder port(@Nullable
 String value)

The bound transport port for the current node.

API name: port

queue

@Nonnull
public final ThreadPoolRecord.Builder queue(@Nullable
 String value)

The number of tasks currently in queue.

API name: queue

queueSize

@Nonnull
public final ThreadPoolRecord.Builder queueSize(@Nullable
 String value)

The maximum number of tasks permitted in the queue.

API name: queue_size

rejected

@Nonnull
public final ThreadPoolRecord.Builder rejected(@Nullable
 String value)

The number of rejected tasks.

API name: rejected

size

@Nonnull
public final ThreadPoolRecord.Builder size(@Nullable
 String value)

The number of active threads allowed in a fixed thread pool.

API name: size

totalWaitTime

@Nonnull
public final ThreadPoolRecord.Builder totalWaitTime(@Nullable
 String value)

API name: total_wait_time

type

@Nonnull
public final ThreadPoolRecord.Builder type(@Nullable
 String value)

The thread pool type. Returned values include fixed, fixed_auto_queue_size, direct, and scaling.

API name: type

build

@Nonnull
public ThreadPoolRecord build()

Builds a ThreadPoolRecord.

Specified by:

build in interface ObjectBuilder<ThreadPoolRecord>

Throws:

NullPointerException - if some of the required fields are null.