Package org.opensearch.client.opensearch.tasks

Class GetTasksRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<GetTasksRequest.Builder>

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

All Implemented Interfaces:

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

Enclosing class:

GetTasksRequest

public static class GetTasksRequest.Builder
extends RequestBase.AbstractBuilder<GetTasksRequest.Builder>
implements CopyableBuilder<GetTasksRequest.Builder,GetTasksRequest>

Builder for GetTasksRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GetTasksRequest	build()	Builds a GetTasksRequest.
GetTasksRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
protected GetTasksRequest.Builder	self()
final GetTasksRequest.Builder	taskId(String value)	Required - The task ID.
final GetTasksRequest.Builder	timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	The amount of time to wait for a response.
final GetTasksRequest.Builder	timeout(Time value)	The amount of time to wait for a response.
final GetTasksRequest.Builder	waitForCompletion(Boolean value)	Waits for the matching task to complete.

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder

errorTrace, human

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

Returns:

a new builder instance.

self

@Nonnull
protected GetTasksRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<GetTasksRequest.Builder>

taskId

@Nonnull
public final GetTasksRequest.Builder taskId(String value)

Required - The task ID.

API name: task_id

timeout

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

The amount of time to wait for a response.

API name: timeout

timeout

@Nonnull
public final GetTasksRequest.Builder timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

The amount of time to wait for a response.

API name: timeout

waitForCompletion

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

Waits for the matching task to complete. When true, the request is blocked until the task has completed.

API name: wait_for_completion

build

@Nonnull
public GetTasksRequest build()

Builds a GetTasksRequest.

Specified by:

build in interface ObjectBuilder<GetTasksRequest>

Throws:

NullPointerException - if some of the required fields are null.