Package com.netflix.conductor.common.metadata.workflow

Class WorkflowTask

java.lang.Object
com.netflix.conductor.common.metadata.workflow.WorkflowTask
public class WorkflowTask extends Object
This is the task definition definied as part of the WorkflowDef. The tasks definied in the Workflow definition are saved as part of WorkflowDef.getTasks()

  • Constructor Details

    • WorkflowTask

      public WorkflowTask()

  • Method Details

    • getName

      public String getName()
      Returns:
      the name

    • setName

      public void setName(String name)
      Parameters:
      name - the name to set

    • getTaskReferenceName

      public String getTaskReferenceName()
      Returns:
      the taskReferenceName

    • setTaskReferenceName

      public void setTaskReferenceName(String taskReferenceName)
      Parameters:
      taskReferenceName - the taskReferenceName to set

    • getDescription

      public String getDescription()
      Returns:
      the description

    • setDescription

      public void setDescription(String description)
      Parameters:
      description - the description to set

    • getInputParameters

      public Map<String,Object> getInputParameters()
      Returns:
      the inputParameters

    • setInputParameters

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

    • getType

      public String getType()
      Returns:
      the type

    • setWorkflowTaskType

      public void setWorkflowTaskType(TaskType type)

    • setType

      public void setType(String type)
      Parameters:
      type - the type to set

    • getDecisionCases

      public Map<String,List<WorkflowTask>> getDecisionCases()
      Returns:
      the decisionCases

    • setDecisionCases

      public void setDecisionCases(Map<String,List<WorkflowTask>> decisionCases)
      Parameters:
      decisionCases - the decisionCases to set

    • getDefaultCase

      public List<WorkflowTask> getDefaultCase()
      Returns:
      the defaultCase

    • setDefaultCase

      public void setDefaultCase(List<WorkflowTask> defaultCase)
      Parameters:
      defaultCase - the defaultCase to set

    • getForkTasks

      public List<List<WorkflowTask>> getForkTasks()
      Returns:
      the forkTasks

    • setForkTasks

      public void setForkTasks(List<List<WorkflowTask>> forkTasks)
      Parameters:
      forkTasks - the forkTasks to set

    • getStartDelay

      public int getStartDelay()
      Returns:
      the startDelay in seconds

    • setStartDelay

      public void setStartDelay(int startDelay)
      Parameters:
      startDelay - the startDelay to set

    • getRetryCount

      public Integer getRetryCount()
      Returns:
      the retryCount

    • setRetryCount

      public void setRetryCount(Integer retryCount)
      Parameters:
      retryCount - the retryCount to set

    • getDynamicTaskNameParam

      public String getDynamicTaskNameParam()
      Returns:
      the dynamicTaskNameParam

    • setDynamicTaskNameParam

      public void setDynamicTaskNameParam(String dynamicTaskNameParam)
      Parameters:
      dynamicTaskNameParam - the dynamicTaskNameParam to set to be used by DYNAMIC tasks

    • getCaseValueParam

      @Deprecated public String getCaseValueParam()
      Deprecated.
      Use getEvaluatorType() and getExpression() combination.
      Returns:
      the caseValueParam

    • getDynamicForkJoinTasksParam

      @Deprecated public String getDynamicForkJoinTasksParam()
      Deprecated.

    • setDynamicForkJoinTasksParam

      @Deprecated public void setDynamicForkJoinTasksParam(String dynamicForkJoinTasksParam)
      Deprecated.

    • getDynamicForkTasksParam

      public String getDynamicForkTasksParam()

    • setDynamicForkTasksParam

      public void setDynamicForkTasksParam(String dynamicForkTasksParam)

    • getDynamicForkTasksInputParamName

      public String getDynamicForkTasksInputParamName()

    • setDynamicForkTasksInputParamName

      public void setDynamicForkTasksInputParamName(String dynamicForkTasksInputParamName)

    • setCaseValueParam

      @Deprecated public void setCaseValueParam(String caseValueParam)
      Deprecated.
      Use getEvaluatorType() and getExpression() combination.
      Parameters:
      caseValueParam - the caseValueParam to set

    • getCaseExpression

      @Deprecated public String getCaseExpression()
      Deprecated.
      Use getEvaluatorType() and getExpression() combination.
      Returns:
      A javascript expression for decision cases. The result should be a scalar value that is used to decide the case branches.
      See Also:

    • setCaseExpression

      @Deprecated public void setCaseExpression(String caseExpression)
      Deprecated.
      Use getEvaluatorType() and getExpression() combination.
      Parameters:
      caseExpression - A javascript expression for decision cases. The result should be a scalar value that is used to decide the case branches.

    • getScriptExpression

      public String getScriptExpression()

    • setScriptExpression

      public void setScriptExpression(String expression)

    • getCacheConfig

      public WorkflowTask.CacheConfig getCacheConfig()

    • setCacheConfig

      public void setCacheConfig(WorkflowTask.CacheConfig cacheConfig)

    • getSubWorkflowParam

      public SubWorkflowParams getSubWorkflowParam()
      Returns:
      the subWorkflow

    • setSubWorkflowParam

      public void setSubWorkflowParam(SubWorkflowParams subWorkflow)
      Parameters:
      subWorkflow - the subWorkflowParam to set

    • getJoinOn

      public List<String> getJoinOn()
      Returns:
      the joinOn

    • setJoinOn

      public void setJoinOn(List<String> joinOn)
      Parameters:
      joinOn - the joinOn to set

    • getLoopCondition

      public String getLoopCondition()
      Returns:
      the loopCondition

    • setLoopCondition

      public void setLoopCondition(String loopCondition)
      Parameters:
      loopCondition - the expression to set

    • getLoopOver

      public List<WorkflowTask> getLoopOver()
      Returns:
      the loopOver

    • setLoopOver

      public void setLoopOver(List<WorkflowTask> loopOver)
      Parameters:
      loopOver - the loopOver to set

    • getSink

      public String getSink()
      Returns:
      Sink value for the EVENT type of task

    • setSink

      public void setSink(String sink)
      Parameters:
      sink - Name of the sink

    • isAsyncComplete

      public Boolean isAsyncComplete()
      Returns:
      whether wait for an external event to complete the task, for EVENT and HTTP tasks

    • setAsyncComplete

      public void setAsyncComplete(Boolean asyncComplete)

    • isOptional

      public boolean isOptional()
      Returns:
      If the task is optional. When set to true, the workflow execution continues even when the task is in failed status.

    • getTaskDefinition

      public TaskDef getTaskDefinition()
      Returns:
      Task definition associated to the Workflow Task

    • setTaskDefinition

      public void setTaskDefinition(TaskDef taskDefinition)
      Parameters:
      taskDefinition - Task definition

    • setOptional

      public void setOptional(boolean optional)
      Parameters:
      optional - when set to true, the task is marked as optional

    • getRateLimited

      public Boolean getRateLimited()

    • setRateLimited

      public void setRateLimited(Boolean rateLimited)

    • isRateLimited

      public Boolean isRateLimited()

    • getDefaultExclusiveJoinTask

      public List<String> getDefaultExclusiveJoinTask()

    • setDefaultExclusiveJoinTask

      public void setDefaultExclusiveJoinTask(List<String> defaultExclusiveJoinTask)

    • getEvaluatorType

      public String getEvaluatorType()
      Returns:
      the evaluatorType

    • setEvaluatorType

      public void setEvaluatorType(String evaluatorType)
      Parameters:
      evaluatorType - the evaluatorType to set

    • getExpression

      public String getExpression()
      Returns:
      An evaluation expression for switch cases evaluated by corresponding evaluator. The result should be a scalar value that is used to decide the case branches.
      See Also:

    • setExpression

      public void setExpression(String expression)
      Parameters:
      expression - the expression to set

    • getJoinStatus

      public String getJoinStatus()

    • setJoinStatus

      public void setJoinStatus(String joinStatus)

    • isPermissive

      public boolean isPermissive()

    • setPermissive

      public void setPermissive(boolean permissive)

    • collectTasks

      public List<WorkflowTask> collectTasks()

    • next

      public WorkflowTask next(String taskReferenceName, WorkflowTask parent)

    • has

      public boolean has(String taskReferenceName)

    • get

      public WorkflowTask get(String taskReferenceName)

    • getOnStateChange

      public Map<String,List<StateChangeEvent>> getOnStateChange()

    • setOnStateChange

      public void setOnStateChange(Map<String,List<StateChangeEvent>> onStateChange)

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • equals

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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object