Package 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

  • Constructor Details

    • Workflow

      public Workflow()

  • Method Details

    • getIdempotencyKey

      public String getIdempotencyKey()

    • setIdempotencyKey

      public void setIdempotencyKey(String idempotencyKey)

    • getRateLimitKey

      public String getRateLimitKey()

    • setRateLimitKey

      public void setRateLimitKey(String rateLimitKey)

    • isRateLimited

      public boolean isRateLimited()

    • setRateLimited

      public void setRateLimited(boolean rateLimited)

    • getHistory

      public List<Workflow> getHistory()

    • setHistory

      public void setHistory(List<Workflow> history)

    • 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 String getWorkflowId()
      Returns:
      the workflowId

    • setWorkflowId

      public void setWorkflowId(String workflowId)
      Parameters:
      workflowId - the workflowId to set

    • getTasks

      public List<Task> getTasks()
      Returns:
      the tasks which are scheduled, in progress or completed.

    • setTasks

      public void setTasks(List<Task> tasks)
      Parameters:
      tasks - the tasks to set

    • getInput

      public Map<String,Object> getInput()
      Returns:
      the input

    • setInput

      public void setInput(Map<String,Object> input)
      Parameters:
      input - the input to set

    • getTaskToDomain

      public Map<String,String> getTaskToDomain()
      Returns:
      the task to domain map

    • setTaskToDomain

      public void setTaskToDomain(Map<String,String> taskToDomain)
      Parameters:
      taskToDomain - the task to domain map

    • getOutput

      public Map<String,Object> getOutput()
      Returns:
      the output

    • setOutput

      public void setOutput(Map<String,Object> output)
      Parameters:
      output - the output to set

    • getCorrelationId

      public String getCorrelationId()
      Returns:
      The correlation id used when starting the workflow

    • setCorrelationId

      public void setCorrelationId(String correlationId)
      Parameters:
      correlationId - the correlation id

    • getReRunFromWorkflowId

      public String getReRunFromWorkflowId()

    • setReRunFromWorkflowId

      public void setReRunFromWorkflowId(String reRunFromWorkflowId)

    • getReasonForIncompletion

      public String getReasonForIncompletion()

    • setReasonForIncompletion

      public void setReasonForIncompletion(String reasonForIncompletion)

    • getParentWorkflowId

      public String getParentWorkflowId()
      Returns:
      the parentWorkflowId

    • setParentWorkflowId

      public void setParentWorkflowId(String parentWorkflowId)
      Parameters:
      parentWorkflowId - the parentWorkflowId to set

    • getParentWorkflowTaskId

      public String getParentWorkflowTaskId()
      Returns:
      the parentWorkflowTaskId

    • setParentWorkflowTaskId

      public void setParentWorkflowTaskId(String parentWorkflowTaskId)
      Parameters:
      parentWorkflowTaskId - the parentWorkflowTaskId to set

    • getEvent

      public String getEvent()
      Returns:
      Name of the event that started the workflow

    • setEvent

      public void setEvent(String event)
      Parameters:
      event - Name of the event that started the workflow

    • getFailedReferenceTaskNames

      public Set<String> getFailedReferenceTaskNames()

    • setFailedReferenceTaskNames

      public void setFailedReferenceTaskNames(Set<String> failedReferenceTaskNames)

    • getWorkflowDefinition

      public WorkflowDef getWorkflowDefinition()

    • setWorkflowDefinition

      public void setWorkflowDefinition(WorkflowDef workflowDefinition)

    • getExternalInputPayloadStoragePath

      public String getExternalInputPayloadStoragePath()
      Returns:
      the external storage path of the workflow input payload

    • setExternalInputPayloadStoragePath

      public void setExternalInputPayloadStoragePath(String externalInputPayloadStoragePath)
      Parameters:
      externalInputPayloadStoragePath - the external storage path where the workflow input payload is stored

    • getExternalOutputPayloadStoragePath

      public 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 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(String externalOutputPayloadStoragePath)
      Parameters:
      externalOutputPayloadStoragePath - the external storage path where the workflow output payload is stored

    • getVariables

      public Map<String,Object> getVariables()
      Returns:
      the global workflow variables

    • setVariables

      public void setVariables(Map<String,Object> variables)
      Parameters:
      variables - the set of global workflow variables to set

    • 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

    • hasParent

      public boolean hasParent()

    • getFailedTaskNames

      public Set<String> getFailedTaskNames()

    • setFailedTaskNames

      public void setFailedTaskNames(Set<String> failedTaskNames)

    • getTaskByRefName

      public Task getTaskByRefName(String refName)

    • copy

      public Workflow copy()
      Returns:
      a deep copy of the workflow instance

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • toShortString

      public String toShortString()
      A string representation of all relevant fields that identify this workflow. Intended for use in log and other system generated messages.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object