Serialized Form

Package io.serverlessworkflow.api

Class io.serverlessworkflow.api.Workflow extends BaseWorkflow implements Serializable

serialVersionUID:

2993506088471188589L

Serialized Fields

dataInputSchema

String dataInputSchema

URI to JSON Schema that workflow data input adheres to

dataOutputSchema

String dataOutputSchema

URI to JSON Schema that workflow data output adheres to

description

String description

Workflow description

events

@Valid Events events

Workflow event definitions

extensions

@Valid List<Extension> extensions

Workflow Extensions

functions

@Valid Functions functions

Workflow function definitions

id

String id

Workflow unique identifier (Required)

metadata

@Valid Map<String,String> metadata

Metadata

name

String name

Workflow name (Required)

retries

@Valid Retries retries

Workflow retry definitions

schemaVersion

String schemaVersion

Serverless Workflow schema version

states

@Valid @NotNull List<State> states

State Definitions (Required)

version

String version

Workflow version (Required)

Package io.serverlessworkflow.api.actions

Class io.serverlessworkflow.api.actions.Action extends Object implements Serializable

serialVersionUID:

-3320226187272802466L

Serialized Fields

actionDataFilter

@Valid ActionDataFilter actionDataFilter

eventRef

@Valid EventRef eventRef

Event References

functionRef

@Valid FunctionRef functionRef

name

String name

Unique action definition name

timeout

String timeout

Time period to wait for function execution to complete

Package io.serverlessworkflow.api.branches

Class io.serverlessworkflow.api.branches.Branch extends Object implements Serializable

serialVersionUID:

4985479487532847747L

Serialized Fields

actions

@Valid List<Action> actions

Actions to be executed in this branch

name

String name

Branch name

workflowId

String workflowId

Unique Id of a workflow to be executed in this branch

Package io.serverlessworkflow.api.correlation

Class io.serverlessworkflow.api.correlation.CorrelationDef extends Object implements Serializable

serialVersionUID:

-1976462035232738783L

Serialized Fields

contextAttributeName

@Size(min=1) @NotNull String contextAttributeName

CloudEvent Extension Context Attribute name (Required)

contextAttributeValue

@Size(min=1) String contextAttributeValue

CloudEvent Extension Context Attribute value

Package io.serverlessworkflow.api.cron

Class io.serverlessworkflow.api.cron.Cron extends Object implements Serializable

serialVersionUID:

-5870647120971471707L

Serialized Fields

expression

@NotNull String expression

Repeating interval (cron expression) describing when the workflow instance should be created (Required)

validUntil

String validUntil

Specific date and time (ISO 8601 format) when the cron expression invocation is no longer valid

Package io.serverlessworkflow.api.defaultdef

Class io.serverlessworkflow.api.defaultdef.DefaultDefinition extends Object implements Serializable

serialVersionUID:

-8926463396946651858L

Serialized Fields

end

@Valid End end

State end definition

transition

@Valid Transition transition

Package io.serverlessworkflow.api.deserializers

Class io.serverlessworkflow.api.deserializers.DefaultStateTypeDeserializer extends com.fasterxml.jackson.databind.deser.std.StdDeserializer<DefaultState.Type> implements Serializable

serialVersionUID:

510L

Serialized Fields

context

WorkflowPropertySource context

Class io.serverlessworkflow.api.deserializers.EndDefinitionDeserializer extends com.fasterxml.jackson.databind.deser.std.StdDeserializer<End> implements Serializable

serialVersionUID:

510L

Serialized Fields

context

WorkflowPropertySource context

Class io.serverlessworkflow.api.deserializers.EventDefinitionKindDeserializer extends com.fasterxml.jackson.databind.deser.std.StdDeserializer<EventDefinition.Kind> implements Serializable

serialVersionUID:

510L

Serialized Fields

context

WorkflowPropertySource context

Class io.serverlessworkflow.api.deserializers.EventsDeserializer extends com.fasterxml.jackson.databind.deser.std.StdDeserializer<Events> implements Serializable

