Package org.opensearch.client.opensearch.tasks

Class GetTasksRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.tasks.GetTasksRequest

public class GetTasksRequest
extends RequestBase

Returns information about a task.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GetTasksRequest.Builder	Builder for GetTasksRequest.

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static Endpoint<GetTasksRequest,GetTasksResponse,ErrorResponse>	_ENDPOINT	Endpoint "tasks.get".

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

_ENDPOINT

public static final Endpoint<GetTasksRequest,GetTasksResponse,ErrorResponse> _ENDPOINT

Endpoint "tasks.get".

Method Detail

of

public static GetTasksRequest of(java.util.function.Function<GetTasksRequest.Builder,ObjectBuilder<GetTasksRequest>> fn)

taskId

public final java.lang.String taskId()

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

API name: task_id

timeout

@Nullable
public final Time timeout()

Explicit operation timeout

API name: timeout

waitForCompletion

@Nullable
public final java.lang.Boolean waitForCompletion()

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

API name: wait_for_completion