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.common.util.concurrent.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 java.lang.String[] ALL_ACTIONS

    • ALL_NODES

      public static final java.lang.String[] ALL_NODES

  • Constructor Details

    • BaseTasksRequest

      public BaseTasksRequest()

    • BaseTasksRequest

      protected BaseTasksRequest​(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 ActionRequest
      Throws:
      java.io.IOException

    • validate

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

    • setActions

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

    • getActions

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

    • getNodes

      public final java.lang.String[] getNodes()

    • setNodes

      public final Request setNodes​(java.lang.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.common.unit.TimeValue getTimeout()

    • setTimeout

      public final Request setTimeout​(org.elasticsearch.common.unit.TimeValue timeout)

    • setTimeout

      public final Request setTimeout​(java.lang.String timeout)

    • match

      public boolean match​(Task task)