serialVersionUID:

510L

Serialized Fields

context

WorkflowPropertySource context

Class io.serverlessworkflow.api.deserializers.ExtensionDeserializer extends com.fasterxml.jackson.databind.deser.std.StdDeserializer<Extension> implements Serializable

Serialized Fields

context

WorkflowPropertySource context

extensionsMap

Map<String,Class<? extends Extension>> extensionsMap

Class io.serverlessworkflow.api.deserializers.FunctionsDeserializer extends com.fasterxml.jackson.databind.deser.std.StdDeserializer<Functions> implements Serializable

serialVersionUID:

510L

Serialized Fields

context

WorkflowPropertySource context

Class io.serverlessworkflow.api.deserializers.OnEventsActionModeDeserializer extends com.fasterxml.jackson.databind.deser.std.StdDeserializer<OnEvents.ActionMode> implements Serializable

serialVersionUID:

510L

Serialized Fields

context

WorkflowPropertySource context

Class io.serverlessworkflow.api.deserializers.OperationStateActionModeDeserializer extends com.fasterxml.jackson.databind.deser.std.StdDeserializer<OperationState.ActionMode> implements Serializable

serialVersionUID:

510L

Serialized Fields

context

WorkflowPropertySource context

Class io.serverlessworkflow.api.deserializers.ParallelStateCompletionTypeDeserializer extends com.fasterxml.jackson.databind.deser.std.StdDeserializer<ParallelState.CompletionType> implements Serializable

serialVersionUID:

510L

Serialized Fields

context

WorkflowPropertySource context

Class io.serverlessworkflow.api.deserializers.RetriesDeserializer extends com.fasterxml.jackson.databind.deser.std.StdDeserializer<Retries> implements Serializable

serialVersionUID:

510L

Serialized Fields

context

WorkflowPropertySource context

Class io.serverlessworkflow.api.deserializers.ScheduleDirectInvokeDeserializer extends com.fasterxml.jackson.databind.deser.std.StdDeserializer<Schedule.DirectInvoke> implements Serializable

serialVersionUID:

510L

Serialized Fields

context

WorkflowPropertySource context

Class io.serverlessworkflow.api.deserializers.StartDefinitionDeserializer extends com.fasterxml.jackson.databind.deser.std.StdDeserializer<Start> implements Serializable

serialVersionUID:

510L

Serialized Fields

context

WorkflowPropertySource context

Class io.serverlessworkflow.api.deserializers.StateDeserializer extends com.fasterxml.jackson.databind.deser.std.StdDeserializer<State> implements Serializable

serialVersionUID:

510L

Serialized Fields

context

WorkflowPropertySource context

Class io.serverlessworkflow.api.deserializers.StringValueDeserializer extends com.fasterxml.jackson.databind.deser.std.StdDeserializer<String> implements Serializable

serialVersionUID:

510L

Serialized Fields

context

WorkflowPropertySource context

Package io.serverlessworkflow.api.end

Class io.serverlessworkflow.api.end.End extends Object implements Serializable

serialVersionUID:

-7721788644149230405L

Serialized Fields

compensate

boolean compensate

If set to true, triggers workflow compensation when before workflow executin completes. Default is false

produceEvents

@Valid List<ProduceEvent> produceEvents

Array of events to be produced

terminate

boolean terminate

If true, completes all execution flows in the given workflow instance

Package io.serverlessworkflow.api.error

Class io.serverlessworkflow.api.error.Error extends Object implements Serializable

serialVersionUID:

-8933996684263594192L

Serialized Fields

code

@Size(min=1) String code

Error code. Can be used in addition to the name to help runtimes resolve to technical errors/exceptions. Should not be defined if error is set to '*'

end

@Valid End end

State end definition

error

@Size(min=1) @NotNull String error

Domain-specific error name, or '*' to indicate all possible errors (Required)

retryRef

@Size(min=1) String retryRef

References a unique name of a retry definition.

transition

