org.elasticsearch.tasks

Class Task

java.lang.Object

org.elasticsearch.tasks.Task

Direct Known Subclasses:

CancellableTask, ReplicationTask

public class Task
extends Object

Current task information

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Task.Status

Constructor Summary

Constructors

Constructor and Description
Task(long id, String type, String action, String description)
Task(long id, String type, String action, String description, TaskId parentTask)
Task(long id, String type, String action, String description, TaskId parentTask, long startTime, long startTimeNanos)

Method Summary

Methods

Modifier and Type	Method and Description
String	getAction() Returns task action
String	getDescription() Generates task description
long	getId() Returns task id
TaskId	getParentTaskId() Returns id of the parent task or NO_PARENT_ID if the task doesn't have any parent tasks
long	getStartTime() Returns the task start time
Task.Status	getStatus() Build a status for this task or null if this task doesn't have status.
String	getType() Returns task channel type (netty, transport, direct)
TaskInfo	taskInfo(DiscoveryNode node, boolean detailed) Build a version of the task status you can throw over the wire and back to the user.

Methods inherited from class java.lang.Object

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

Constructor Detail

Task

public Task(long id,
    String type,
    String action,
    String description)

Task

public Task(long id,
    String type,
    String action,
    String description,
    TaskId parentTask)

Task

public Task(long id,
    String type,
    String action,
    String description,
    TaskId parentTask,
    long startTime,
    long startTimeNanos)

Method Detail

taskInfo

public TaskInfo taskInfo(DiscoveryNode node,
                boolean detailed)

Build a version of the task status you can throw over the wire and back to the user.

Parameters:

node - the node this task is running on

detailed - should the information include detailed, potentially slow to generate data?

getId

public long getId()

Returns task id

getType

public String getType()

Returns task channel type (netty, transport, direct)

getAction

public String getAction()

Returns task action

getDescription

public String getDescription()

Generates task description

getStartTime

public long getStartTime()

Returns the task start time

getParentTaskId

public TaskId getParentTaskId()

Returns id of the parent task or NO_PARENT_ID if the task doesn't have any parent tasks

getStatus

public Task.Status getStatus()

Build a status for this task or null if this task doesn't have status. Since most tasks don't have status this defaults to returning null. While this can never perform IO it might be a costly operation, requiring collating lists of results, etc. So only use it if you need the value.