Package org.opensearch.client.opensearch.cluster.pending_tasks

Class PendingTask.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.cluster.pending_tasks.PendingTask.Builder

All Implemented Interfaces:

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

Enclosing class:

PendingTask

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

Builder for PendingTask.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PendingTask	build()	Builds a PendingTask.
PendingTask.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final PendingTask.Builder	executing(boolean value)	Required - Indicates whether the pending tasks are currently executing or not.
final PendingTask.Builder	insertOrder(int value)	Required - The number that represents when the task has been inserted into the task queue.
final PendingTask.Builder	priority(String value)	Required - The priority of the pending task.
final PendingTask.Builder	source(String value)	Required - A general description of the cluster task that may include a reason and origin.
final PendingTask.Builder	timeInExecution(Function<Time.Builder,ObjectBuilder<Time>> fn)	API name: time_in_execution
final PendingTask.Builder	timeInExecution(Time value)	API name: time_in_execution
final PendingTask.Builder	timeInExecutionMillis(Long value)	API name: time_in_execution_millis
final PendingTask.Builder	timeInQueue(Function<Time.Builder,ObjectBuilder<Time>> fn)	API name: time_in_queue
final PendingTask.Builder	timeInQueue(Time value)	API name: time_in_queue
final PendingTask.Builder	timeInQueueMillis(long value)	Required - API name: time_in_queue_millis

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

Returns:

a new builder instance.

executing

@Nonnull
public final PendingTask.Builder executing(boolean value)

Required - Indicates whether the pending tasks are currently executing or not.

API name: executing

insertOrder

@Nonnull
public final PendingTask.Builder insertOrder(int value)

Required - The number that represents when the task has been inserted into the task queue.

API name: insert_order

priority

@Nonnull
public final PendingTask.Builder priority(String value)

Required - The priority of the pending task. The valid priorities in descending priority order are: IMMEDIATE > URGENT > HIGH > NORMAL > LOW > LANGUID.

API name: priority

source

@Nonnull
public final PendingTask.Builder source(String value)

Required - A general description of the cluster task that may include a reason and origin.

API name: source

timeInExecution

@Nonnull
public final PendingTask.Builder timeInExecution(@Nullable
 Time value)

API name: time_in_execution

timeInExecution

@Nonnull
public final PendingTask.Builder timeInExecution(Function<Time.Builder,ObjectBuilder<Time>> fn)

API name: time_in_execution

timeInExecutionMillis

@Nonnull
public final PendingTask.Builder timeInExecutionMillis(@Nullable
 Long value)

API name: time_in_execution_millis

timeInQueue

@Nonnull
public final PendingTask.Builder timeInQueue(@Nullable
 Time value)

API name: time_in_queue

timeInQueue

@Nonnull
public final PendingTask.Builder timeInQueue(Function<Time.Builder,ObjectBuilder<Time>> fn)

API name: time_in_queue

timeInQueueMillis

@Nonnull
public final PendingTask.Builder timeInQueueMillis(long value)

Required - API name: time_in_queue_millis

build

@Nonnull
public PendingTask build()

Builds a PendingTask.

Specified by:

build in interface ObjectBuilder<PendingTask>

Throws:

NullPointerException - if some of the required fields are null.