@Valid @NotNull Transition transition

(Required)

Package io.serverlessworkflow.api.events

Class io.serverlessworkflow.api.events.EventDefinition extends Object implements Serializable

serialVersionUID:

-7106400632209024391L

Serialized Fields

correlation

@Size(min=1) @Valid List<CorrelationDef> correlation

CloudEvent correlation definitions

kind

EventDefinition.Kind kind

Defines the events as either being consumed or produced by the workflow. Default is consumed

metadata

@Valid Map<String,String> metadata

Metadata

name

String name

Event Definition unique name

source

String source

CloudEvent source UUID

type

String type

CloudEvent type

Class io.serverlessworkflow.api.events.EventRef extends Object implements Serializable

serialVersionUID:

-7605141253822186681L

Serialized Fields

contextAttributes

@Valid Map<String,String> contextAttributes

Add additional extension context attributes to the produced event

data

String data

Expression which selects parts of the states data output to become the data of the produced event.

resultEventRef

String resultEventRef

Reference to the unique name of a 'consumed' event definition (Required)

triggerEventRef

String triggerEventRef

Reference to the unique name of a 'produced' event definition (Required)

Class io.serverlessworkflow.api.events.OnEvents extends Object implements Serializable

serialVersionUID:

-2202788909832359948L

Serialized Fields

actionMode

OnEvents.ActionMode actionMode

Specifies how actions are to be performed (in sequence of parallel)

actions

@Valid @NotNull List<Action> actions

Actions to be performed. (Required)

eventDataFilter

@Valid EventDataFilter eventDataFilter

eventRefs

@Valid @NotNull List<String> eventRefs

References one or more unique event names in the defined workflow events (Required)

Package io.serverlessworkflow.api.filters

Class io.serverlessworkflow.api.filters.ActionDataFilter extends Object implements Serializable

serialVersionUID:

4977632094110010930L

Serialized Fields

dataInputPath

String dataInputPath

JSONPath definition that selects parts of the states data input to be the action data

dataResultsPath

String dataResultsPath

JSONPath definition that selects parts of the actions data result, to be merged with the states data

Class io.serverlessworkflow.api.filters.EventDataFilter extends Object implements Serializable

serialVersionUID:

7430826423744550344L

Serialized Fields

dataOutputPath

String dataOutputPath

JSONPath definition that selects parts of the event data, to be merged with the states data

Class io.serverlessworkflow.api.filters.StateDataFilter extends Object implements Serializable

serialVersionUID:

7501952972332820166L

Serialized Fields

dataInputPath

String dataInputPath

JSONPath definition that selects parts of the states data input

dataOutputPath

String dataOutputPath

JSONPath definition that selects parts of the states data output

Package io.serverlessworkflow.api.functions

Class io.serverlessworkflow.api.functions.FunctionDefinition extends Object implements Serializable

serialVersionUID:

-4866234450341439383L

Serialized Fields

metadata

@Valid Map<String,String> metadata

Metadata

name

String name

Function unique name (Required)

operation

String operation

Combination of the function/service OpenAPI definition URI and the operationID of the operation that needs to be invoked, separated by a '#'. For example 'https://petstore.swagger.io/v2/swagger.json#getPetById'

Class io.serverlessworkflow.api.functions.FunctionRef extends Object implements Serializable

serialVersionUID:

-4191733380935884036L

Serialized Fields

parameters

@Valid Map<String,String> parameters

Function parameters

refName

String refName

Name of the referenced function (Required)

Package io.serverlessworkflow.api.mapper

Class io.serverlessworkflow.api.mapper.BaseObjectMapper extends com.fasterxml.jackson.databind.ObjectMapper implements Serializable

Serialized Fields

workflowModule

WorkflowModule workflowModule

Class io.serverlessworkflow.api.mapper.JsonObjectMapper extends BaseObjectMapper implements Serializable

Class io.serverlessworkflow.api.mapper.WorkflowModule extends com.fasterxml.jackson.databind.module.SimpleModule implements Serializable

