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 -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds aPendingTask.copy()Create a new builderCopyableBuilderthat is a copy of this one.final PendingTask.Builderexecuting(boolean value) Required - Indicates whether the pending tasks are currently executing or not.final PendingTask.BuilderinsertOrder(int value) Required - The number that represents when the task has been inserted into the task queue.final PendingTask.BuilderRequired - The priority of the pending task.final PendingTask.BuilderRequired - A general description of the cluster task that may include a reason and origin.final PendingTask.BuilderAPI name:time_in_executionfinal PendingTask.BuildertimeInExecution(Time value) API name:time_in_executionfinal PendingTask.BuildertimeInExecutionMillis(Long value) API name:time_in_execution_millisfinal PendingTask.BuilderAPI name:time_in_queuefinal PendingTask.BuildertimeInQueue(Time value) API name:time_in_queuefinal PendingTask.BuildertimeInQueueMillis(long value) Required - API name:time_in_queue_millisMethods inherited from class org.opensearch.client.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAllMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.opensearch.client.util.MutableBuilder
applyMutation
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
copy
Description copied from interface:CopyableBuilderCreate a new builderCopyableBuilderthat is a copy of this one.- Specified by:
copyin interfaceCopyableBuilder<PendingTask.Builder,PendingTask> - Returns:
- a new builder instance.
-
executing
Required - Indicates whether the pending tasks are currently executing or not.API name:
executing -
insertOrder
Required - The number that represents when the task has been inserted into the task queue.API name:
insert_order -
priority
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
Required - A general description of the cluster task that may include a reason and origin.API name:
source -
timeInExecution
API name:time_in_execution -
timeInExecution
@Nonnull public final PendingTask.Builder timeInExecution(Function<Time.Builder, ObjectBuilder<Time>> fn) API name:time_in_execution -
timeInExecutionMillis
API name:time_in_execution_millis -
timeInQueue
API name:time_in_queue -
timeInQueue
@Nonnull public final PendingTask.Builder timeInQueue(Function<Time.Builder, ObjectBuilder<Time>> fn) API name:time_in_queue -
timeInQueueMillis
Required - API name:time_in_queue_millis -
build
Builds aPendingTask.- Specified by:
buildin interfaceObjectBuilder<PendingTask>- Throws:
NullPointerException- if some of the required fields are null.
-