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
The task management API returns information about tasks currently executing on one or more nodes in the cluster.
See Also:

  • Field Details

  • Method Details

    • of

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

    • actions

      public final List<String> actions()
      Comma-separated list or wildcard expression of actions used to limit the request.

      API name: actions

    • detailed

      @Nullable public final Boolean detailed()
      If true, the response includes detailed information about shard recoveries.

      API name: detailed

    • groupBy

      @Nullable public final GroupBy groupBy()
      Key used to group tasks in the response.

      API name: group_by

    • masterTimeout

      @Nullable public final Time masterTimeout()
      Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      API name: master_timeout

    • nodeId

      public final List<String> nodeId()
      Comma-separated list of node IDs or names used to limit returned information.

      API name: node_id

    • parentTaskId

      @Nullable public final String parentTaskId()
      Parent task ID used to limit returned information. To return all tasks, omit this parameter or use a value of -1.

      API name: parent_task_id

    • timeout

      @Nullable public final Time timeout()
      Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

      API name: timeout

    • waitForCompletion

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

      API name: wait_for_completion