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)

      • getSchemaVersion

        public String getSchemaVersion()
        Serverless Workflow schema version

      • setSchemaVersion

        public void setSchemaVersion​(String schemaVersion)
        Serverless Workflow schema version

      • withSchemaVersion

        public Workflow withSchemaVersion​(String schemaVersion)

      • getDataInputSchema

        public String getDataInputSchema()
        URI to JSON Schema that workflow data input adheres to

      • setDataInputSchema

        public void setDataInputSchema​(String dataInputSchema)
        URI to JSON Schema that workflow data input adheres to

      • withDataInputSchema

        public Workflow withDataInputSchema​(String dataInputSchema)

      • getDataOutputSchema

        public String getDataOutputSchema()
        URI to JSON Schema that workflow data output adheres to

      • setDataOutputSchema

        public void setDataOutputSchema​(String dataOutputSchema)
        URI to JSON Schema that workflow data output adheres to

      • withDataOutputSchema

        public Workflow withDataOutputSchema​(String dataOutputSchema)

      • 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

      • getRetries

        public Retries getRetries()
        Workflow retry definitions

      • setRetries

        public void setRetries​(Retries retries)
        Workflow retry definitions

      • 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