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
  • Constructor Details

  • 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​(java.lang.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