Package org.opensearch.client.opensearch.tasks

Class GetTasksRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.tasks.GetTasksRequest.Builder

All Implemented Interfaces:

ObjectBuilder<GetTasksRequest>

Enclosing class:

GetTasksRequest

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

Builder for GetTasksRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GetTasksRequest	build()	Builds a GetTasksRequest.
GetTasksRequest.Builder	taskId(java.lang.String value)	Required - Return the task with specified id (node_id:task_number)
GetTasksRequest.Builder	timeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Explicit operation timeout
GetTasksRequest.Builder	timeout(Time value)	Explicit operation timeout
GetTasksRequest.Builder	waitForCompletion(java.lang.Boolean value)	Wait for the matching tasks to complete (default: false)

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

taskId

public final GetTasksRequest.Builder taskId(java.lang.String value)

Required - Return the task with specified id (node_id:task_number)

API name: task_id

timeout

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

Explicit operation timeout

API name: timeout

timeout

public final GetTasksRequest.Builder timeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)

Explicit operation timeout

API name: timeout

waitForCompletion

public final GetTasksRequest.Builder waitForCompletion(@Nullable
                                                       java.lang.Boolean value)

Wait for the matching tasks to complete (default: false)

API name: wait_for_completion

build

public GetTasksRequest build()

Builds a GetTasksRequest.

Specified by:

build in interface ObjectBuilder<GetTasksRequest>

Throws:

java.lang.NullPointerException - if some of the required fields are null.