All Implemented Interfaces:
Writeable, org.elasticsearch.core.RefCounted, TaskAwareRequest

public class ListTasksRequest extends BaseTasksRequest<ListTasksRequest>
A request to get node tasks
  • Field Details


      public static final String[] ANY_DESCRIPTION
  • Constructor Details

  • Method Details

    • writeTo

      public void writeTo(StreamOutput out) throws IOException
      Description copied from interface: Writeable
      Write this into the StreamOutput.
      Specified by:
      writeTo in interface Writeable
      writeTo in class BaseTasksRequest<ListTasksRequest>
    • validate

      validate in class BaseTasksRequest<ListTasksRequest>
    • match

      public boolean match(Task task)
      match in class BaseTasksRequest<ListTasksRequest>
    • getDetailed

      public boolean getDetailed()
      Should the detailed task information be returned.
    • setDetailed

      public ListTasksRequest setDetailed(boolean detailed)
      Should the detailed task information be returned.
    • getWaitForCompletion

      public boolean getWaitForCompletion()
      Should this request wait for all found tasks to complete?
    • setWaitForCompletion

      public ListTasksRequest setWaitForCompletion(boolean waitForCompletion)
      Should this request wait for all found tasks to complete?
    • getDescriptions

      public String[] getDescriptions()
      Description patters on which to match. If other matching criteria are set, descriptions are matched last once other criteria are satisfied Matching on descriptions is only available if `detailed` is `true`.
      array of absolute or simple wildcard matching strings
    • setDescriptions

      public ListTasksRequest setDescriptions(String... descriptions)