Class GetTasksRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.tasks.GetTasksRequest
public class GetTasksRequest extends RequestBase
Returns information about a task.
- See Also:
- API specification
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
GetTasksRequest.Builder
Builder forGetTasksRequest
.Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._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 timeoutjava.lang.Boolean
waitForCompletion()
Wait for the matching tasks to complete (default: false)Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Field Details
-
_ENDPOINT
Endpoint "tasks.get
".
-
-
Method Details
-
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
Explicit operation timeoutAPI name:
timeout
-
waitForCompletion
@Nullable public final java.lang.Boolean waitForCompletion()Wait for the matching tasks to complete (default: false)API name:
wait_for_completion
-