Module org.elasticsearch.server

Package org.elasticsearch.action.admin.cluster.node.tasks.get

Class GetTaskRequestBuilder

java.lang.Object

org.elasticsearch.action.ActionRequestBuilder<GetTaskRequest,GetTaskResponse>

org.elasticsearch.action.admin.cluster.node.tasks.get.GetTaskRequestBuilder

public class GetTaskRequestBuilder
extends ActionRequestBuilder<GetTaskRequest,GetTaskResponse>

Builder for the request to retrieve the list of tasks running on the specified nodes

Field Summary

Fields inherited from class org.elasticsearch.action.ActionRequestBuilder

action, client, request

Constructor Summary

Constructors

Constructor	Description
GetTaskRequestBuilder(ElasticsearchClient client, GetTaskAction action)

Method Summary

Modifier and Type	Method	Description
final GetTaskRequestBuilder	setTaskId(TaskId taskId)	Set the TaskId to look up.
final GetTaskRequestBuilder	setTimeout(TimeValue timeout)	Timeout to wait for any async actions this request must take.
final GetTaskRequestBuilder	setWaitForCompletion(boolean waitForCompletion)	Should this request wait for all found tasks to complete?

Methods inherited from class org.elasticsearch.action.ActionRequestBuilder

execute, execute, get, get, get, request

Methods inherited from class java.lang.Object

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

Constructor Details

GetTaskRequestBuilder

public GetTaskRequestBuilder(ElasticsearchClient client,
 GetTaskAction action)

Method Details

setTaskId

public final GetTaskRequestBuilder setTaskId(TaskId taskId)

Set the TaskId to look up. Required.

setWaitForCompletion

public final GetTaskRequestBuilder setWaitForCompletion(boolean waitForCompletion)

Should this request wait for all found tasks to complete?

setTimeout

public final GetTaskRequestBuilder setTimeout(TimeValue timeout)

Timeout to wait for any async actions this request must take. It must take anywhere from 0 to 2.