com.netflix.conductor.common.metadata.tasks

Class TaskResult

java.lang.Object

com.netflix.conductor.common.metadata.tasks.TaskResult

public class TaskResult
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TaskResult.Status

Constructor Summary

Constructors

Constructor and Description
TaskResult()
TaskResult(Task task)

Method Summary

Modifier and Type	Method and Description
TaskResult	addOutputData(java.lang.String key, java.lang.Object value) Adds output
static TaskResult	complete()
static TaskResult	failed()
static TaskResult	failed(java.lang.String failureReason)
long	getCallbackAfterSeconds()
java.util.List<TaskExecLog>	getLogs()
java.util.Map<java.lang.String,java.lang.Object>	getOutputData()
java.lang.String	getReasonForIncompletion()
TaskResult.Status	getStatus()
java.lang.String	getTaskId()
java.lang.String	getWorkerId()
java.lang.String	getWorkflowInstanceId()
static TaskResult	inProgress()
TaskResult	log(java.lang.String log)
static TaskResult	newTaskResult(TaskResult.Status status)
void	setCallbackAfterSeconds(long callbackAfterSeconds) When set to non-zero values, the task remains in the queue for the specified seconds before sent back to the worker when polled.
void	setLogs(java.util.List<TaskExecLog> logs)
void	setOutputData(java.util.Map<java.lang.String,java.lang.Object> outputData)
void	setReasonForIncompletion(java.lang.String reasonForIncompletion)
void	setStatus(TaskResult.Status status)
void	setTaskId(java.lang.String taskId)
void	setWorkerId(java.lang.String workerId)
void	setWorkflowInstanceId(java.lang.String workflowInstanceId)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

TaskResult

public TaskResult(Task task)

TaskResult

public TaskResult()

Method Detail

getWorkflowInstanceId

public java.lang.String getWorkflowInstanceId()

Returns:

Workflow instance id for which the task result is produced

setWorkflowInstanceId

public void setWorkflowInstanceId(java.lang.String workflowInstanceId)

getTaskId

public java.lang.String getTaskId()

setTaskId

public void setTaskId(java.lang.String taskId)

getReasonForIncompletion

public java.lang.String getReasonForIncompletion()

setReasonForIncompletion

public void setReasonForIncompletion(java.lang.String reasonForIncompletion)

getCallbackAfterSeconds

public long getCallbackAfterSeconds()

setCallbackAfterSeconds

public void setCallbackAfterSeconds(long callbackAfterSeconds)

When set to non-zero values, the task remains in the queue for the specified seconds before sent back to the worker when polled. Useful for the long running task, where the task is updated as IN_PROGRESS and should not be polled out of the queue for a specified amount of time. (delayed queue implementation)

Parameters:

callbackAfterSeconds - Amount of time in seconds the task should be held in the queue before giving it to a polling worker.

getWorkerId

public java.lang.String getWorkerId()

setWorkerId

public void setWorkerId(java.lang.String workerId)

Parameters:

workerId - a free form string identifying the worker host. Could be hostname, IP Address or any other meaningful identifier that can help identify the host/process which executed the task, in case of troubleshooting.

getStatus

public TaskResult.Status getStatus()

Returns:

the status

setStatus

public void setStatus(TaskResult.Status status)

Parameters:

status - Status of the task

IN_PROGRESS: Use this for long running tasks, indicating the task is still in progress and should be checked again at a later time. e.g. the worker checks the status of the job in the DB, while the job is being executed by another process.

FAILED, COMPLETED: Terminal statuses for the task.

See Also:

setCallbackAfterSeconds(long)

getOutputData

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

setOutputData

public void setOutputData(java.util.Map<java.lang.String,java.lang.Object> outputData)

Parameters:

outputData - output data to be set for the task execution result

addOutputData

public TaskResult addOutputData(java.lang.String key,
                                java.lang.Object value)

Adds output

Parameters:

key - output field

value - value

Returns:

current instance

getLogs

public java.util.List<TaskExecLog> getLogs()

Returns:

Task execution logs

setLogs

public void setLogs(java.util.List<TaskExecLog> logs)

Parameters:

logs - Task execution logs

log

public TaskResult log(java.lang.String log)

Parameters:

log - Log line to be added

Returns:

Instance of TaskResult

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

complete

public static TaskResult complete()

failed

public static TaskResult failed()

failed

public static TaskResult failed(java.lang.String failureReason)

inProgress

public static TaskResult inProgress()

newTaskResult

public static TaskResult newTaskResult(TaskResult.Status status)