Class TaskInfo

All Implemented Interfaces:
Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentFragment

public final class TaskInfo extends Object implements Writeable, org.elasticsearch.common.xcontent.ToXContentFragment
Information about a currently running task.

Tasks are used for communication with transport actions. As a result, they can contain callback references as well as mutable state. That makes it impractical to send tasks over transport channels and use in APIs. Instead, immutable and writeable TaskInfo objects are used to represent snapshot information about currently running tasks.

  • Field Details

    • PARSER

      public static final org.elasticsearch.common.xcontent.ConstructingObjectParser<TaskInfo,​Void> PARSER
  • 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
    • getTaskId

      public TaskId getTaskId()
    • getId

      public long getId()
    • getType

      public String getType()
    • getAction

      public String getAction()
    • getDescription

      public String getDescription()
    • getStatus

      public Task.Status getStatus()
      The status of the running task. Only available if TaskInfos were build with the detailed flag.
    • getStartTime

      public long getStartTime()
      Returns the task start time
    • getRunningTimeNanos

      public long getRunningTimeNanos()
      Returns the task running time
    • isCancellable

      public boolean isCancellable()
      Returns true if the task supports cancellation
    • isCancelled

      public boolean isCancelled()
      Returns true if the task supports cancellation and has been cancelled
    • getParentTaskId

      public TaskId getParentTaskId()
      Returns the parent task id
    • getHeaders

      public Map<String,​String> getHeaders()
      Returns the task headers
    • toXContent

      public org.elasticsearch.common.xcontent.XContentBuilder toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws IOException
      Specified by:
      toXContent in interface org.elasticsearch.common.xcontent.ToXContent
    • fromXContent

      public static TaskInfo fromXContent(org.elasticsearch.common.xcontent.XContentParser parser)
    • toString

      public String toString()
      toString in class Object
    • equals

      public boolean equals(Object obj)
      equals in class Object
    • hashCode

      public int hashCode()
      hashCode in class Object