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
Returns a list of tasks.
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 of actions that should be returned. Leave empty to return all.

      API name: actions

    • detailed

      @Nullable public final Boolean detailed()
      Return detailed task information (default: false)

      API name: detailed

    • groupBy

      @Nullable public final GroupBy groupBy()
      Group tasks by nodes or parent/child relationships

      API name: group_by

    • nodes

      public final List<String> nodes()
      A comma-separated list of node IDs or names to limit the returned information; use _local to return information from the node you're connecting to, leave empty to get information from all nodes

      API name: nodes

    • parentTaskId

      @Nullable public final String parentTaskId()
      Return tasks with specified parent task id (node_id:task_number). Set to -1 to return all.

      API name: parent_task_id

    • timeout

      @Nullable public final Time timeout()
      Explicit operation timeout

      API name: timeout

    • waitForCompletion

      @Nullable public final Boolean waitForCompletion()
      Wait for the matching tasks to complete (default: false)

      API name: wait_for_completion