Package org.opensearch.task.commons.task

Class Task

java.lang.Object

org.opensearch.task.commons.task.Task

@ExperimentalApi
public class Task
extends Object

A Background Task to be run on Offline Node.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Task.Builder	Builder class for Task.

Constructor Summary

Constructors

Constructor	Description
Task(TaskId taskId, TaskStatus taskStatus, TaskParams params, TaskType taskType, long createdAt, long assignedAt, long startedAt, long completedAt, long lastHeartbeatAt, WorkerNode assignedNode)	Constructor for Task

Method Summary

Modifier and Type	Method	Description
long	getAssignedAt()	Get Task Assignment Time
WorkerNode	getAssignedNode()	Get Task Assigned Node
long	getCompletedAt()	Get Task Completion Time
long	getCreatedAt()	Get Task Creation Time
long	getLastHeartbeatAt()	Get Last Heartbeat Time
TaskParams	getParams()	Get TaskParams
long	getStartedAt()	Get Task Start Time
TaskId	getTaskId()	Get TaskId
TaskStatus	getTaskStatus()	Get TaskStatus
TaskType	getTaskType()	Get TaskType

Methods inherited from class java.lang.Object

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

Constructor Details

Task

public Task(TaskId taskId,
 TaskStatus taskStatus,
 TaskParams params,
 TaskType taskType,
 long createdAt,
 @Nullable
 long assignedAt,
 @Nullable
 long startedAt,
 @Nullable
 long completedAt,
 @Nullable
 long lastHeartbeatAt,
 @Nullable
 WorkerNode assignedNode)

Constructor for Task

Parameters:

taskId - Task identifier

taskStatus - Task status

params - Task Params

taskType - Task Type

createdAt - Timestamp at which the Task was created

assignedAt - Timestamp at which the Task was assigned to a worker

startedAt - Timestamp at which the Task was started execution on worker

completedAt - Timestamp at which the Task was either completed/failed/cancelled

lastHeartbeatAt - Timestamp at which last heartbeat was sent by the worker

assignedNode - Worker Node on which the Task is to be executed

Method Details

getTaskId

public TaskId getTaskId()

Get TaskId

Returns:

TaskId

getTaskStatus

public TaskStatus getTaskStatus()

Get TaskStatus

Returns:

TaskStatus

getParams

public TaskParams getParams()

Get TaskParams

Returns:

TaskParams

getTaskType

public TaskType getTaskType()

Get TaskType

Returns:

TaskType

getCreatedAt

public long getCreatedAt()

Get Task Creation Time

Returns:

createdAt

getAssignedAt

public long getAssignedAt()

Get Task Assignment Time

Returns:

assignedAt

getStartedAt

public long getStartedAt()

Get Task Start Time

Returns:

startedAt

getCompletedAt

public long getCompletedAt()

Get Task Completion Time

Returns:

completedAt

getLastHeartbeatAt

public long getLastHeartbeatAt()

Get Last Heartbeat Time

Returns:

lastHeartbeatAt

getAssignedNode

public WorkerNode getAssignedNode()

Get Task Assigned Node

Returns:

assignedNode