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

Class ListTasksRequestBuilder

java.lang.Object

org.elasticsearch.action.ActionRequestBuilder<Request,Response>

org.elasticsearch.action.support.tasks.TasksRequestBuilder<ListTasksRequest,ListTasksResponse,ListTasksRequestBuilder>

org.elasticsearch.action.admin.cluster.node.tasks.list.ListTasksRequestBuilder

public class ListTasksRequestBuilder
extends TasksRequestBuilder<ListTasksRequest,ListTasksResponse,ListTasksRequestBuilder>

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
ListTasksRequestBuilder(ElasticsearchClient client, ListTasksAction action)

Method Summary

Modifier and Type	Method	Description
ListTasksRequestBuilder	setDescriptions(String... descriptions)	Should the task match specific descriptions.
ListTasksRequestBuilder	setDetailed(boolean detailed)	Should detailed task information be returned.
ListTasksRequestBuilder	setWaitForCompletion(boolean waitForCompletion)	Should this request wait for all found tasks to complete?

Methods inherited from class org.elasticsearch.action.support.tasks.TasksRequestBuilder

setActions, setNodesIds, setParentTaskId, setTaskId, setTimeout

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

ListTasksRequestBuilder

public ListTasksRequestBuilder(ElasticsearchClient client,
 ListTasksAction action)

Method Details

setDetailed

public ListTasksRequestBuilder setDetailed(boolean detailed)

Should detailed task information be returned.

setWaitForCompletion

public final ListTasksRequestBuilder setWaitForCompletion(boolean waitForCompletion)

Should this request wait for all found tasks to complete?

setDescriptions

public final ListTasksRequestBuilder setDescriptions(String... descriptions)

Should the task match specific descriptions. Cannot be used unless setDetailed(boolean) is `true`

Parameters:

descriptions - string array containing simple regex or absolute description matching

Returns:

the builder with descriptions set