Package org.elasticsearch.action.support.tasks

Class BaseTasksRequest<Request extends BaseTasksRequest<Request>>

java.lang.Object
org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.TransportRequest
org.elasticsearch.action.ActionRequest
org.elasticsearch.action.support.tasks.BaseTasksRequest<Request>
All Implemented Interfaces:
Writeable, org.elasticsearch.core.RefCounted, TaskAwareRequest
Direct Known Subclasses:
CancelTasksRequest, ListTasksRequest
public class BaseTasksRequest<Request extends BaseTasksRequest<Request>> extends ActionRequest
A base class for task requests

  • Field Details

    • ALL_ACTIONS

      public static final String[] ALL_ACTIONS

    • ALL_NODES

      public static final String[] ALL_NODES

  • 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
      Overrides:
      writeTo in class ActionRequest
      Throws:
      IOException

    • validate

      public ActionRequestValidationException validate()
      Specified by:
      validate in class ActionRequest

    • setActions

      public final Request setActions(String... actions)
      Sets the list of action masks for the actions that should be returned

    • getActions

      public String[] getActions()
      Return the list of action masks for the actions that should be returned

    • getNodes

      public final String[] getNodes()

    • setNodes

      public final Request setNodes(String... nodes)

    • getTaskId

      public TaskId getTaskId()
      Returns the id of the task that should be processed. By default tasks with any ids are returned.

    • setTaskId

      public final Request setTaskId(TaskId taskId)

    • getParentTaskId

      public TaskId getParentTaskId()
      Returns the parent task id that tasks should be filtered by

    • setParentTaskId

      public Request setParentTaskId(TaskId parentTaskId)

    • getTimeout

      public org.elasticsearch.core.TimeValue getTimeout()

    • setTimeout

      public final Request setTimeout(org.elasticsearch.core.TimeValue timeout)

    • setTimeout

      public final Request setTimeout(String timeout)

    • match

      public boolean match(Task task)