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

Class TaskInfo

java.lang.Object

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

All Implemented Interfaces:

StreamableReader<TaskInfo>, Writeable<TaskInfo>, ToXContent

public class TaskInfo
extends Object
implements Writeable<TaskInfo>, ToXContent

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 streamable TaskInfo objects are used to represent snapshot information about currently running tasks.

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
TaskInfo(DiscoveryNode node, long id, String type, String action, String description, Task.Status status, long startTime, long runningTimeNanos, TaskId parentTaskId)
TaskInfo(StreamInput in)

Method Summary

Methods

Modifier and Type	Method and Description
String	getAction()
String	getDescription()
long	getId()
DiscoveryNode	getNode()
TaskId	getParentTaskId() Returns the parent task id
long	getRunningTimeNanos() Returns the task running time
long	getStartTime() Returns the task start time
Task.Status	getStatus() The status of the running task.
TaskId	getTaskId()
String	getType()
TaskInfo	readFrom(StreamInput in) Reads a copy of an object with the same type form the stream input The caller object remains unchanged.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out) Writes the current object into the output stream out

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TaskInfo

public TaskInfo(DiscoveryNode node,
        long id,
        String type,
        String action,
        String description,
        Task.Status status,
        long startTime,
        long runningTimeNanos,
        TaskId parentTaskId)

TaskInfo

public TaskInfo(StreamInput in)
         throws IOException

Throws:

IOException

Method Detail

getTaskId

public TaskId getTaskId()

getNode

public DiscoveryNode getNode()

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

getParentTaskId

public TaskId getParentTaskId()

Returns the parent task id

readFrom

public TaskInfo readFrom(StreamInput in)
                  throws IOException

Description copied from interface: StreamableReader

Reads a copy of an object with the same type form the stream input The caller object remains unchanged.

Specified by:

readFrom in interface StreamableReader<TaskInfo>

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Writes the current object into the output stream out

Specified by:

writeTo in interface Writeable<TaskInfo>

Throws:

IOException

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
                         ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException