Package io.serverlessworkflow.api

Class Workflow

  • All Implemented Interfaces:
    Serializable
    public class Workflow
extends BaseWorkflow
implements Serializable
    Serverless Workflow is a vendor-neutral specification for defining the model of workflows responsible for orchestrating event-driven serverless applications.
    See Also:
    Serialized Form

    • Constructor Detail

      • Workflow

        public Workflow()
        No args constructor for use in serialization

      • Workflow

        public Workflow​(String id,
                String name,
                String version,
                List<State> states)
        Parameters:
        name -
        id -
        version -
        states -

    • Method Detail

      • getId

        public String getId()
        Workflow unique identifier (Required)

      • setId

        public void setId​(String id)
        Workflow unique identifier (Required)

      • getName

        public String getName()
        Workflow name (Required)

      • setName

        public void setName​(String name)
        Workflow name (Required)

      • getDescription

        public String getDescription()
        Workflow description

      • setDescription

        public void setDescription​(String description)
        Workflow description

      • withDescription

        public Workflow withDescription​(String description)

      • getVersion

        public String getVersion()
        Workflow version (Required)

      • setVersion

        public void setVersion​(String version)
        Workflow version (Required)

      • getAnnotations

        public List<String> getAnnotations()
        List of helpful terms describing the workflows intended purpose, subject areas, or other important qualities

      • setAnnotations

        public void setAnnotations​(List<String> annotations)
        List of helpful terms describing the workflows intended purpose, subject areas, or other important qualities

      • getDataInputSchema

        public DataInputSchema getDataInputSchema()
        Workflow data input schema

      • setDataInputSchema

        public void setDataInputSchema​(DataInputSchema dataInputSchema)
        Workflow data input schema

      • getStart

        public Start getStart()
        State start definition

      • setStart

        public void setStart​(Start start)
        State start definition

      • getSpecVersion

        public String getSpecVersion()
        Serverless Workflow schema version

      • setSpecVersion

        public void setSpecVersion​(String specVersion)
        Serverless Workflow schema version

      • withSpecVersion

        public Workflow withSpecVersion​(String specVersion)

      • getExpressionLang

        public String getExpressionLang()
        Identifies the expression language used for workflow expressions. Default is 'jq'

      • setExpressionLang

        public void setExpressionLang​(String expressionLang)
        Identifies the expression language used for workflow expressions. Default is 'jq'

      • withExpressionLang

        public Workflow withExpressionLang​(String expressionLang)

      • isKeepActive

        public boolean isKeepActive()
        If 'true', workflow instances is not terminated when there are no active execution paths. Instance can be terminated via 'terminate end definition' or reaching defined 'execTimeout'

      • setKeepActive

        public void setKeepActive​(boolean keepActive)
        If 'true', workflow instances is not terminated when there are no active execution paths. Instance can be terminated via 'terminate end definition' or reaching defined 'execTimeout'

      • withKeepActive

        public Workflow withKeepActive​(boolean keepActive)

      • isAutoRetries

        public boolean isAutoRetries()
        If set to true, actions should automatically be retried on unchecked errors. Default is false

      • setAutoRetries

        public void setAutoRetries​(boolean autoRetries)
        If set to true, actions should automatically be retried on unchecked errors. Default is false

      • withAutoRetries

        public Workflow withAutoRetries​(boolean autoRetries)

      • setMetadata

        public void setMetadata​(Map<String,​String> metadata)
        Metadata

      • getEvents

        public Events getEvents()
        Workflow event definitions

      • setEvents

        public void setEvents​(Events events)
        Workflow event definitions

      • getFunctions

        public Functions getFunctions()
        Workflow function definitions

      • setFunctions

        public void setFunctions​(Functions functions)
        Workflow function definitions

      • getErrors

        public Errors getErrors()
        Workflow error definitions

      • setErrors

        public void setErrors​(Errors errors)
        Workflow error definitions

      • getRetries

        public Retries getRetries()
        Workflow retry definitions

      • setRetries

        public void setRetries​(Retries retries)
        Workflow retry definitions

      • getSecrets

        public Secrets getSecrets()
        Workflow secrets definitions

      • setSecrets

        public void setSecrets​(Secrets secrets)
        Workflow secrets definitions

      • getConstants

        public Constants getConstants()
        Workflow constants definitions

      • setConstants

        public void setConstants​(Constants constants)
        Workflow constants definitions

      • setTimeouts

        public void setTimeouts​(TimeoutsDefinition timeouts)
        Timeouts Definition

      • setAuth

        public void setAuth​(AuthDefinition auth)
        Auth Definition

      • getStates

        public List<State> getStates()
        State Definitions (Required)

      • setStates

        public void setStates​(List<State> states)
        State Definitions (Required)

      • getExtensions

        public List<Extension> getExtensions()
        Workflow Extensions

      • setExtensions

        public void setExtensions​(List<Extension> extensions)
        Workflow Extensions