Module org.elasticsearch.server
Class ListTasksRequestBuilder
java.lang.Object
org.elasticsearch.action.ActionRequestBuilder<ListTasksRequest,ListTasksResponse>
org.elasticsearch.action.support.tasks.TasksRequestBuilder<ListTasksRequest,ListTasksResponse,ListTasksRequestBuilder>
org.elasticsearch.action.admin.cluster.node.tasks.list.ListTasksRequestBuilder
- All Implemented Interfaces:
RequestBuilder<ListTasksRequest,ListTasksResponse>
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 -
Method Summary
Modifier and TypeMethodDescriptionfinal ListTasksRequestBuildersetDescriptions(String... descriptions) Should the task match specific descriptions.setDetailed(boolean detailed) Should detailed task information be returned.final ListTasksRequestBuildersetWaitForCompletion(boolean waitForCompletion) Should this request wait for all found tasks to complete?Methods inherited from class org.elasticsearch.action.support.tasks.TasksRequestBuilder
setActions, setNodesIds, setTargetParentTaskId, setTargetTaskId, setTimeout
-
Constructor Details
-
ListTasksRequestBuilder
-
-
Method Details
-
setDetailed
Should detailed task information be returned. -
setWaitForCompletion
Should this request wait for all found tasks to complete? -
setDescriptions
Should the task match specific descriptions. Cannot be used unlesssetDetailed(boolean)is `true`- Parameters:
descriptions- string array containing simple regex or absolute description matching- Returns:
- the builder with descriptions set
-