serialVersionUID:

510L

Serialized Fields

extensionDeserializer

ExtensionDeserializer extensionDeserializer

extensionSerializer

ExtensionSerializer extensionSerializer

workflowPropertySource

WorkflowPropertySource workflowPropertySource

Class io.serverlessworkflow.api.mapper.YamlObjectMapper extends BaseObjectMapper implements Serializable

Package io.serverlessworkflow.api.produce

Class io.serverlessworkflow.api.produce.ProduceEvent extends Object implements Serializable

serialVersionUID:

-3376008825318763847L

Serialized Fields

data

String data

JSONPath expression which selects parts of the states data output to become the data of the produced event

eventRef

@Size(min=1) @NotNull String eventRef

References a name of a defined event (Required)

Package io.serverlessworkflow.api.retry

Class io.serverlessworkflow.api.retry.RetryDefinition extends Object implements Serializable

serialVersionUID:

-2085728379200915216L

Serialized Fields

delay

String delay

Time delay between retry attempts (ISO 8601 duration format)

jitter

@DecimalMin("0") @DecimalMax("1") String jitter

Absolute maximum amount of random time added or subtracted from the delay between each retry (ISO 8601 duration format)

maxAttempts

@NotNull String maxAttempts

Maximum number of retry attempts. Value of 0 means no retries are performed (Required)

multiplier

String multiplier

Multiplier value by which interval increases during each attempt (ISO 8601 time format)

name

@Size(min=1) @NotNull String name

Unique retry strategy name (Required)

Package io.serverlessworkflow.api.schedule

Class io.serverlessworkflow.api.schedule.Schedule extends Object implements Serializable

serialVersionUID:

-1331241539341188611L

Serialized Fields

cron

@Valid Cron cron

Schedule cron definition

directInvoke

Schedule.DirectInvoke directInvoke

Define if workflow instances can be created outside of the defined interval/cron

interval

String interval

Time interval (ISO 8601 format) describing when the workflow starting state is active

timezone

String timezone

Timezone name used to evaluate the cron expression. Not used for interval as timezone can be specified there directly. If not specified, should default to local machine timezone.

Package io.serverlessworkflow.api.serializers

Class io.serverlessworkflow.api.serializers.CallbackStateSerializer extends com.fasterxml.jackson.databind.ser.std.StdSerializer<CallbackState> implements Serializable

Class io.serverlessworkflow.api.serializers.DelayStateSerializer extends com.fasterxml.jackson.databind.ser.std.StdSerializer<DelayState> implements Serializable

Class io.serverlessworkflow.api.serializers.EndDefinitionSerializer extends com.fasterxml.jackson.databind.ser.std.StdSerializer<End> implements Serializable

Class io.serverlessworkflow.api.serializers.EventDefinitionSerializer extends com.fasterxml.jackson.databind.ser.std.StdSerializer<EventDefinition> implements Serializable

Class io.serverlessworkflow.api.serializers.EventStateSerializer extends com.fasterxml.jackson.databind.ser.std.StdSerializer<EventState> implements Serializable

Class io.serverlessworkflow.api.serializers.ExtensionSerializer extends com.fasterxml.jackson.databind.ser.std.StdSerializer<Extension> implements Serializable

Serialized Fields

extensionsMap

Map<String,Class<? extends Extension>> extensionsMap

Class io.serverlessworkflow.api.serializers.ForEachStateSerializer extends com.fasterxml.jackson.databind.ser.std.StdSerializer<ForEachState> implements Serializable

Class io.serverlessworkflow.api.serializers.InjectStateSerializer extends com.fasterxml.jackson.databind.ser.std.StdSerializer<InjectState> implements Serializable

Class io.serverlessworkflow.api.serializers.OperationStateSerializer extends com.fasterxml.jackson.databind.ser.std.StdSerializer<OperationState> implements Serializable

Class io.serverlessworkflow.api.serializers.ParallelStateSerializer extends com.fasterxml.jackson.databind.ser.std.StdSerializer<ParallelState> implements Serializable

