Package org.elasticsearch.action.admin.cluster.node.tasks.list

Class ListTasksRequest

java.lang.Object
org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.TransportRequest
org.elasticsearch.action.ActionRequest
org.elasticsearch.action.support.tasks.BaseTasksRequest<ListTasksRequest>
org.elasticsearch.action.admin.cluster.node.tasks.list.ListTasksRequest
All Implemented Interfaces:
Writeable, org.elasticsearch.common.util.concurrent.RefCounted, TaskAwareRequest
public class ListTasksRequest
extends BaseTasksRequest<ListTasksRequest>
A request to get node tasks

  • Field Details

    • ANY_DESCRIPTION

      public static final java.lang.String[] ANY_DESCRIPTION

  • Constructor Details

    • ListTasksRequest

      public ListTasksRequest()

    • ListTasksRequest

      public ListTasksRequest​(StreamInput in) throws java.io.IOException
      Throws:
      java.io.IOException

  • Method Details

    • writeTo

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

    • validate

      public ActionRequestValidationException validate()
      Overrides:
      validate in class BaseTasksRequest<ListTasksRequest>

    • match

      public boolean match​(Task task)
      Overrides:
      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 java.lang.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`.
      Returns:
      array of absolute or simple wildcard matching strings

    • setDescriptions

      public ListTasksRequest setDescriptions​(java.lang.String... descriptions)