com.netflix.conductor.common.run

Class Workflow

java.lang.Object

com.netflix.conductor.common.metadata.Auditable

com.netflix.conductor.common.run.Workflow

public class Workflow
extends Auditable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Workflow.WorkflowStatus

Constructor Summary

Constructors

Constructor and Description
Workflow()

Method Summary

Modifier and Type	Method and Description
Workflow	copy()
boolean	equals(java.lang.Object o)
java.lang.String	getCorrelationId()
long	getEndTime()
java.lang.String	getEvent()
java.lang.String	getExternalInputPayloadStoragePath()
java.lang.String	getExternalOutputPayloadStoragePath()
java.util.Set<java.lang.String>	getFailedReferenceTaskNames()
java.util.Map<java.lang.String,java.lang.Object>	getInput()
long	getLastRetriedTime() Captures the last time the workflow was retried
java.util.Map<java.lang.String,java.lang.Object>	getOutput()
java.lang.String	getParentWorkflowId()
java.lang.String	getParentWorkflowTaskId()
int	getPriority()
java.lang.String	getReasonForIncompletion()
java.lang.String	getReRunFromWorkflowId()
int	getSchemaVersion()
long	getStartTime()
Workflow.WorkflowStatus	getStatus()
Task	getTaskByRefName(java.lang.String refName)
java.util.List<Task>	getTasks()
java.util.Map<java.lang.String,java.lang.String>	getTaskToDomain()
java.util.Map<java.lang.String,java.lang.Object>	getVariables()
int	getVersion() Deprecated.
WorkflowDef	getWorkflowDefinition()
java.lang.String	getWorkflowId()
java.lang.String	getWorkflowName() Convenience method for accessing the workflow definition name.
java.lang.String	getWorkflowType() Deprecated.
int	getWorkflowVersion() Convenience method for accessing the workflow definition version.
int	hashCode()
void	setCorrelationId(java.lang.String correlationId)
void	setEndTime(long endTime)
void	setEvent(java.lang.String event)
void	setExternalInputPayloadStoragePath(java.lang.String externalInputPayloadStoragePath)
void	setExternalOutputPayloadStoragePath(java.lang.String externalOutputPayloadStoragePath)
void	setFailedReferenceTaskNames(java.util.Set<java.lang.String> failedReferenceTaskNames)
void	setInput(java.util.Map<java.lang.String,java.lang.Object> input)
void	setLastRetriedTime(long lastRetriedTime)
void	setOutput(java.util.Map<java.lang.String,java.lang.Object> output)
void	setParentWorkflowId(java.lang.String parentWorkflowId)
void	setParentWorkflowTaskId(java.lang.String parentWorkflowTaskId)
void	setPriority(int priority)
void	setReasonForIncompletion(java.lang.String reasonForIncompletion)
void	setReRunFromWorkflowId(java.lang.String reRunFromWorkflowId)
void	setSchemaVersion(int schemaVersion) Deprecated.
void	setStartTime(long startTime)
void	setStatus(Workflow.WorkflowStatus status)
void	setTasks(java.util.List<Task> tasks)
void	setTaskToDomain(java.util.Map<java.lang.String,java.lang.String> taskToDomain)
void	setVariables(java.util.Map<java.lang.String,java.lang.Object> vars)
void	setVersion(int version) Deprecated.
void	setWorkflowDefinition(WorkflowDef workflowDefinition)
void	setWorkflowId(java.lang.String workflowId)
void	setWorkflowType(java.lang.String workflowType) Deprecated.
java.lang.String	toString()

Methods inherited from class com.netflix.conductor.common.metadata.Auditable

getCreatedBy, getCreateTime, getOwnerApp, getUpdatedBy, getUpdateTime, setCreatedBy, setCreateTime, setOwnerApp, setUpdatedBy, setUpdateTime

Methods inherited from class java.lang.Object

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

Constructor Detail

Workflow

public Workflow()

Method Detail

getStatus

public Workflow.WorkflowStatus getStatus()

Returns:

the status

setStatus

public void setStatus(Workflow.WorkflowStatus status)

Parameters:

status - the status to set

getStartTime

public long getStartTime()

Returns:

the startTime

setStartTime

public void setStartTime(long startTime)

Parameters:

startTime - the startTime to set

getEndTime

public long getEndTime()

Returns:

the endTime

setEndTime

public void setEndTime(long endTime)

Parameters:

endTime - the endTime to set

getWorkflowId

public java.lang.String getWorkflowId()

Returns:

the workflowId

setWorkflowId

public void setWorkflowId(java.lang.String workflowId)

Parameters:

workflowId - the workflowId to set

getTasks

public java.util.List<Task> getTasks()

Returns:

the tasks which are scheduled, in progress or completed.

setTasks

public void setTasks(java.util.List<Task> tasks)

Parameters:

tasks - the tasks to set

getInput

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

Returns:

the input

setInput

public void setInput(java.util.Map<java.lang.String,java.lang.Object> input)

