io.serverlessworkflow.api

Class Workflow

java.lang.Object

io.serverlessworkflow.api.workflow.BaseWorkflow

io.serverlessworkflow.api.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 Summary

Constructors

Constructor and Description
Workflow() No args constructor for use in serialization
Workflow(String id, String name, String version, List<State> states)

Method Summary

Modifier and Type	Method and Description
List<String>	getAnnotations() List of helpful terms describing the workflows intended purpose, subject areas, or other important qualities
Auth	getAuth() Workflow Auth definitions
Constants	getConstants() Workflow constants definitions
DataInputSchema	getDataInputSchema() Workflow data input schema
String	getDescription() Workflow description
Errors	getErrors() Workflow error definitions
Events	getEvents() Workflow event definitions
String	getExpressionLang() Identifies the expression language used for workflow expressions.
List<Extension>	getExtensions() Workflow Extensions
Functions	getFunctions() Workflow function definitions
String	getId() Workflow unique identifier (Required)
String	getKey() Workflow Domain-specific identifier
Map<String,String>	getMetadata() Metadata
String	getName() Workflow name (Required)
Retries	getRetries() Workflow retry definitions
Secrets	getSecrets() Workflow secrets definitions
String	getSpecVersion() Serverless Workflow schema version
Start	getStart() State start definition
List<State>	getStates() State Definitions (Required)
TimeoutsDefinition	getTimeouts() Timeouts Definition
String	getVersion() Workflow version (Required)
boolean	isAutoRetries() If set to true, actions should automatically be retried on unchecked errors.
boolean	isKeepActive() If 'true', workflow instances is not terminated when there are no active execution paths.
void	setAnnotations(List<String> annotations) List of helpful terms describing the workflows intended purpose, subject areas, or other important qualities
void	setAuth(Auth auth) Workflow Auth definitions
void	setAutoRetries(boolean autoRetries) If set to true, actions should automatically be retried on unchecked errors.
void	setConstants(Constants constants) Workflow constants definitions
void	setDataInputSchema(DataInputSchema dataInputSchema) Workflow data input schema
void	setDescription(String description) Workflow description
void	setErrors(Errors errors) Workflow error definitions
void	setEvents(Events events) Workflow event definitions
void	setExpressionLang(String expressionLang) Identifies the expression language used for workflow expressions.
void	setExtensions(List<Extension> extensions) Workflow Extensions
void	setFunctions(Functions functions) Workflow function definitions
void	setId(String id) Workflow unique identifier (Required)
void	setKeepActive(boolean keepActive) If 'true', workflow instances is not terminated when there are no active execution paths.
void	setKey(String key) Workflow Domain-specific identifier
void	setMetadata(Map<String,String> metadata) Metadata
void	setName(String name) Workflow name (Required)
void	setRetries(Retries retries) Workflow retry definitions
void	setSecrets(Secrets secrets) Workflow secrets definitions
void	setSpecVersion(String specVersion) Serverless Workflow schema version
void	setStart(Start start) State start definition
void	setStates(List<State> states) State Definitions (Required)
void	setTimeouts(TimeoutsDefinition timeouts) Timeouts Definition
void	setVersion(String version) Workflow version (Required)
Workflow	withAnnotations(List<String> annotations)
Workflow	withAuth(Auth auth)
Workflow	withAutoRetries(boolean autoRetries)
Workflow	withConstants(Constants constants)
Workflow	withDataInputSchema(DataInputSchema dataInputSchema)
Workflow	withDescription(String description)
Workflow	withErrors(Errors errors)
Workflow	withEvents(Events events)
Workflow	withExpressionLang(String expressionLang)
Workflow	withExtensions(List<Extension> extensions)
Workflow	withFunctions(Functions functions)
Workflow	withId(String id)
Workflow	withKeepActive(boolean keepActive)
Workflow	withKey(String key)
Workflow	withMetadata(Map<String,String> metadata)
Workflow	withName(String name)
Workflow	withRetries(Retries retries)
Workflow	withSecrets(Secrets secrets)
Workflow	withSpecVersion(String specVersion)
Workflow	withStart(Start start)
Workflow	withStates(List<State> states)
Workflow	withTimeouts(TimeoutsDefinition timeouts)
Workflow	withVersion(String version)

Methods inherited from class io.serverlessworkflow.api.workflow.BaseWorkflow

fromSource, toJson, toYaml

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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)

withId

public Workflow withId(String id)

getKey

public String getKey()

Workflow Domain-specific identifier

setKey

public void setKey(String key)

Workflow Domain-specific identifier

withKey

public Workflow withKey(String key)

getName

public String getName()

Workflow name (Required)

setName

public void setName(String name)

Workflow name (Required)

withName

public Workflow withName(String name)

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)

withVersion

public Workflow withVersion(String version)

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

withAnnotations

public Workflow withAnnotations(List<String> annotations)

getDataInputSchema

public DataInputSchema getDataInputSchema()

Workflow data input schema

setDataInputSchema

public void setDataInputSchema(DataInputSchema dataInputSchema)

Workflow data input schema

withDataInputSchema

public Workflow withDataInputSchema(DataInputSchema dataInputSchema)

getStart

public Start getStart()

State start definition

setStart

public void setStart(Start start)

State start definition

withStart

public Workflow withStart(Start start)

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)

getMetadata

public Map<String,String> getMetadata()

Metadata

setMetadata

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

Metadata

withMetadata

public Workflow withMetadata(Map<String,String> metadata)

getEvents

public Events getEvents()

Workflow event definitions

setEvents

public void setEvents(Events events)

Workflow event definitions

withEvents

public Workflow withEvents(Events events)

getFunctions

public Functions getFunctions()

Workflow function definitions

setFunctions

public void setFunctions(Functions functions)

Workflow function definitions

withFunctions

public Workflow withFunctions(Functions functions)

getErrors

public Errors getErrors()

Workflow error definitions

setErrors

public void setErrors(Errors errors)

Workflow error definitions

withErrors

public Workflow withErrors(Errors errors)

getRetries

public Retries getRetries()

Workflow retry definitions

setRetries

public void setRetries(Retries retries)

Workflow retry definitions

withRetries

public Workflow withRetries(Retries retries)

getSecrets

public Secrets getSecrets()

Workflow secrets definitions

setSecrets

public void setSecrets(Secrets secrets)

Workflow secrets definitions

withSecrets

public Workflow withSecrets(Secrets secrets)

getConstants

public Constants getConstants()

Workflow constants definitions

setConstants

public void setConstants(Constants constants)

Workflow constants definitions

withConstants

public Workflow withConstants(Constants constants)

getTimeouts

public TimeoutsDefinition getTimeouts()

Timeouts Definition

setTimeouts

public void setTimeouts(TimeoutsDefinition timeouts)

Timeouts Definition

withTimeouts

public Workflow withTimeouts(TimeoutsDefinition timeouts)

getAuth

public Auth getAuth()

Workflow Auth definitions

setAuth

public void setAuth(Auth auth)

Workflow Auth definitions

withAuth

public Workflow withAuth(Auth auth)

getStates

public List<State> getStates()

State Definitions (Required)

setStates

public void setStates(List<State> states)

State Definitions (Required)

withStates

public Workflow withStates(List<State> states)

getExtensions

public List<Extension> getExtensions()

Workflow Extensions

setExtensions

public void setExtensions(List<Extension> extensions)

Workflow Extensions

withExtensions

public Workflow withExtensions(List<Extension> extensions)