Serialized Form (Serverless Workflow

Package io.serverlessworkflow.api
- Class io.serverlessworkflow.api.Workflow extends BaseWorkflow implements Serializable
  
  serialVersionUID:
  
  -8783529052335594182L
  - Serialized Fields
    - annotations
      
      @Size(min=1) @Valid List<String> annotations
      
      List of helpful terms describing the workflows intended purpose, subject areas, or other important qualities
    - auth
      
      @Valid Auth auth
      
      Workflow Auth definitions
    - autoRetries
      
      boolean autoRetries
      
      If set to true, actions should automatically be retried on unchecked errors. Default is false
    - constants
      
      @Valid Constants constants
      
      Workflow constants definitions
    - dataInputSchema
      
      @Valid DataInputSchema dataInputSchema
      
      Workflow data input schema
    - description
      
      String description
      
      Workflow description
    - errors
      
      @Valid Errors errors
      
      Workflow error definitions
    - events
      
      @Valid Events events
      
      Workflow event definitions
    - expressionLang
      
      String expressionLang
      
      Identifies the expression language used for workflow expressions. Default is 'jq'
    - extensions
      
      @Valid List<Extension> extensions
      
      Workflow Extensions
    - functions
      
      @Valid Functions functions
      
      Workflow function definitions
    - id
      
      String id
      
      Workflow unique identifier (Required)
    - keepActive
      
      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'
    - metadata
      
      @Valid Map<String,String> metadata
      
      Metadata
    - name
      
      String name
      
      Workflow name (Required)
    - retries
      
      @Valid Retries retries
      
      Workflow retry definitions
    - secrets
      
      @Valid Secrets secrets
      
      Workflow secrets definitions
    - specVersion
      
      String specVersion
      
      Serverless Workflow schema version
    - start
      
      @Valid Start start
      
      State start definition
    - states
      
      @Valid @NotNull List<State> states
      
      State Definitions (Required)
    - timeouts
      
      @Valid TimeoutsDefinition timeouts
      
      Timeouts Definition
    - version
      
      String version
      
      Workflow version (Required)
Package io.serverlessworkflow.api.actions
- Class io.serverlessworkflow.api.actions.Action extends Object implements Serializable
  
  serialVersionUID:
  
  5349382716473763088L
  - Serialized Fields
    - actionDataFilter
      
      @Valid ActionDataFilter actionDataFilter
    - condition
      
      @Size(min=1) String condition
      
      Expression, if defined, must evaluate to true for this action to be performed. If false, action is disregarded
    - eventRef
      
      @Valid EventRef eventRef
      
      Event References
    - functionRef
      
      @Valid FunctionRef functionRef
    - id
      
      String id
      
      Unique action identifier
    - name
      
      String name
      
      Unique action definition name
    - nonRetryableErrors
      
      @Size(min=1) @Valid List<String> nonRetryableErrors
      
      List of unique references to defined workflow errors for which the action should not be retried. Used only when `autoRetries` is set to `true`
    - retryableErrors
      
      @Size(min=1) @Valid List<String> retryableErrors
      
      List of unique references to defined workflow errors for which the action should be retried. Used only when `autoRetries` is set to `false`
    - retryRef
      
      String retryRef
      
      References a defined workflow retry definition. If not defined the default retry policy is assumed
    - sleep
      
      @Valid Sleep sleep
    - subFlowRef
      
      @Valid SubFlowRef subFlowRef
Package io.serverlessworkflow.api.auth
- Class io.serverlessworkflow.api.auth.AuthDefinition extends Object implements Serializable
  
  serialVersionUID:
  
  4557883378844963381L
  - Serialized Fields
    - basicauth
      
      @Valid BasicAuthDefinition basicauth
    - bearerauth
      
      @Valid BearerAuthDefinition bearerauth
    - name
      
      @Size(min=1) String name
      
      Unique auth definition name
    - oauth
      
      @Valid OauthDefinition oauth
    - scheme
      
      AuthDefinition.Scheme scheme
      
      Defines the auth type
- Class io.serverlessworkflow.api.auth.BasicAuthDefinition extends Object implements Serializable
  
  serialVersionUID:
  
  -6123191764856682930L
  - Serialized Fields
    - metadata
      
      @Valid Map<String,String> metadata
      
      Metadata
    - password
      
      String password
      
      String or a workflow expression. Contains the user password (Required)
    - username
      
      String username
      
      String or a workflow expression. Contains the user name (Required)
- Class io.serverlessworkflow.api.auth.BearerAuthDefinition extends Object implements Serializable
  
  serialVersionUID:
  
  5466686267180594730L
  - Serialized Fields
    - metadata
      
      @Valid Map<String,String> metadata
      
      Metadata
    - token
      
      String token
      
      String or a workflow expression. Contains the token (Required)
- Class io.serverlessworkflow.api.auth.OauthDefinition extends Object implements Serializable
  
  serialVersionUID:
  
  -1012409488046582753L
  - Serialized Fields
    - audiences
      
      @Size(min=1) @Valid List<String> audiences
      
      Array containing strings or workflow expressions. Contains the OAuth2 audiences
    - authority
      
      String authority
      
      String or a workflow expression. Contains the authority information
    - clientId
      
      String clientId
      
      String or a workflow expression. Contains the client identifier (Required)
    - clientSecret
      
      String clientSecret
      
      Workflow secret or a workflow expression. Contains the client secret
    - grantType
      
      OauthDefinition.GrantType grantType
      
      Defines the grant type (Required)
    - metadata
      
      @Valid Map<String,String> metadata
      
      Metadata
    - password
      
      String password
      
      String or a workflow expression. Contains the user password. Used only if grantType is 'resourceOwner'
    - requestedIssuer
      
      String requestedIssuer
      
      String or a workflow expression. Contains the requested issuer
    - requestedSubject
      
      String requestedSubject
      
      String or a workflow expression. Contains the requested subject
    - scopes
      
      @Size(min=1) @Valid List<String> scopes
      
      Array containing strings or workflow expressions. Contains the OAuth2 scopes
    - subjectToken
      
      String subjectToken
      
      String or a workflow expression. Contains the subject token
    - username
      
      String username
      
      String or a workflow expression. Contains the user name. Used only if grantType is 'resourceOwner'
Package io.serverlessworkflow.api.branches
- Class io.serverlessworkflow.api.branches.Branch extends Object implements Serializable
  
  serialVersionUID:
  
  8229957601558444839L
  - Serialized Fields
    - actions
      
      @Valid List<Action> actions
      
      Actions to be executed in this branch
    - name
      
      String name
      
      Branch name
    - timeouts
      
      @Valid TimeoutsDefinition timeouts
      
      Timeouts Definition
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.datainputschema
- Class io.serverlessworkflow.api.datainputschema.DataInputSchema extends Object implements Serializable
  
  serialVersionUID:
  
  -5239024246688233784L
  - Serialized Fields
    - failOnValidationErrors
      
      @javax.validation.constraints.NotNull boolean failOnValidationErrors
      
      Determines if workfow execution should continue if there are validation errors (Required)
    - schema
      
      @Size(min=1) @NotNull String schema
      
      URI of the JSON Schema used to validate the workflow data input (Required)
Package io.serverlessworkflow.api.defaultdef
- Class io.serverlessworkflow.api.defaultdef.DefaultConditionDefinition extends Object implements Serializable
  
  serialVersionUID:
  
  1330177899510029969L
  - Serialized Fields
    - end
      
      @Valid End end
      
      State end definition
    - transition
      
      @Valid Transition transition
Package io.serverlessworkflow.api.deserializers
- Class io.serverlessworkflow.api.deserializers.AuthDefinitionDeserializer extends com.fasterxml.jackson.databind.deser.std.StdDeserializer<AuthDefinition> implements Serializable
  
  serialVersionUID:
  
  510L
  - Serialized Fields
    - context
      
      WorkflowPropertySource context
- Class io.serverlessworkflow.api.deserializers.AuthDeserializer extends com.fasterxml.jackson.databind.deser.std.StdDeserializer<Auth> implements Serializable
  
  serialVersionUID:
  
  520L
  - Serialized Fields
    - context
      
      WorkflowPropertySource context
- Class io.serverlessworkflow.api.deserializers.ConstantsDeserializer extends com.fasterxml.jackson.databind.deser.std.StdDeserializer<Constants> implements Serializable
  
  serialVersionUID:
  
  510L
  - Serialized Fields
    - context
      
      WorkflowPropertySource context
- Class io.serverlessworkflow.api.deserializers.ContinueAsDeserializer extends com.fasterxml.jackson.databind.deser.std.StdDeserializer<ContinueAs> implements Serializable
  
  serialVersionUID:
  
  510L
  - Serialized Fields
    - context
      
      WorkflowPropertySource context
- Class io.serverlessworkflow.api.deserializers.CronDeserializer extends com.fasterxml.jackson.databind.deser.std.StdDeserializer<Cron> implements Serializable
  
  serialVersionUID:
  
  510L
  - Serialized Fields
    - context
      
      WorkflowPropertySource context
- Class io.serverlessworkflow.api.deserializers.DataInputSchemaDeserializer extends com.fasterxml.jackson.databind.deser.std.StdDeserializer<DataInputSchema> implements Serializable
  
  serialVersionUID:
  
  510L
- 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.ErrorsDeserializer extends com.fasterxml.jackson.databind.deser.std.StdDeserializer<Errors> 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.FunctionDefinitionTypeDeserializer extends com.fasterxml.jackson.databind.deser.std.StdDeserializer<FunctionDefinition.Type> implements Serializable
  
  serialVersionUID:
  
  510L
  - Serialized Fields
    - context
      
      WorkflowPropertySource context
- Class io.serverlessworkflow.api.deserializers.FunctionRefDeserializer extends com.fasterxml.jackson.databind.deser.std.StdDeserializer<FunctionRef> implements Serializable
  
  serialVersionUID:
  
  510L
  - Serialized Fields
    - context
      
      WorkflowPropertySource context
- 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.ScheduleDeserializer extends com.fasterxml.jackson.databind.deser.std.StdDeserializer<Schedule> implements Serializable
  
  serialVersionUID:
  
  510L
  - Serialized Fields
    - context
      
      WorkflowPropertySource context
- Class io.serverlessworkflow.api.deserializers.SecretsDeserializer extends com.fasterxml.jackson.databind.deser.std.StdDeserializer<Secrets> 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.StateExecTimeoutDeserializer extends com.fasterxml.jackson.databind.deser.std.StdDeserializer<StateExecTimeout> 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
- Class io.serverlessworkflow.api.deserializers.SubFlowRefDeserializer extends com.fasterxml.jackson.databind.deser.std.StdDeserializer<SubFlowRef> implements Serializable
  
  serialVersionUID:
  
  510L
  - Serialized Fields
    - context
      
      WorkflowPropertySource context
- Class io.serverlessworkflow.api.deserializers.TransitionDeserializer extends com.fasterxml.jackson.databind.deser.std.StdDeserializer<Transition> implements Serializable
  
  serialVersionUID:
  
  510L
  - Serialized Fields
    - context
      
      WorkflowPropertySource context
Package io.serverlessworkflow.api.end
- Class io.serverlessworkflow.api.end.ContinueAs extends Object implements Serializable
  
  serialVersionUID:
  
  409131742862039472L
  - Serialized Fields
    - data
      
      String data
      
      Expression which selects parts of the states data output to become the workflow data input of continued execution
    - version
      
      @Size(min=1) String version
      
      Version of the workflow to continue execution as
    - workflowExecTimeout
      
      @Valid WorkflowExecTimeout workflowExecTimeout
    - workflowId
      
      String workflowId
      
      Unique id of the workflow to continue execution as
- Class io.serverlessworkflow.api.end.End extends Object implements Serializable
  
  serialVersionUID:
  
  3731296088121348585L
  - Serialized Fields
    - compensate
      
      boolean compensate
      
      If set to true, triggers workflow compensation when before workflow executin completes. Default is false
    - continueAs
      
      @Valid ContinueAs continueAs
      
      End definition continue as
    - 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:
  
  -5942415987505171493L
  - Serialized Fields
    - end
      
      @Valid End end
      
      State end definition
    - errorRef
      
      @Size(min=1) String errorRef
      
      Reference to a unique workflow error definition. Used of errorRefs is not used
    - errorRefs
      
      @Size(min=1) @Valid List<String> errorRefs
      
      References one or more workflow error definitions. Used if errorRef is not used
    - transition
      
      @Valid @NotNull Transition transition
      
      (Required)
- Class io.serverlessworkflow.api.error.ErrorDefinition extends Object implements Serializable
  
  serialVersionUID:
  
  -5051899689051060824L
  - 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 '*'
    - description
      
      String description
      
      Error description
    - name
      
      @Size(min=1) @NotNull String name
      
      Domain-specific error name (Required)
Package io.serverlessworkflow.api.events
- Class io.serverlessworkflow.api.events.EventDefinition extends Object implements Serializable
  
  serialVersionUID:
  
  -2334648709319462106L
  - Serialized Fields
    - correlation
      
      @Size(min=1) @Valid List<CorrelationDef> correlation
      
      CloudEvent correlation definitions
    - dataOnly
      
      boolean dataOnly
      
      If `true`, only the Event payload is accessible to consuming Workflow states. If `false`, both event payload and context attributes should be accessible
    - 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:
  
  6021703727803798401L
  - 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.
    - invoke
      
      EventRef.Invoke invoke
      
      Specifies if the function should be invoked sync or async. Default is sync.
    - resultEventRef
      
      String resultEventRef
      
      Reference to the unique name of a 'consumed' event definition (Required)
    - resultEventTimeout
      
      String resultEventTimeout
      
      Maximum amount of time (ISO 8601 format) to wait for the result event. If not defined it should default to the actionExecutionTimeout
    - 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:
  
  -8576533856536101663L
  - Serialized Fields
    - fromStateData
      
      String fromStateData
      
      Workflow expression that selects state data that the state action can use
    - results
      
      String results
      
      Workflow expression that filters the actions data results
    - toStateData
      
      String toStateData
      
      Workflow expression that selects a state data element to which the action results should be added/merged into. If not specified, denote, the top-level state data element
    - useResults
      
      boolean useResults
      
      If set to false, action data results are not added/merged to state data. In this case 'results' and 'toStateData' should be ignored. Default is true.
- Class io.serverlessworkflow.api.filters.EventDataFilter extends Object implements Serializable
  
  serialVersionUID:
  
  -3553146331547621997L
  - Serialized Fields
    - data
      
      String data
      
      Workflow expression that filters of the event data (payload)
    - toStateData
      
      String toStateData
      
      Workflow expression that selects a state data element to which the event payload should be added/merged into. If not specified, denotes, the top-level state data element.
    - useData
      
      boolean useData
      
      If set to false, event payload is not added/merged to state data. In this case 'data' and 'toStateData' should be ignored. Default is true.
- Class io.serverlessworkflow.api.filters.StateDataFilter extends Object implements Serializable
  
  serialVersionUID:
  
  239309000496960765L
  - Serialized Fields
    - input
      
      String input
      
      Workflow expression to filter the state data input
    - output
      
      String output
      
      Workflow expression that filters the state data output
Package io.serverlessworkflow.api.functions
- Class io.serverlessworkflow.api.functions.FunctionDefinition extends Object implements Serializable
  
  serialVersionUID:
  
  -8792630341762512097L
  - Serialized Fields
    - authRef
      
      String authRef
      
      References an auth definition name to be used to access to resource defined in the operation parameter
    - metadata
      
      @Valid Map<String,String> metadata
      
      Metadata
    - name
      
      String name
      
      Function unique name (Required)
    - operation
      
      String operation
      
      If type is `rest`, #. If type is `rpc`, ##. If type is `expression`, defines the workflow expression.
    - type
      
      FunctionDefinition.Type type
      
      Defines the function type. Is either `rest`, `asyncapi, `rpc`, `graphql`, `odata`, `expression`, or `custom`. Default is `rest`
- Class io.serverlessworkflow.api.functions.FunctionRef extends Object implements Serializable
  
  serialVersionUID:
  
  -194299573266930319L
  - Serialized Fields
    - arguments
      
      @Valid com.fasterxml.jackson.databind.JsonNode arguments
      
      Function arguments
    - invoke
      
      FunctionRef.Invoke invoke
      
      Specifies if the function should be invoked sync or async. Default is sync.
    - refName
      
      @Size(min=1) @NotNull String refName
      
      Name of the referenced function (Required)
    - selectionSet
      
      String selectionSet
      
      Only used if function type is 'graphql'. A string containing a valid GraphQL selection set
- Class io.serverlessworkflow.api.functions.SubFlowRef extends Object implements Serializable
  
  serialVersionUID:
  
  924910219419591889L
  - Serialized Fields
    - invoke
      
      SubFlowRef.Invoke invoke
      
      Specifies if the function should be invoked sync or async. Default is sync.
    - onParentComplete
      
      SubFlowRef.OnParentComplete onParentComplete
      
      If invoke is 'async', specifies how subflow execution should behave when parent workflow completes. Default is 'terminate'
    - version
      
      @Size(min=1) String version
      
      Version of the sub-workflow to be invoked
    - workflowId
      
      @NotNull String workflowId
      
      Unique id of the sub-workflow to be invoked (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
      
      Workflow 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.repeat
- Class io.serverlessworkflow.api.repeat.Repeat extends Object implements Serializable
  
  serialVersionUID:
  
  1851955639467650709L
  - Serialized Fields
    - checkBefore
      
      boolean checkBefore
      
      If true, the expression is evaluated before each repeat execution, if false the expression is evaluated after each repeat execution
    - continueOnError
      
      boolean continueOnError
      
      If true, repeats executions in a case unhandled errors propagate from the sub-workflow to this state
    - expression
      
      @Size(min=1) String expression
      
      Expression evaluated against SubFlow state data. SubFlow will repeat execution as long as this expression is true or until the max property count is reached
    - max
      
      @javax.validation.constraints.DecimalMin("0") int max
      
      Sets the maximum amount of repeat executions
    - stopOnEvents
      
      @Valid List<String> stopOnEvents
      
      List referencing defined consumed workflow events. SubFlow will repeat execution until one of the defined events is consumed, or until the max property count is reached
Package io.serverlessworkflow.api.retry
- Class io.serverlessworkflow.api.retry.RetryDefinition extends Object implements Serializable
  
  serialVersionUID:
  
  2618758715524494864L
  - Serialized Fields
    - delay
      
      String delay
      
      Time delay between retry attempts (ISO 8601 duration format)
    - increment
      
      String increment
      
      Static value by which the delay increases during each attempt (ISO 8601 time 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)
    - maxDelay
      
      String maxDelay
      
      Maximum time delay between retry attempts (ISO 8601 duration format)
    - 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:
  
  -6836537185267313942L
  - Serialized Fields
    - cron
      
      @Valid Cron cron
      
      Schedule cron definition
    - 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.AuthDefinitionSerializer extends com.fasterxml.jackson.databind.ser.std.StdSerializer<AuthDefinition> implements Serializable
- Class io.serverlessworkflow.api.serializers.CallbackStateSerializer extends com.fasterxml.jackson.databind.ser.std.StdSerializer<CallbackState> implements Serializable
- Class io.serverlessworkflow.api.serializers.ContinueAsSerializer extends com.fasterxml.jackson.databind.ser.std.StdSerializer<ContinueAs> implements Serializable
- Class io.serverlessworkflow.api.serializers.CronSerializer extends com.fasterxml.jackson.databind.ser.std.StdSerializer<Cron> 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.FunctionRefSerializer extends com.fasterxml.jackson.databind.ser.std.StdSerializer<FunctionRef> 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.ScheduleSerializer extends com.fasterxml.jackson.databind.ser.std.StdSerializer<Schedule> implements Serializable
- Class io.serverlessworkflow.api.serializers.SleepStateSerializer extends com.fasterxml.jackson.databind.ser.std.StdSerializer<SleepState> implements Serializable
- Class io.serverlessworkflow.api.serializers.StartDefinitionSerializer extends com.fasterxml.jackson.databind.ser.std.StdSerializer<Start> implements Serializable
- Class io.serverlessworkflow.api.serializers.StateExecTimeoutSerializer extends com.fasterxml.jackson.databind.ser.std.StdSerializer<StateExecTimeout> implements Serializable
- Class io.serverlessworkflow.api.serializers.SubFlowRefSerializer extends com.fasterxml.jackson.databind.ser.std.StdSerializer<SubFlowRef> implements Serializable
- Class io.serverlessworkflow.api.serializers.SwitchStateSerializer extends com.fasterxml.jackson.databind.ser.std.StdSerializer<SwitchState> implements Serializable
- Class io.serverlessworkflow.api.serializers.TransitionSerializer extends com.fasterxml.jackson.databind.ser.std.StdSerializer<Transition> implements Serializable
- Class io.serverlessworkflow.api.serializers.WorkflowSerializer extends com.fasterxml.jackson.databind.ser.std.StdSerializer<Workflow> implements Serializable
Package io.serverlessworkflow.api.sleep
- Class io.serverlessworkflow.api.sleep.Sleep extends Object implements Serializable
  
  serialVersionUID:
  
  921205403250153351L
  - Serialized Fields
    - after
      
      @NotNull String after
      
      Amount of time (ISO 8601 duration format) to sleep after function/subflow invocation. Does not apply if 'eventRef' is defined. (Required)
    - before
      
      @NotNull String before
      
      Amount of time (ISO 8601 duration format) to sleep before function/subflow invocation. Does not apply if 'eventRef' is defined. (Required)
Package io.serverlessworkflow.api.start
- Class io.serverlessworkflow.api.start.Start extends Object implements Serializable
  
  serialVersionUID:
  
  -523611139255478407L
  - Serialized Fields
    - schedule
      
      @Valid Schedule schedule
      
      Start state schedule definition
    - stateName
      
      @Size(min=1) String stateName
      
      Name of the starting workflow state
Package io.serverlessworkflow.api.states
- Class io.serverlessworkflow.api.states.CallbackState extends DefaultState implements Serializable
  
  serialVersionUID:
  
  7392031393428885110L
  - 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
    - 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:
  
  -3037664099420798340L
  - Serialized Fields
    - compensatedBy
      
      String compensatedBy
      
      Unique Name of a workflow state which is responsible for compensation of this state
    - 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
    - stateDataFilter
      
      @Valid StateDataFilter stateDataFilter
    - timeouts
      
      @Valid TimeoutsDefinition timeouts
      
      Timeouts Definition
    - transition
      
      @Valid Transition transition
    - type
      
      DefaultState.Type type
      
      State type (Required)
- Class io.serverlessworkflow.api.states.EventState extends DefaultState implements Serializable
  
  serialVersionUID:
  
  -3502136740903800687L
  - 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
- Class io.serverlessworkflow.api.states.ForEachState extends DefaultState implements Serializable
  
  serialVersionUID:
  
  -3623129984146655307L
  - Serialized Fields
    - actions
      
      @Valid List<Action> actions
      
      Actions to be executed for each of the elements of inputCollection
    - batchSize
      
      @javax.validation.constraints.DecimalMin("0") int batchSize
      
      Specifies how many iterations may run in parallel at the same time. Used if 'mode' property is set to 'parallel' (default)
    - inputCollection
      
      String inputCollection
      
      Workflow 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
    - mode
      
      ForEachState.Mode mode
      
      Specifies how iterations are to be performed (sequentially or in parallel)
    - outputCollection
      
      String outputCollection
      
      Workflow 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
- Class io.serverlessworkflow.api.states.InjectState extends DefaultState implements Serializable
  
  serialVersionUID:
  
  -7780011839483126753L
  - 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:
  
  -4679881670025324625L
  - 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:
  
  4190631255619092420L
  - Serialized Fields
    - branches
      
      @Valid @NotNull List<Branch> branches
      
      Branch Definitions (Required)
    - completionType
      
      ParallelState.CompletionType completionType
      
      Option types on how to complete branch execution.
    - numCompleted
      
      String numCompleted
      
      Used when completionType is set to 'atLeast' to specify the minimum number of branches that must complete before the state will transition.
    - usedForCompensation
      
      boolean usedForCompensation
      
      If true, this state is used to compensate another state. Default is false
- Class io.serverlessworkflow.api.states.SleepState extends DefaultState implements Serializable
  
  serialVersionUID:
  
  -8925446143263030025L
  - Serialized Fields
    - duration
      
      String duration
      
      Duration (ISO 8601 duration format) to sleep (Required)
    - usedForCompensation
      
      boolean usedForCompensation
      
      If true, this state is used to compensate another state. Default is false
- Class io.serverlessworkflow.api.states.SwitchState extends DefaultState implements Serializable
  
  serialVersionUID:
  
  6383799176661595489L
  - Serialized Fields
    - dataConditions
      
      @Valid List<DataCondition> dataConditions
      
      Defines conditions evaluated against state data
    - defaultCondition
      
      @Valid DefaultConditionDefinition defaultCondition
      
      Switch state default condition definition
    - eventConditions
      
      @Valid List<EventCondition> eventConditions
      
      Defines conditions evaluated against events
    - 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
      
      Workflow 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.timeouts
- Class io.serverlessworkflow.api.timeouts.StateExecTimeout extends Object implements Serializable
  
  serialVersionUID:
  
  -1229552954291556442L
  - Serialized Fields
    - single
      
      @Size(min=1) String single
      
      Single state execution timeout, not including retries (ISO 8601 duration format)
    - total
      
      @Size(min=1) @NotNull String total
      
      Total state execution timeout, including retries (ISO 8601 duration format) (Required)
- Class io.serverlessworkflow.api.timeouts.TimeoutsDefinition extends Object implements Serializable
  
  serialVersionUID:
  
  -510823631638536253L
  - Serialized Fields
    - actionExecTimeout
      
      @Size(min=1) String actionExecTimeout
      
      Single actions definition execution timeout duration (ISO 8601 duration format)
    - branchExecTimeout
      
      @Size(min=1) String branchExecTimeout
      
      Single branch execution timeout duration (ISO 8601 duration format)
    - eventTimeout
      
      @Size(min=1) String eventTimeout
      
      Timeout duration to wait for consuming defined events (ISO 8601 duration format)
    - stateExecTimeout
      
      @Valid StateExecTimeout stateExecTimeout
    - workflowExecTimeout
      
      @Valid WorkflowExecTimeout workflowExecTimeout
- Class io.serverlessworkflow.api.timeouts.WorkflowExecTimeout extends Object implements Serializable
  
  serialVersionUID:
  
  -3406163368108987059L
  - Serialized Fields
    - duration
      
      @Size(min=1) @NotNull String duration
      
      Workflow execution timeout duration (ISO 8601 duration format). If not specified should be 'unlimited' (Required)
    - interrupt
      
      boolean interrupt
      
      If `false`, workflow instance is allowed to finish current execution. If `true`, current workflow execution is abrupted.
    - runBefore
      
      @Size(min=1) String runBefore
      
      Name of a workflow state to be executed before workflow instance is terminated
Package io.serverlessworkflow.api.transitions
- Class io.serverlessworkflow.api.transitions.Transition extends Object implements Serializable
  
  serialVersionUID:
  
  9213732011354073065L
  - Serialized Fields
    - compensate
      
      boolean compensate
      
      If set to true, triggers workflow compensation before this transition is taken. Default is false
    - nextState
      
      @Size(min=1) @NotNull String nextState
      
      State to transition to next (Required)
    - produceEvents
      
      @Valid List<ProduceEvent> produceEvents
      
      Array of events to be produced

Serialized Form

Package io.serverlessworkflow.api

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

Serialized Fields

annotations

auth

autoRetries

constants

dataInputSchema

description

errors

events

expressionLang

extensions

functions

id

keepActive

metadata

name

retries

secrets

specVersion

start

states

timeouts

version

Package io.serverlessworkflow.api.actions

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

Serialized Fields

actionDataFilter

condition

eventRef

functionRef

id

name

nonRetryableErrors

retryableErrors

retryRef

sleep

subFlowRef

Package io.serverlessworkflow.api.auth

Class io.serverlessworkflow.api.auth.AuthDefinition extends Object implements Serializable

Serialized Fields

basicauth

bearerauth

name

oauth

scheme

Class io.serverlessworkflow.api.auth.BasicAuthDefinition extends Object implements Serializable

Serialized Fields

metadata

password

username

Class io.serverlessworkflow.api.auth.BearerAuthDefinition extends Object implements Serializable

Serialized Fields

metadata

token

Class io.serverlessworkflow.api.auth.OauthDefinition extends Object implements Serializable

Serialized Fields

audiences

authority

clientId

clientSecret

grantType

metadata

password

requestedIssuer

requestedSubject

scopes

subjectToken

username

Package io.serverlessworkflow.api.branches

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

Serialized Fields

actions

name

timeouts

Package io.serverlessworkflow.api.correlation

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

Serialized Fields