Parameters:

input - the input to set

getVariables

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

Returns:

the global workflow variables

setVariables

public void setVariables(java.util.Map<java.lang.String,java.lang.Object> vars)

Parameters:

vars - the set of global workflow variables to set

getTaskToDomain

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

Returns:

the task to domain map

setTaskToDomain

public void setTaskToDomain(java.util.Map<java.lang.String,java.lang.String> taskToDomain)

Parameters:

taskToDomain - the task to domain map

getOutput

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

Returns:

the output

setOutput

public void setOutput(java.util.Map<java.lang.String,java.lang.Object> output)

Parameters:

output - the output to set

getCorrelationId

public java.lang.String getCorrelationId()

Returns:

The correlation id used when starting the workflow

setCorrelationId

public void setCorrelationId(java.lang.String correlationId)

Parameters:

correlationId - the correlation id

getWorkflowType

@Deprecated
public java.lang.String getWorkflowType()

Deprecated.

Returns:

Workflow Type / Definition

setWorkflowType

@Deprecated
public void setWorkflowType(java.lang.String workflowType)

Deprecated.

Parameters:

workflowType - Workflow type

getVersion

@Deprecated
public int getVersion()

Deprecated.

Returns:

the version

setVersion

@Deprecated
public void setVersion(int version)

Deprecated.

Parameters:

version - the version to set

getReRunFromWorkflowId

public java.lang.String getReRunFromWorkflowId()

setReRunFromWorkflowId

public void setReRunFromWorkflowId(java.lang.String reRunFromWorkflowId)

getReasonForIncompletion

public java.lang.String getReasonForIncompletion()

setReasonForIncompletion

public void setReasonForIncompletion(java.lang.String reasonForIncompletion)

getParentWorkflowId

public java.lang.String getParentWorkflowId()

Returns:

the parentWorkflowId

setParentWorkflowId

public void setParentWorkflowId(java.lang.String parentWorkflowId)

Parameters:

parentWorkflowId - the parentWorkflowId to set

getParentWorkflowTaskId

public java.lang.String getParentWorkflowTaskId()

Returns:

the parentWorkflowTaskId

setParentWorkflowTaskId

public void setParentWorkflowTaskId(java.lang.String parentWorkflowTaskId)

Parameters:

parentWorkflowTaskId - the parentWorkflowTaskId to set

getSchemaVersion

public int getSchemaVersion()

Returns:

the schemaVersion Version of the schema for the workflow definition

setSchemaVersion

@Deprecated
public void setSchemaVersion(int schemaVersion)

Deprecated.

Parameters:

schemaVersion - the schemaVersion to set

getEvent

public java.lang.String getEvent()

Returns:

Name of the event that started the workflow

setEvent

public void setEvent(java.lang.String event)

Parameters:

event - Name of the event that started the workflow

getFailedReferenceTaskNames

public java.util.Set<java.lang.String> getFailedReferenceTaskNames()

setFailedReferenceTaskNames

public void setFailedReferenceTaskNames(java.util.Set<java.lang.String> failedReferenceTaskNames)

getWorkflowDefinition

public WorkflowDef getWorkflowDefinition()

setWorkflowDefinition

public void setWorkflowDefinition(WorkflowDef workflowDefinition)

getExternalInputPayloadStoragePath

public java.lang.String getExternalInputPayloadStoragePath()

Returns:

the external storage path of the workflow input payload

setExternalInputPayloadStoragePath

public void setExternalInputPayloadStoragePath(java.lang.String externalInputPayloadStoragePath)

Parameters:

externalInputPayloadStoragePath - the external storage path where the workflow input payload is stored

getExternalOutputPayloadStoragePath

public java.lang.String getExternalOutputPayloadStoragePath()

Returns:

the external storage path of the workflow output payload

getPriority

public int getPriority()

Returns:

the priority to define on tasks

setPriority

public void setPriority(int priority)

Parameters:

priority - priority of tasks (between 0 and 99)

getWorkflowName

public java.lang.String getWorkflowName()

Convenience method for accessing the workflow definition name.

Returns:

the workflow definition name.

getWorkflowVersion

public int getWorkflowVersion()

Convenience method for accessing the workflow definition version.

Returns:

the workflow definition version.

setExternalOutputPayloadStoragePath

public void setExternalOutputPayloadStoragePath(java.lang.String externalOutputPayloadStoragePath)

Parameters:

externalOutputPayloadStoragePath - the external storage path where the workflow output payload is stored

getLastRetriedTime

public long getLastRetriedTime()

Captures the last time the workflow was retried

Returns:

the last retried time of the workflow

setLastRetriedTime

public void setLastRetriedTime(long lastRetriedTime)

Parameters:

lastRetriedTime - time in milliseconds when the workflow is retried

getTaskByRefName

public Task getTaskByRefName(java.lang.String refName)

copy

public Workflow copy()

Returns:

a deep copy of the workflow instance

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object