Package co.elastic.clients.elasticsearch.tasks

Class GetTasksRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<GetTasksRequest.Builder>

co.elastic.clients.elasticsearch.tasks.GetTasksRequest.Builder

All Implemented Interfaces:

WithJson<GetTasksRequest.Builder>, ObjectBuilder<GetTasksRequest>

Enclosing class:

GetTasksRequest

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

Builder for GetTasksRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GetTasksRequest	build()	Builds a GetTasksRequest.
protected GetTasksRequest.Builder	self()
final GetTasksRequest.Builder	taskId(String value)	Required - The task identifier.
final GetTasksRequest.Builder	timeout(Time value)	The period to wait for a response.
final GetTasksRequest.Builder	timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	The period to wait for a response.
final GetTasksRequest.Builder	waitForCompletion(Boolean value)	If true, the request blocks until the task has completed.

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

taskId

public final GetTasksRequest.Builder taskId(String value)

Required - The task identifier.

API name: task_id

timeout

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

The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

API name: timeout

timeout

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

The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

API name: timeout

waitForCompletion

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

If true, the request blocks until the task has completed.

API name: wait_for_completion

self

protected GetTasksRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<GetTasksRequest.Builder>

build

public GetTasksRequest build()

Builds a GetTasksRequest.

Specified by:

build in interface ObjectBuilder<GetTasksRequest>

Throws:

NullPointerException - if some of the required fields are null.