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

Class WorkflowDef

java.lang.Object
com.netflix.conductor.common.metadata.Auditable
com.netflix.conductor.common.metadata.workflow.WorkflowDef
public class WorkflowDef extends Auditable

  • Constructor Details

    • WorkflowDef

      public WorkflowDef()

  • Method Details

    • isEnforceSchema

      public boolean isEnforceSchema()

    • setEnforceSchema

      public void setEnforceSchema(boolean enforceSchema)

    • getName

      public String getName()
      Returns:
      the name

    • setName

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

    • getDescription

      public String getDescription()
      Returns:
      the description

    • setDescription

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

    • getTasks

      public List<WorkflowTask> getTasks()
      Returns:
      the tasks

    • setTasks

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

    • getInputParameters

      public List<String> getInputParameters()
      Returns:
      the inputParameters

    • setInputParameters

      public void setInputParameters(List<String> inputParameters)
      Parameters:
      inputParameters - the inputParameters to set

    • getOutputParameters

      public Map<String,Object> getOutputParameters()
      Returns:
      the outputParameters

    • setOutputParameters

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

    • getVersion

      public int getVersion()
      Returns:
      the version

    • getFailureWorkflow

      public String getFailureWorkflow()
      Returns:
      the failureWorkflow

    • setFailureWorkflow

      public void setFailureWorkflow(String failureWorkflow)
      Parameters:
      failureWorkflow - the failureWorkflow to set

    • setVersion

      public void setVersion(int version)
      Parameters:
      version - the version to set

    • isRestartable

      public boolean isRestartable()
      This method determines if the workflow is restartable or not
      Returns:
      true: if the workflow is restartable false: if the workflow is non restartable

    • setRestartable

      public void setRestartable(boolean restartable)
      This method is called only when the workflow definition is created
      Parameters:
      restartable - true: if the workflow is restartable false: if the workflow is non restartable

    • getSchemaVersion

      public int getSchemaVersion()
      Returns:
      the schemaVersion

    • setSchemaVersion

      public void setSchemaVersion(int schemaVersion)
      Parameters:
      schemaVersion - the schemaVersion to set

    • isWorkflowStatusListenerEnabled

      public boolean isWorkflowStatusListenerEnabled()
      Returns:
      true is workflow listener will be invoked when workflow gets into a terminal state

    • setWorkflowStatusListenerEnabled

      public void setWorkflowStatusListenerEnabled(boolean workflowStatusListenerEnabled)
      Specify if workflow listener is enabled to invoke a callback for completed or terminated workflows
      Parameters:
      workflowStatusListenerEnabled -

    • getOwnerEmail

      public String getOwnerEmail()
      Returns:
      the email of the owner of this workflow definition

    • setOwnerEmail

      public void setOwnerEmail(String ownerEmail)
      Parameters:
      ownerEmail - the owner email to set

    • getTimeoutPolicy

      public WorkflowDef.TimeoutPolicy getTimeoutPolicy()
      Returns:
      the timeoutPolicy

    • setTimeoutPolicy

      public void setTimeoutPolicy(WorkflowDef.TimeoutPolicy timeoutPolicy)
      Parameters:
      timeoutPolicy - the timeoutPolicy to set

    • getTimeoutSeconds

      public long getTimeoutSeconds()
      Returns:
      the time after which a workflow is deemed to have timed out

    • setTimeoutSeconds

      public void setTimeoutSeconds(long timeoutSeconds)
      Parameters:
      timeoutSeconds - the timeout in seconds to set

    • 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

    • getInputTemplate

      public Map<String,Object> getInputTemplate()

    • setInputTemplate

      public void setInputTemplate(Map<String,Object> inputTemplate)

    • key

      public String key()

    • getKey

      public static String getKey(String name, int version)

    • getWorkflowStatusListenerSink

      public String getWorkflowStatusListenerSink()

    • setWorkflowStatusListenerSink

      public void setWorkflowStatusListenerSink(String workflowStatusListenerSink)

    • getRateLimitConfig

      public RateLimitConfig getRateLimitConfig()

    • setRateLimitConfig

      public void setRateLimitConfig(RateLimitConfig rateLimitConfig)

    • getInputSchema

      public SchemaDef getInputSchema()

    • setInputSchema

      public void setInputSchema(SchemaDef inputSchema)

    • getOutputSchema

      public SchemaDef getOutputSchema()

    • setOutputSchema

      public void setOutputSchema(SchemaDef outputSchema)

    • containsType

      public boolean containsType(String taskType)

    • getNextTask

      public WorkflowTask getNextTask(String taskReferenceName)

    • getTaskByRefName

      public WorkflowTask getTaskByRefName(String taskReferenceName)

    • collectTasks

      public List<WorkflowTask> collectTasks()

    • equals

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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object