Class io.serverlessworkflow.api.serializers.StartDefinitionSerializer extends com.fasterxml.jackson.databind.ser.std.StdSerializer<Start> implements Serializable

Class io.serverlessworkflow.api.serializers.SubflowStateSerializer extends com.fasterxml.jackson.databind.ser.std.StdSerializer<SubflowState> implements Serializable

Class io.serverlessworkflow.api.serializers.SwitchStateSerializer extends com.fasterxml.jackson.databind.ser.std.StdSerializer<SwitchState> implements Serializable

Class io.serverlessworkflow.api.serializers.WorkflowSerializer extends com.fasterxml.jackson.databind.ser.std.StdSerializer<Workflow> implements Serializable

Package io.serverlessworkflow.api.start

Class io.serverlessworkflow.api.start.Start extends Object implements Serializable

serialVersionUID:

2106519829761640952L

Serialized Fields

schedule

@Valid Schedule schedule

Start state schedule definition

Package io.serverlessworkflow.api.states

Class io.serverlessworkflow.api.states.CallbackState extends DefaultState implements Serializable

serialVersionUID:

-6087523429574046836L

Serialized Fields

action

@Valid Action action

Action Definition

eventDataFilter

@Valid EventDataFilter eventDataFilter

eventRef

String eventRef

References an unique callback event name in the defined workflow events

timeout

String timeout

Time period to wait for incoming events (ISO 8601 format)

usedForCompensation

boolean usedForCompensation

If true, this state is used to compensate another state. Default is false

Class io.serverlessworkflow.api.states.DefaultState extends Object implements Serializable

serialVersionUID:

3404866325973005912L

Serialized Fields

compensatedBy

String compensatedBy

Unique Name of a workflow state which is responsible for compensation of this state

dataInputSchema

String dataInputSchema

URI to JSON Schema that state data input adheres to

dataOutputSchema

String dataOutputSchema

URI to JSON Schema that state data output adheres to

end

@Valid End end

State end definition

id

String id

State unique identifier

metadata

@Valid Map<String,String> metadata

Metadata

name

String name

Unique name of the state (Required)

onErrors

@Valid List<Error> onErrors

State error handling definitions

start

@Valid Start start

State start definition

stateDataFilter

@Valid StateDataFilter stateDataFilter

transition

@Valid Transition transition

type

DefaultState.Type type

State type (Required)

Class io.serverlessworkflow.api.states.DelayState extends DefaultState implements Serializable

serialVersionUID:

1254210794688006938L

Serialized Fields

timeDelay

String timeDelay

Amount of time (ISO 8601 format) to delay (Required)

usedForCompensation

boolean usedForCompensation

If true, this state is used to compensate another state. Default is false

Class io.serverlessworkflow.api.states.EventState extends DefaultState implements Serializable

serialVersionUID:

1994604164912090415L

Serialized Fields

exclusive

boolean exclusive

If true consuming one of the defined events causes its associated actions to be performed. If false all of the defined events must be consumed in order for actions to be performed

onEvents

@Valid List<OnEvents> onEvents

Define what events trigger one or more actions to be performed

timeout

String timeout

Time period to wait for incoming events (ISO 8601 format)

Class io.serverlessworkflow.api.states.ForEachState extends DefaultState implements Serializable

serialVersionUID:

-2926799326147401132L

Serialized Fields

actions

@Valid List<Action> actions

Actions to be executed for each of the elements of inputCollection

inputCollection

String inputCollection

JsonPath expression selecting an array element of the states data

iterationParam

String iterationParam

Name of the iteration parameter that can be referenced in actions/workflow. For each parallel iteration, this param should contain an unique element of the inputCollection array

max

@javax.validation.constraints.DecimalMin("0") int max

Specifies how upper bound on how many iterations may run in parallel

outputCollection

String outputCollection

JsonPath expression specifying an array element of the states data to add the results of each iteration

usedForCompensation

boolean usedForCompensation

