Package org.elasticsearch.tasks

Class TaskInfo

java.lang.Object

org.elasticsearch.tasks.TaskInfo

All Implemented Interfaces:

Writeable, org.elasticsearch.xcontent.ToXContent, org.elasticsearch.xcontent.ToXContentFragment

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

Nested Class Summary

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

org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.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 final org.elasticsearch.xcontent.ConstructingObjectParser<TaskInfo,Void>	PARSER

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static TaskInfo	fromXContent(org.elasticsearch.xcontent.XContentParser parser)
String	getAction()
String	getDescription()
Map<String,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()
String	getType()
int	hashCode()
boolean	isCancellable()	Returns true if the task supports cancellation
boolean	isCancelled()	Returns true if the task supports cancellation and has been cancelled
String	toString()
org.elasticsearch.xcontent.XContentBuilder	toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.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.xcontent.ToXContentFragment

isFragment

Field Details

PARSER

public static final org.elasticsearch.xcontent.ConstructingObjectParser<TaskInfo,Void> PARSER

Constructor Details

TaskInfo

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

TaskInfo

public TaskInfo(StreamInput in)
         throws IOException

Read from a stream.

Throws:

IOException

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

Throws:

IOException

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.xcontent.XContentBuilder toXContent(org.elasticsearch.xcontent.XContentBuilder builder,
 org.elasticsearch.xcontent.ToXContent.Params params)
                                                      throws IOException

Specified by:

toXContent in interface org.elasticsearch.xcontent.ToXContent

Throws:

IOException

fromXContent

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

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object