Package org.elasticsearch.tasks

Class TaskInfo

java.lang.Object

org.elasticsearch.tasks.TaskInfo

All Implemented Interfaces:

Writeable, ToXContent, ToXContentFragment

public final class TaskInfo
extends java.lang.Object
implements Writeable, 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 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

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static ConstructingObjectParser<TaskInfo,java.lang.Void>	PARSER

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
TaskInfo(StreamInput in)	Read from a stream.
TaskInfo(TaskId taskId, java.lang.String type, java.lang.String action, java.lang.String description, Task.Status status, long startTime, long runningTimeNanos, boolean cancellable, TaskId parentTaskId, java.util.Map<java.lang.String,java.lang.String> headers)

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
java.lang.String	getAction()
java.lang.String	getDescription()
java.util.Map<java.lang.String,java.lang.String>	getHeaders()	Returns the task headers
long	getId()
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()
java.lang.String	getType()
int	hashCode()
boolean	isCancellable()	Returns true if the task supports cancellation
java.lang.String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentFragment

isFragment

Field Detail

PARSER

public static final ConstructingObjectParser<TaskInfo,java.lang.Void> PARSER

Constructor Detail

TaskInfo

public TaskInfo(TaskId taskId,
                java.lang.String type,
                java.lang.String action,
                java.lang.String description,
                Task.Status status,
                long startTime,
                long runningTimeNanos,
                boolean cancellable,
                TaskId parentTaskId,
                java.util.Map<java.lang.String,java.lang.String> headers)

TaskInfo

public TaskInfo(StreamInput in)
         throws java.io.IOException

Read from a stream.

Throws:

java.io.IOException

Method Detail

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

Throws:

java.io.IOException

getTaskId

public TaskId getTaskId()

getId

public long getId()

getType

public java.lang.String getType()

getAction

public java.lang.String getAction()

getDescription

public java.lang.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

getParentTaskId

public TaskId getParentTaskId()

Returns the parent task id

getHeaders

public java.util.Map<java.lang.String,java.lang.String> getHeaders()

Returns the task headers

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object