Package co.elastic.clients.elasticsearch.tasks

Class ListRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.tasks.ListRequest
public class ListRequest extends RequestBase
Get all tasks. Get information about the tasks currently running on one or more nodes in the cluster.

WARNING: The task management API is new and should still be considered a beta feature. The API may change in ways that are not backwards compatible.

Identifying running tasks

The X-Opaque-Id header, when provided on the HTTP request header, is going to be returned as a header in the response as well as in the headers field for in the task information. This enables you to track certain calls or associate certain tasks with the client that started them. For example: 

 curl -i -H "X-Opaque-Id: 123456" "http://localhost:9200/_tasks?group_by=parents"

The API returns the following result: 

 HTTP/1.1 200 OK
 X-Opaque-Id: 123456
 content-type: application/json; charset=UTF-8
 content-length: 831

 {
   "tasks" : {
     "u5lcZHqcQhu-rUoFaqDphA:45" : {
       "node" : "u5lcZHqcQhu-rUoFaqDphA",
       "id" : 45,
       "type" : "transport",
       "action" : "cluster:monitor/tasks/lists",
       "start_time_in_millis" : 1513823752749,
       "running_time_in_nanos" : 293139,
       "cancellable" : false,
       "headers" : {
         "X-Opaque-Id" : "123456"
       },
       "children" : [
         {
           "node" : "u5lcZHqcQhu-rUoFaqDphA",
           "id" : 46,
           "type" : "direct",
           "action" : "cluster:monitor/tasks/lists[n]",
           "start_time_in_millis" : 1513823752750,
           "running_time_in_nanos" : 92133,
           "cancellable" : false,
           "parent_task_id" : "u5lcZHqcQhu-rUoFaqDphA:45",
           "headers" : {
             "X-Opaque-Id" : "123456"
           }
         }
       ]
     }
   }
  }

In this example, X-Opaque-Id: 123456 is the ID as a part of the response header. The X-Opaque-Id in the task headers is the ID for the task that was initiated by the REST request. The X-Opaque-Id in the children headers is the child task of the task that was initiated by the REST request.

See Also:

  • Field Details

  • Method Details

    • of

      public static ListRequest of(Function<ListRequest.Builder,ObjectBuilder<ListRequest>> fn)

    • actions

      public final List<String> actions()
      A comma-separated list or wildcard expression of actions used to limit the request. For example, you can use cluser:* to retrieve all cluster-related tasks.

      API name: actions

    • detailed

      @Nullable public final Boolean detailed()
      If true, the response includes detailed information about the running tasks. This information is useful to distinguish tasks from each other but is more costly to run.

      API name: detailed

    • groupBy

      @Nullable public final GroupBy groupBy()
      A key that is used to group tasks in the response. The task lists can be grouped either by nodes or by parent tasks.

      API name: group_by

    • nodes

      public final List<String> nodes()
      A comma-separated list of node IDs or names that is used to limit the returned information.

      API name: nodes

    • parentTaskId

      @Nullable public final String parentTaskId()
      A parent task identifier that is used to limit returned information. To return all tasks, omit this parameter or use a value of -1. If the parent task is not found, the API does not return a 404 response code.

      API name: parent_task_id

    • timeout

      @Nullable public final Time timeout()
      The period to wait for each node to respond. If a node does not respond before its timeout expires, the response does not include its information. However, timed out nodes are included in the node_failures property.

      API name: timeout

    • waitForCompletion

      @Nullable public final Boolean waitForCompletion()
      If true, the request blocks until the operation is complete.

      API name: wait_for_completion