If true, this state is used to compensate another state. Default is false

workflowId

String workflowId

Unique Id of a workflow to be executed for each of the elements of inputCollection

Class io.serverlessworkflow.api.states.InjectState extends DefaultState implements Serializable

serialVersionUID:

-4059730162120471375L

Serialized Fields

data

@Valid com.fasterxml.jackson.databind.JsonNode data

JSON object which can be set as states data input and can be manipulated via filters

usedForCompensation

boolean usedForCompensation

If true, this state is used to compensate another state. Default is false

Class io.serverlessworkflow.api.states.OperationState extends DefaultState implements Serializable

serialVersionUID:

-1213630097689460329L

Serialized Fields

actionMode

OperationState.ActionMode actionMode

Specifies whether functions are executed in sequence or in parallel. (Required)

actions

@Valid @NotNull List<Action> actions

Actions Definitions (Required)

usedForCompensation

boolean usedForCompensation

If true, this state is used to compensate another state. Default is false

Class io.serverlessworkflow.api.states.ParallelState extends DefaultState implements Serializable

serialVersionUID:

3140500562579930576L

Serialized Fields

branches

@Valid @NotNull List<Branch> branches

Branch Definitions (Required)

completionType

ParallelState.CompletionType completionType

Option types on how to complete branch execution.

n

String n

Used when completionType is set to 'n_of_m' to specify the 'N' value

usedForCompensation

boolean usedForCompensation

If true, this state is used to compensate another state. Default is false

Class io.serverlessworkflow.api.states.SubflowState extends DefaultState implements Serializable

serialVersionUID:

-8271535693492143167L

Serialized Fields

usedForCompensation

boolean usedForCompensation

If true, this state is used to compensate another state. Default is false

waitForCompletion

boolean waitForCompletion

Workflow execution must wait for local workflow to finish before continuing.

workflowId

String workflowId

Sub-workflow unique id. (Required)

Class io.serverlessworkflow.api.states.SwitchState extends DefaultState implements Serializable

serialVersionUID:

-5509761874246090017L

Serialized Fields

_default

@Valid @NotNull DefaultDefinition _default

Switch state default definition (Required)

dataConditions

@Valid List<DataCondition> dataConditions

Defines conditions evaluated against state data

eventConditions

@Valid List<EventCondition> eventConditions

Defines conditions evaluated against events

eventTimeout

String eventTimeout

If eventConditions is used, defines the time period to wait for events (ISO 8601 format)

usedForCompensation

boolean usedForCompensation

If true, this state is used to compensate another state. Default is false

Package io.serverlessworkflow.api.switchconditions

Class io.serverlessworkflow.api.switchconditions.DataCondition extends Object implements Serializable

serialVersionUID:

775469464427091300L

Serialized Fields

condition

@NotNull String condition

JsonPath expression evaluated against state data. True if results are not empty (Required)

end

@Valid End end

State end definition

name

String name

Data condition name

transition

@Valid @NotNull Transition transition

(Required)

Class io.serverlessworkflow.api.switchconditions.EventCondition extends Object implements Serializable

serialVersionUID:

-7038422702983954581L

Serialized Fields

end

@Valid End end

State end definition

eventDataFilter

@Valid EventDataFilter eventDataFilter

eventRef

@NotNull String eventRef

References an unique event name in the defined workflow events (Required)

name

String name

Event condition name

transition

@Valid @NotNull Transition transition

(Required)

Package io.serverlessworkflow.api.transitions

Class io.serverlessworkflow.api.transitions.Transition extends Object implements Serializable

serialVersionUID:

8242978917607985217L

Serialized Fields

compensate

boolean compensate

If set to true, triggers workflow compensation before this transition is taken. Default is false

expression

String expression

Common Expression Language (CEL) expression. Must evaluate to true for the transition to be valid

nextState

@Size(min=1) @NotNull String nextState

State to transition to next (Required)

produceEvents

@Valid List<ProduceEvent> produceEvents

Array of events to be produced