- generateUniqueId() - Static method in class io.serverlessworkflow.api.serializers.WorkflowSerializer
-
- getAction() - Method in class io.serverlessworkflow.api.states.CallbackState
-
Action Definition
- getActionDataFilter() - Method in class io.serverlessworkflow.api.actions.Action
-
- getActionExecTimeout() - Method in class io.serverlessworkflow.api.timeouts.TimeoutsDefinition
-
Single actions definition execution timeout duration (ISO 8601 duration format)
- getActionMode() - Method in class io.serverlessworkflow.api.events.OnEvents
-
Specifies how actions are to be performed (in sequence of parallel)
- getActionMode() - Method in class io.serverlessworkflow.api.states.OperationState
-
Specifies whether functions are executed in sequence or in parallel.
- getActions() - Method in class io.serverlessworkflow.api.branches.Branch
-
Actions to be executed in this branch
- getActions() - Method in class io.serverlessworkflow.api.events.OnEvents
-
Actions to be performed.
- getActions() - Method in class io.serverlessworkflow.api.states.ForEachState
-
Actions to be executed for each of the elements of inputCollection
- getActions() - Method in class io.serverlessworkflow.api.states.OperationState
-
Actions Definitions
(Required)
- getAfter() - Method in class io.serverlessworkflow.api.sleep.Sleep
-
Amount of time (ISO 8601 duration format) to sleep after function/subflow invocation.
- getAnnotations() - Method in class io.serverlessworkflow.api.Workflow
-
List of helpful terms describing the workflows intended purpose, subject areas, or other important qualities
- getArguments() - Method in class io.serverlessworkflow.api.functions.FunctionRef
-
Function arguments
- getAudiences() - Method in class io.serverlessworkflow.api.auth.OauthDefinition
-
Array containing strings or workflow expressions.
- getAuth() - Method in class io.serverlessworkflow.api.Workflow
-
Workflow Auth definitions
- getAuthDefs() - Method in class io.serverlessworkflow.api.workflow.Auth
-
- getAuthority() - Method in class io.serverlessworkflow.api.auth.OauthDefinition
-
String or a workflow expression.
- getAuthRef() - Method in class io.serverlessworkflow.api.functions.FunctionDefinition
-
References an auth definition name to be used to access to resource defined in the operation parameter
- getBasicauth() - Method in class io.serverlessworkflow.api.auth.AuthDefinition
-
- getBatchSize() - Method in class io.serverlessworkflow.api.states.ForEachState
-
Specifies how many iterations may run in parallel at the same time.
- getBearerauth() - Method in class io.serverlessworkflow.api.auth.AuthDefinition
-
- getBefore() - Method in class io.serverlessworkflow.api.sleep.Sleep
-
Amount of time (ISO 8601 duration format) to sleep before function/subflow invocation.
- getBranches() - Method in class io.serverlessworkflow.api.states.ParallelState
-
Branch Definitions
(Required)
- getBranchExecTimeout() - Method in class io.serverlessworkflow.api.timeouts.TimeoutsDefinition
-
Single branch execution timeout duration (ISO 8601 duration format)
- getClientId() - Method in class io.serverlessworkflow.api.auth.OauthDefinition
-
String or a workflow expression.
- getClientSecret() - Method in class io.serverlessworkflow.api.auth.OauthDefinition
-
Workflow secret or a workflow expression.
- getCode() - Method in class io.serverlessworkflow.api.error.ErrorDefinition
-
Error code.
- getCompensatedBy() - Method in interface io.serverlessworkflow.api.interfaces.State
-
- getCompensatedBy() - Method in class io.serverlessworkflow.api.states.DefaultState
-
Unique Name of a workflow state which is responsible for compensation of this state
- getCompletionType() - Method in class io.serverlessworkflow.api.states.ParallelState
-
Option types on how to complete branch execution.
- getCondition() - Method in class io.serverlessworkflow.api.actions.Action
-
Expression, if defined, must evaluate to true for this action to be performed.
- getCondition() - Method in class io.serverlessworkflow.api.switchconditions.DataCondition
-
Workflow expression evaluated against state data.
- getConstants() - Method in class io.serverlessworkflow.api.Workflow
-
Workflow constants definitions
- getConstantsDef() - Method in class io.serverlessworkflow.api.workflow.Constants
-
- getContextAttributeName() - Method in class io.serverlessworkflow.api.correlation.CorrelationDef
-
CloudEvent Extension Context Attribute name
(Required)
- getContextAttributes() - Method in class io.serverlessworkflow.api.events.EventRef
-
Add additional extension context attributes to the produced event
- getContextAttributes() - Method in class io.serverlessworkflow.api.produce.ProduceEvent
-
Add additional event extension context attributes
- getContextAttributeValue() - Method in class io.serverlessworkflow.api.correlation.CorrelationDef
-
CloudEvent Extension Context Attribute value
- getContinueAs() - Method in class io.serverlessworkflow.api.end.End
-
End definition continue as
- getCorrelation() - Method in class io.serverlessworkflow.api.events.EventDefinition
-
CloudEvent correlation definitions
- getCron() - Method in class io.serverlessworkflow.api.schedule.Schedule
-
Schedule cron definition
- getData() - Method in class io.serverlessworkflow.api.end.ContinueAs
-
Expression which selects parts of the states data output to become the workflow data input of continued execution
- getData() - Method in class io.serverlessworkflow.api.events.EventRef
-
Expression which selects parts of the states data output to become the data of the produced event.
- getData() - Method in class io.serverlessworkflow.api.filters.EventDataFilter
-
Workflow expression that filters of the event data (payload)
- getData() - Method in class io.serverlessworkflow.api.produce.ProduceEvent
-
Workflow expression which selects parts of the states data output to become the data of the produced event
- getData() - Method in class io.serverlessworkflow.api.states.InjectState
-
JSON object which can be set as states data input and can be manipulated via filters
- getDataConditions() - Method in class io.serverlessworkflow.api.states.SwitchState
-
Defines conditions evaluated against state data
- getDataInputSchema() - Method in class io.serverlessworkflow.api.Workflow
-
Workflow data input schema
- getDefaultCondition() - Method in class io.serverlessworkflow.api.states.SwitchState
-
Switch state default condition definition
- getDelay() - Method in class io.serverlessworkflow.api.retry.RetryDefinition
-
Time delay between retry attempts (ISO 8601 duration format)
- getDescription() - Method in class io.serverlessworkflow.api.error.ErrorDefinition
-
Error description
- getDescription() - Method in class io.serverlessworkflow.api.Workflow
-
Workflow description
- getDuration() - Method in class io.serverlessworkflow.api.states.SleepState
-
Duration (ISO 8601 duration format) to sleep
(Required)
- getDuration() - Method in class io.serverlessworkflow.api.timeouts.WorkflowExecTimeout
-
Workflow execution timeout duration (ISO 8601 duration format).
- getEnd() - Method in class io.serverlessworkflow.api.defaultdef.DefaultConditionDefinition
-
State end definition
- getEnd() - Method in class io.serverlessworkflow.api.error.Error
-
State end definition
- getEnd() - Method in interface io.serverlessworkflow.api.interfaces.State
-
- getEnd() - Method in class io.serverlessworkflow.api.states.DefaultState
-
State end definition
- getEnd() - Method in class io.serverlessworkflow.api.switchconditions.DataCondition
-
State end definition
- getEnd() - Method in class io.serverlessworkflow.api.switchconditions.EventCondition
-
State end definition
- getErrorDefs() - Method in class io.serverlessworkflow.api.workflow.Errors
-
- getErrorRef() - Method in class io.serverlessworkflow.api.error.Error
-
Reference to a unique workflow error definition.
- getErrorRefs() - Method in class io.serverlessworkflow.api.error.Error
-
References one or more workflow error definitions.
- getErrors() - Method in class io.serverlessworkflow.api.Workflow
-
Workflow error definitions
- getEventConditions() - Method in class io.serverlessworkflow.api.states.SwitchState
-
Defines conditions evaluated against events
- getEventDataFilter() - Method in class io.serverlessworkflow.api.events.OnEvents
-
- getEventDataFilter() - Method in class io.serverlessworkflow.api.states.CallbackState
-
- getEventDataFilter() - Method in class io.serverlessworkflow.api.switchconditions.EventCondition
-
- getEventDefs() - Method in class io.serverlessworkflow.api.workflow.Events
-
- getEventRef() - Method in class io.serverlessworkflow.api.actions.Action
-
Event References
- getEventRef() - Method in class io.serverlessworkflow.api.produce.ProduceEvent
-
References a name of a defined event
(Required)
- getEventRef() - Method in class io.serverlessworkflow.api.states.CallbackState
-
References an unique callback event name in the defined workflow events
- getEventRef() - Method in class io.serverlessworkflow.api.switchconditions.EventCondition
-
References an unique event name in the defined workflow events
(Required)
- getEventRefs() - Method in class io.serverlessworkflow.api.events.OnEvents
-
References one or more unique event names in the defined workflow events
(Required)
- getEvents() - Method in class io.serverlessworkflow.api.Workflow
-
Workflow event definitions
- getEventTimeout() - Method in class io.serverlessworkflow.api.timeouts.TimeoutsDefinition
-
Timeout duration to wait for consuming defined events (ISO 8601 duration format)
- getExpression() - Method in class io.serverlessworkflow.api.cron.Cron
-
Repeating interval (cron expression) describing when the workflow instance should be created
(Required)
- getExpression() - Method in class io.serverlessworkflow.api.repeat.Repeat
-
Expression evaluated against SubFlow state data.
- getExpressionLang() - Method in class io.serverlessworkflow.api.Workflow
-
Identifies the expression language used for workflow expressions.
- getExtensionDeserializer() - Method in class io.serverlessworkflow.api.mapper.WorkflowModule
-
- getExtensionId() - Method in interface io.serverlessworkflow.api.interfaces.Extension
-
- getExtensions() - Method in class io.serverlessworkflow.api.Workflow
-
Workflow Extensions
- getExtensionSerializer() - Method in class io.serverlessworkflow.api.mapper.WorkflowModule
-
- getFromStateData() - Method in class io.serverlessworkflow.api.filters.ActionDataFilter
-
Workflow expression that selects state data that the state action can use
- getFunctionDefs() - Method in class io.serverlessworkflow.api.workflow.Functions
-
- getFunctionRef() - Method in class io.serverlessworkflow.api.actions.Action
-
- getFunctions() - Method in class io.serverlessworkflow.api.Workflow
-
Workflow function definitions
- getGrantType() - Method in class io.serverlessworkflow.api.auth.OauthDefinition
-
Defines the grant type
(Required)
- getId() - Method in class io.serverlessworkflow.api.actions.Action
-
Unique action identifier
- getId() - Method in interface io.serverlessworkflow.api.interfaces.State
-
- getId() - Method in class io.serverlessworkflow.api.states.DefaultState
-
State unique identifier
- getId() - Method in class io.serverlessworkflow.api.Workflow
-
Workflow unique identifier
(Required)
- getIncrement() - Method in class io.serverlessworkflow.api.retry.RetryDefinition
-
Static value by which the delay increases during each attempt (ISO 8601 time format)
- getInput() - Method in class io.serverlessworkflow.api.filters.StateDataFilter
-
Workflow expression to filter the state data input
- getInputCollection() - Method in class io.serverlessworkflow.api.states.ForEachState
-
Workflow expression selecting an array element of the states data
- getInterval() - Method in class io.serverlessworkflow.api.schedule.Schedule
-
Time interval (ISO 8601 format) describing when the workflow starting state is active
- getInvoke() - Method in class io.serverlessworkflow.api.events.EventRef
-
Specifies if the function should be invoked sync or async.
- getInvoke() - Method in class io.serverlessworkflow.api.functions.FunctionRef
-
Specifies if the function should be invoked sync or async.
- getInvoke() - Method in class io.serverlessworkflow.api.functions.SubFlowRef
-
Specifies if the function should be invoked sync or async.
- getIterationParam() - Method in class io.serverlessworkflow.api.states.ForEachState
-
Name of the iteration parameter that can be referenced in actions/workflow.
- getJitter() - Method in class io.serverlessworkflow.api.retry.RetryDefinition
-
Absolute maximum amount of random time added or subtracted from the delay between each retry (ISO 8601 duration format)
- getKey() - Method in class io.serverlessworkflow.api.Workflow
-
Workflow Domain-specific identifier
- getKind() - Method in class io.serverlessworkflow.api.events.EventDefinition
-
Defines the events as either being consumed or produced by the workflow.
- getMax() - Method in class io.serverlessworkflow.api.repeat.Repeat
-
Sets the maximum amount of repeat executions
- getMaxAttempts() - Method in class io.serverlessworkflow.api.retry.RetryDefinition
-
Maximum number of retry attempts.
- getMaxDelay() - Method in class io.serverlessworkflow.api.retry.RetryDefinition
-
Maximum time delay between retry attempts (ISO 8601 duration format)
- getMessage() - Method in class io.serverlessworkflow.api.validation.ValidationError
-
- getMetadata() - Method in class io.serverlessworkflow.api.auth.BasicAuthDefinition
-
Metadata
- getMetadata() - Method in class io.serverlessworkflow.api.auth.BearerAuthDefinition
-
Metadata
- getMetadata() - Method in class io.serverlessworkflow.api.auth.OauthDefinition
-
Metadata
- getMetadata() - Method in class io.serverlessworkflow.api.events.EventDefinition
-
Metadata
- getMetadata() - Method in class io.serverlessworkflow.api.functions.FunctionDefinition
-
Metadata
- getMetadata() - Method in interface io.serverlessworkflow.api.interfaces.State
-
- getMetadata() - Method in class io.serverlessworkflow.api.states.DefaultState
-
Metadata
- getMetadata() - Method in class io.serverlessworkflow.api.Workflow
-
Metadata
- getMode() - Method in class io.serverlessworkflow.api.states.ForEachState
-
Specifies how iterations are to be performed (sequentially or in parallel)
- getMultiplier() - Method in class io.serverlessworkflow.api.retry.RetryDefinition
-
Multiplier value by which interval increases during each attempt (ISO 8601 time format)
- getName() - Method in class io.serverlessworkflow.api.actions.Action
-
Unique action definition name
- getName() - Method in class io.serverlessworkflow.api.auth.AuthDefinition
-
Unique auth definition name
- getName() - Method in class io.serverlessworkflow.api.branches.Branch
-
Branch name
- getName() - Method in class io.serverlessworkflow.api.error.ErrorDefinition
-
Domain-specific error name
(Required)
- getName() - Method in class io.serverlessworkflow.api.events.EventDefinition
-
Event Definition unique name
- getName() - Method in class io.serverlessworkflow.api.functions.FunctionDefinition
-
Function unique name
(Required)
- getName() - Method in interface io.serverlessworkflow.api.interfaces.State
-
- getName() - Method in class io.serverlessworkflow.api.retry.RetryDefinition
-
Unique retry strategy name
(Required)
- getName() - Method in class io.serverlessworkflow.api.states.DefaultState
-
Unique name of the state
(Required)
- getName() - Method in class io.serverlessworkflow.api.switchconditions.DataCondition
-
Data condition name
- getName() - Method in class io.serverlessworkflow.api.switchconditions.EventCondition
-
Event condition name
- getName() - Method in class io.serverlessworkflow.api.Workflow
-
Workflow name
(Required)
- getNextState() - Method in class io.serverlessworkflow.api.transitions.Transition
-
State to transition to next
(Required)
- getNode(String) - Static method in class io.serverlessworkflow.api.utils.Utils
-
- getNonRetryableErrors() - Method in class io.serverlessworkflow.api.actions.Action
-
List of unique references to defined workflow errors for which the action should not be retried.
- getNumCompleted() - Method in class io.serverlessworkflow.api.states.ParallelState
-
Used when completionType is set to 'atLeast' to specify the minimum number of branches that must complete before the state will transition.
- getOauth() - Method in class io.serverlessworkflow.api.auth.AuthDefinition
-
- getObjectMapper(String) - Static method in class io.serverlessworkflow.api.utils.Utils
-
- getOnErrors() - Method in interface io.serverlessworkflow.api.interfaces.State
-
- getOnErrors() - Method in class io.serverlessworkflow.api.states.DefaultState
-
State error handling definitions
- getOnEvents() - Method in class io.serverlessworkflow.api.states.EventState
-
Define what events trigger one or more actions to be performed
- getOnParentComplete() - Method in class io.serverlessworkflow.api.functions.SubFlowRef
-
If invoke is 'async', specifies how subflow execution should behave when parent workflow completes.
- getOperation() - Method in class io.serverlessworkflow.api.functions.FunctionDefinition
-
- getOutput() - Method in class io.serverlessworkflow.api.filters.StateDataFilter
-
Workflow expression that filters the state data output
- getOutputCollection() - Method in class io.serverlessworkflow.api.states.ForEachState
-
Workflow expression specifying an array element of the states data to add the results of each iteration
- getPassword() - Method in class io.serverlessworkflow.api.auth.BasicAuthDefinition
-
String or a workflow expression.
- getPassword() - Method in class io.serverlessworkflow.api.auth.OauthDefinition
-
String or a workflow expression.
- getProduceEvents() - Method in class io.serverlessworkflow.api.end.End
-
Array of events to be produced
- getProduceEvents() - Method in class io.serverlessworkflow.api.transitions.Transition
-
Array of events to be produced
- getPropertySource() - Method in interface io.serverlessworkflow.api.interfaces.WorkflowPropertySource
-
- getRefName() - Method in class io.serverlessworkflow.api.functions.FunctionRef
-
Name of the referenced function
(Required)
- getRefValue() - Method in class io.serverlessworkflow.api.workflow.Auth
-
- getRefValue() - Method in class io.serverlessworkflow.api.workflow.Constants
-
- getRefValue() - Method in class io.serverlessworkflow.api.workflow.Errors
-
- getRefValue() - Method in class io.serverlessworkflow.api.workflow.Events
-
- getRefValue() - Method in class io.serverlessworkflow.api.workflow.Functions
-
- getRefValue() - Method in class io.serverlessworkflow.api.workflow.Retries
-
- getRefValue() - Method in class io.serverlessworkflow.api.workflow.Secrets
-
- getRequestedIssuer() - Method in class io.serverlessworkflow.api.auth.OauthDefinition
-
String or a workflow expression.
- getRequestedSubject() - Method in class io.serverlessworkflow.api.auth.OauthDefinition
-
String or a workflow expression.
- getResourceFileAsString(String) - Static method in class io.serverlessworkflow.api.utils.Utils
-
- getResultEventRef() - Method in class io.serverlessworkflow.api.events.EventRef
-
Reference to the unique name of a 'consumed' event definition
(Required)
- getResultEventTimeout() - Method in class io.serverlessworkflow.api.events.EventRef
-
Maximum amount of time (ISO 8601 format) to wait for the result event.
- getResults() - Method in class io.serverlessworkflow.api.filters.ActionDataFilter
-
Workflow expression that filters the actions data results
- getRetries() - Method in class io.serverlessworkflow.api.Workflow
-
Workflow retry definitions
- getRetryableErrors() - Method in class io.serverlessworkflow.api.actions.Action
-
List of unique references to defined workflow errors for which the action should be retried.
- getRetryDefs() - Method in class io.serverlessworkflow.api.workflow.Retries
-
- getRetryRef() - Method in class io.serverlessworkflow.api.actions.Action
-
References a defined workflow retry definition.
- getRunBefore() - Method in class io.serverlessworkflow.api.timeouts.WorkflowExecTimeout
-
Name of a workflow state to be executed before workflow instance is terminated
- getSchedule() - Method in class io.serverlessworkflow.api.start.Start
-
Start state schedule definition
- getSchema() - Method in class io.serverlessworkflow.api.datainputschema.DataInputSchema
-
URI of the JSON Schema used to validate the workflow data input
(Required)
- getScheme() - Method in class io.serverlessworkflow.api.auth.AuthDefinition
-
Defines the auth type
- getScopes() - Method in class io.serverlessworkflow.api.auth.OauthDefinition
-
Array containing strings or workflow expressions.
- getSecretDefs() - Method in class io.serverlessworkflow.api.workflow.Secrets
-
- getSecrets() - Method in class io.serverlessworkflow.api.Workflow
-
Workflow secrets definitions
- getSelectionSet() - Method in class io.serverlessworkflow.api.functions.FunctionRef
-
Only used if function type is 'graphql'.
- getSingle() - Method in class io.serverlessworkflow.api.timeouts.StateExecTimeout
-
Single state execution timeout, not including retries (ISO 8601 duration format)
- getSleep() - Method in class io.serverlessworkflow.api.actions.Action
-
- getSource() - Method in class io.serverlessworkflow.api.events.EventDefinition
-
CloudEvent source UUID
- getSpecVersion() - Method in class io.serverlessworkflow.api.Workflow
-
Serverless Workflow schema version
- getStart() - Method in class io.serverlessworkflow.api.Workflow
-
State start definition
- getStateDataFilter() - Method in interface io.serverlessworkflow.api.interfaces.State
-
- getStateDataFilter() - Method in class io.serverlessworkflow.api.states.DefaultState
-
- getStateExecTimeout() - Method in class io.serverlessworkflow.api.timeouts.TimeoutsDefinition
-
- getStateName() - Method in class io.serverlessworkflow.api.start.Start
-
Name of the starting workflow state
- getStates() - Method in class io.serverlessworkflow.api.Workflow
-
State Definitions
(Required)
- getStopOnEvents() - Method in class io.serverlessworkflow.api.repeat.Repeat
-
List referencing defined consumed workflow events.
- getSubFlowRef() - Method in class io.serverlessworkflow.api.actions.Action
-
- getSubjectToken() - Method in class io.serverlessworkflow.api.auth.OauthDefinition
-
String or a workflow expression.
- getSvgDiagram() - Method in interface io.serverlessworkflow.api.interfaces.WorkflowDiagram
-
- getTimeouts() - Method in class io.serverlessworkflow.api.branches.Branch
-
Timeouts Definition
- getTimeouts() - Method in interface io.serverlessworkflow.api.interfaces.State
-
- getTimeouts() - Method in class io.serverlessworkflow.api.states.DefaultState
-
Timeouts Definition
- getTimeouts() - Method in class io.serverlessworkflow.api.Workflow
-
Timeouts Definition
- getTimezone() - Method in class io.serverlessworkflow.api.schedule.Schedule
-
Timezone name used to evaluate the cron expression.
- getToken() - Method in class io.serverlessworkflow.api.auth.BearerAuthDefinition
-
String or a workflow expression.
- getToStateData() - Method in class io.serverlessworkflow.api.filters.ActionDataFilter
-
Workflow expression that selects a state data element to which the action results should be added/merged into.
- getToStateData() - Method in class io.serverlessworkflow.api.filters.EventDataFilter
-
Workflow expression that selects a state data element to which the event payload should be added/merged into.
- getTotal() - Method in class io.serverlessworkflow.api.timeouts.StateExecTimeout
-
Total state execution timeout, including retries (ISO 8601 duration format)
(Required)
- getTransition() - Method in class io.serverlessworkflow.api.defaultdef.DefaultConditionDefinition
-
- getTransition() - Method in class io.serverlessworkflow.api.error.Error
-
(Required)
- getTransition() - Method in interface io.serverlessworkflow.api.interfaces.State
-
- getTransition() - Method in class io.serverlessworkflow.api.states.DefaultState
-
- getTransition() - Method in class io.serverlessworkflow.api.switchconditions.DataCondition
-
(Required)
- getTransition() - Method in class io.serverlessworkflow.api.switchconditions.EventCondition
-
(Required)
- getTriggerEventRef() - Method in class io.serverlessworkflow.api.events.EventRef
-
Reference to the unique name of a 'produced' event definition
(Required)
- getType() - Method in class io.serverlessworkflow.api.events.EventDefinition
-
CloudEvent type
- getType() - Method in class io.serverlessworkflow.api.functions.FunctionDefinition
-
Defines the function type.
- getType() - Method in interface io.serverlessworkflow.api.interfaces.State
-
- getType() - Method in class io.serverlessworkflow.api.states.DefaultState
-
State type
(Required)
- getType() - Method in class io.serverlessworkflow.api.validation.ValidationError
-
- getUsername() - Method in class io.serverlessworkflow.api.auth.BasicAuthDefinition
-
String or a workflow expression.
- getUsername() - Method in class io.serverlessworkflow.api.auth.OauthDefinition
-
String or a workflow expression.
- getValidUntil() - Method in class io.serverlessworkflow.api.cron.Cron
-
Specific date and time (ISO 8601 format) when the cron expression invocation is no longer valid
- getVersion() - Method in class io.serverlessworkflow.api.end.ContinueAs
-
Version of the workflow to continue execution as
- getVersion() - Method in class io.serverlessworkflow.api.functions.SubFlowRef
-
Version of the sub-workflow to be invoked
- getVersion() - Method in class io.serverlessworkflow.api.Workflow
-
Workflow version
(Required)
- getWorkflowExecTimeout() - Method in class io.serverlessworkflow.api.end.ContinueAs
-
- getWorkflowExecTimeout() - Method in class io.serverlessworkflow.api.timeouts.TimeoutsDefinition
-
- getWorkflowId() - Method in class io.serverlessworkflow.api.end.ContinueAs
-
Unique id of the workflow to continue execution as
- getWorkflowId() - Method in class io.serverlessworkflow.api.functions.SubFlowRef
-
Unique id of the sub-workflow to be invoked
(Required)
- getWorkflowModule() - Method in class io.serverlessworkflow.api.mapper.BaseObjectMapper
-
- getWorkflowSchema() - Static method in class io.serverlessworkflow.api.validation.WorkflowSchemaLoader
-
- Schedule - Class in io.serverlessworkflow.api.schedule
-
Start state schedule definition
- Schedule() - Constructor for class io.serverlessworkflow.api.schedule.Schedule
-
- ScheduleDeserializer - Class in io.serverlessworkflow.api.deserializers
-
- ScheduleDeserializer() - Constructor for class io.serverlessworkflow.api.deserializers.ScheduleDeserializer
-
- ScheduleDeserializer(Class<?>) - Constructor for class io.serverlessworkflow.api.deserializers.ScheduleDeserializer
-
- ScheduleDeserializer(WorkflowPropertySource) - Constructor for class io.serverlessworkflow.api.deserializers.ScheduleDeserializer
-
- ScheduleSerializer - Class in io.serverlessworkflow.api.serializers
-
- ScheduleSerializer() - Constructor for class io.serverlessworkflow.api.serializers.ScheduleSerializer
-
- ScheduleSerializer(Class<Schedule>) - Constructor for class io.serverlessworkflow.api.serializers.ScheduleSerializer
-
- SCHEMA_VALIDATION - Static variable in class io.serverlessworkflow.api.validation.ValidationError
-
- Secrets - Class in io.serverlessworkflow.api.workflow
-
- Secrets() - Constructor for class io.serverlessworkflow.api.workflow.Secrets
-
- Secrets(String) - Constructor for class io.serverlessworkflow.api.workflow.Secrets
-
- Secrets(List<String>) - Constructor for class io.serverlessworkflow.api.workflow.Secrets
-
- SecretsDeserializer - Class in io.serverlessworkflow.api.deserializers
-
- SecretsDeserializer() - Constructor for class io.serverlessworkflow.api.deserializers.SecretsDeserializer
-
- SecretsDeserializer(Class<?>) - Constructor for class io.serverlessworkflow.api.deserializers.SecretsDeserializer
-
- SecretsDeserializer(WorkflowPropertySource) - Constructor for class io.serverlessworkflow.api.deserializers.SecretsDeserializer
-
- serialize(AuthDefinition, JsonGenerator, SerializerProvider) - Method in class io.serverlessworkflow.api.serializers.AuthDefinitionSerializer
-
- serialize(CallbackState, JsonGenerator, SerializerProvider) - Method in class io.serverlessworkflow.api.serializers.CallbackStateSerializer
-
- serialize(ContinueAs, JsonGenerator, SerializerProvider) - Method in class io.serverlessworkflow.api.serializers.ContinueAsSerializer
-
- serialize(Cron, JsonGenerator, SerializerProvider) - Method in class io.serverlessworkflow.api.serializers.CronSerializer
-
- serialize(End, JsonGenerator, SerializerProvider) - Method in class io.serverlessworkflow.api.serializers.EndDefinitionSerializer
-
- serialize(EventDefinition, JsonGenerator, SerializerProvider) - Method in class io.serverlessworkflow.api.serializers.EventDefinitionSerializer
-
- serialize(EventState, JsonGenerator, SerializerProvider) - Method in class io.serverlessworkflow.api.serializers.EventStateSerializer
-
- serialize(Extension, JsonGenerator, SerializerProvider) - Method in class io.serverlessworkflow.api.serializers.ExtensionSerializer
-
- serialize(ForEachState, JsonGenerator, SerializerProvider) - Method in class io.serverlessworkflow.api.serializers.ForEachStateSerializer
-
- serialize(FunctionRef, JsonGenerator, SerializerProvider) - Method in class io.serverlessworkflow.api.serializers.FunctionRefSerializer
-
- serialize(InjectState, JsonGenerator, SerializerProvider) - Method in class io.serverlessworkflow.api.serializers.InjectStateSerializer
-
- serialize(OperationState, JsonGenerator, SerializerProvider) - Method in class io.serverlessworkflow.api.serializers.OperationStateSerializer
-
- serialize(ParallelState, JsonGenerator, SerializerProvider) - Method in class io.serverlessworkflow.api.serializers.ParallelStateSerializer
-
- serialize(Schedule, JsonGenerator, SerializerProvider) - Method in class io.serverlessworkflow.api.serializers.ScheduleSerializer
-
- serialize(SleepState, JsonGenerator, SerializerProvider) - Method in class io.serverlessworkflow.api.serializers.SleepStateSerializer
-
- serialize(Start, JsonGenerator, SerializerProvider) - Method in class io.serverlessworkflow.api.serializers.StartDefinitionSerializer
-
- serialize(StateExecTimeout, JsonGenerator, SerializerProvider) - Method in class io.serverlessworkflow.api.serializers.StateExecTimeoutSerializer
-
- serialize(SubFlowRef, JsonGenerator, SerializerProvider) - Method in class io.serverlessworkflow.api.serializers.SubFlowRefSerializer
-
- serialize(SwitchState, JsonGenerator, SerializerProvider) - Method in class io.serverlessworkflow.api.serializers.SwitchStateSerializer
-
- serialize(Transition, JsonGenerator, SerializerProvider) - Method in class io.serverlessworkflow.api.serializers.TransitionSerializer
-
- serialize(Workflow, JsonGenerator, SerializerProvider) - Method in class io.serverlessworkflow.api.serializers.WorkflowSerializer
-
- setAction(Action) - Method in class io.serverlessworkflow.api.states.CallbackState
-
Action Definition
- setActionDataFilter(ActionDataFilter) - Method in class io.serverlessworkflow.api.actions.Action
-
- setActionExecTimeout(String) - Method in class io.serverlessworkflow.api.timeouts.TimeoutsDefinition
-
Single actions definition execution timeout duration (ISO 8601 duration format)
- setActionMode(OnEvents.ActionMode) - Method in class io.serverlessworkflow.api.events.OnEvents
-
Specifies how actions are to be performed (in sequence of parallel)
- setActionMode(OperationState.ActionMode) - Method in class io.serverlessworkflow.api.states.OperationState
-
Specifies whether functions are executed in sequence or in parallel.
- setActions(List<Action>) - Method in class io.serverlessworkflow.api.branches.Branch
-
Actions to be executed in this branch
- setActions(List<Action>) - Method in class io.serverlessworkflow.api.events.OnEvents
-
Actions to be performed.
- setActions(List<Action>) - Method in class io.serverlessworkflow.api.states.ForEachState
-
Actions to be executed for each of the elements of inputCollection
- setActions(List<Action>) - Method in class io.serverlessworkflow.api.states.OperationState
-
Actions Definitions
(Required)
- setAfter(String) - Method in class io.serverlessworkflow.api.sleep.Sleep
-
Amount of time (ISO 8601 duration format) to sleep after function/subflow invocation.
- setAnnotations(List<String>) - Method in class io.serverlessworkflow.api.Workflow
-
List of helpful terms describing the workflows intended purpose, subject areas, or other important qualities
- setArguments(JsonNode) - Method in class io.serverlessworkflow.api.functions.FunctionRef
-
Function arguments
- setAudiences(List<String>) - Method in class io.serverlessworkflow.api.auth.OauthDefinition
-
Array containing strings or workflow expressions.
- setAuth(Auth) - Method in class io.serverlessworkflow.api.Workflow
-
Workflow Auth definitions
- setAuthDefs(List<AuthDefinition>) - Method in class io.serverlessworkflow.api.workflow.Auth
-
- setAuthority(String) - Method in class io.serverlessworkflow.api.auth.OauthDefinition
-
String or a workflow expression.
- setAuthRef(String) - Method in class io.serverlessworkflow.api.functions.FunctionDefinition
-
References an auth definition name to be used to access to resource defined in the operation parameter
- setAutoRetries(boolean) - Method in class io.serverlessworkflow.api.Workflow
-
If set to true, actions should automatically be retried on unchecked errors.
- setBasicauth(BasicAuthDefinition) - Method in class io.serverlessworkflow.api.auth.AuthDefinition
-
- setBatchSize(int) - Method in class io.serverlessworkflow.api.states.ForEachState
-
Specifies how many iterations may run in parallel at the same time.
- setBearerauth(BearerAuthDefinition) - Method in class io.serverlessworkflow.api.auth.AuthDefinition
-
- setBefore(String) - Method in class io.serverlessworkflow.api.sleep.Sleep
-
Amount of time (ISO 8601 duration format) to sleep before function/subflow invocation.
- setBranches(List<Branch>) - Method in class io.serverlessworkflow.api.states.ParallelState
-
Branch Definitions
(Required)
- setBranchExecTimeout(String) - Method in class io.serverlessworkflow.api.timeouts.TimeoutsDefinition
-
Single branch execution timeout duration (ISO 8601 duration format)
- setCheckBefore(boolean) - Method in class io.serverlessworkflow.api.repeat.Repeat
-
If true, the expression is evaluated before each repeat execution, if false the expression is evaluated after each repeat execution
- setClientId(String) - Method in class io.serverlessworkflow.api.auth.OauthDefinition
-
String or a workflow expression.
- setClientSecret(String) - Method in class io.serverlessworkflow.api.auth.OauthDefinition
-
Workflow secret or a workflow expression.
- setCode(String) - Method in class io.serverlessworkflow.api.error.ErrorDefinition
-
Error code.
- setCompensate(boolean) - Method in class io.serverlessworkflow.api.end.End
-
If set to true, triggers workflow compensation when before workflow executin completes.
- setCompensate(boolean) - Method in class io.serverlessworkflow.api.transitions.Transition
-
If set to true, triggers workflow compensation before this transition is taken.
- setCompensatedBy(String) - Method in class io.serverlessworkflow.api.states.DefaultState
-
Unique Name of a workflow state which is responsible for compensation of this state
- setCompletionType(ParallelState.CompletionType) - Method in class io.serverlessworkflow.api.states.ParallelState
-
Option types on how to complete branch execution.
- setCondition(String) - Method in class io.serverlessworkflow.api.actions.Action
-
Expression, if defined, must evaluate to true for this action to be performed.
- setCondition(String) - Method in class io.serverlessworkflow.api.switchconditions.DataCondition
-
Workflow expression evaluated against state data.
- setConstants(Constants) - Method in class io.serverlessworkflow.api.Workflow
-
Workflow constants definitions
- setConstantsDef(JsonNode) - Method in class io.serverlessworkflow.api.workflow.Constants
-
- setContextAttributeName(String) - Method in class io.serverlessworkflow.api.correlation.CorrelationDef
-
CloudEvent Extension Context Attribute name
(Required)
- setContextAttributes(Map<String, String>) - Method in class io.serverlessworkflow.api.events.EventRef
-
Add additional extension context attributes to the produced event
- setContextAttributes(Map<String, String>) - Method in class io.serverlessworkflow.api.produce.ProduceEvent
-
Add additional event extension context attributes
- setContextAttributeValue(String) - Method in class io.serverlessworkflow.api.correlation.CorrelationDef
-
CloudEvent Extension Context Attribute value
- setContinueAs(ContinueAs) - Method in class io.serverlessworkflow.api.end.End
-
End definition continue as
- setContinueOnError(boolean) - Method in class io.serverlessworkflow.api.repeat.Repeat
-
If true, repeats executions in a case unhandled errors propagate from the sub-workflow to this state
- setCorrelation(List<CorrelationDef>) - Method in class io.serverlessworkflow.api.events.EventDefinition
-
CloudEvent correlation definitions
- setCron(Cron) - Method in class io.serverlessworkflow.api.schedule.Schedule
-
Schedule cron definition
- setData(String) - Method in class io.serverlessworkflow.api.end.ContinueAs
-
Expression which selects parts of the states data output to become the workflow data input of continued execution
- setData(String) - Method in class io.serverlessworkflow.api.events.EventRef
-
Expression which selects parts of the states data output to become the data of the produced event.
- setData(String) - Method in class io.serverlessworkflow.api.filters.EventDataFilter
-
Workflow expression that filters of the event data (payload)
- setData(String) - Method in class io.serverlessworkflow.api.produce.ProduceEvent
-
Workflow expression which selects parts of the states data output to become the data of the produced event
- setData(JsonNode) - Method in class io.serverlessworkflow.api.states.InjectState
-
JSON object which can be set as states data input and can be manipulated via filters
- setDataConditions(List<DataCondition>) - Method in class io.serverlessworkflow.api.states.SwitchState
-
Defines conditions evaluated against state data
- setDataInputSchema(DataInputSchema) - Method in class io.serverlessworkflow.api.Workflow
-
Workflow data input schema
- setDataOnly(boolean) - Method in class io.serverlessworkflow.api.events.EventDefinition
-
If `true`, only the Event payload is accessible to consuming Workflow states.
- setDefaultCondition(DefaultConditionDefinition) - Method in class io.serverlessworkflow.api.states.SwitchState
-
Switch state default condition definition
- setDelay(String) - Method in class io.serverlessworkflow.api.retry.RetryDefinition
-
Time delay between retry attempts (ISO 8601 duration format)
- setDescription(String) - Method in class io.serverlessworkflow.api.error.ErrorDefinition
-
Error description
- setDescription(String) - Method in class io.serverlessworkflow.api.Workflow
-
Workflow description
- setDuration(String) - Method in class io.serverlessworkflow.api.states.SleepState
-
Duration (ISO 8601 duration format) to sleep
(Required)
- setDuration(String) - Method in class io.serverlessworkflow.api.timeouts.WorkflowExecTimeout
-
Workflow execution timeout duration (ISO 8601 duration format).
- setEnd(End) - Method in class io.serverlessworkflow.api.defaultdef.DefaultConditionDefinition
-
State end definition
- setEnd(End) - Method in class io.serverlessworkflow.api.error.Error
-
State end definition
- setEnd(End) - Method in class io.serverlessworkflow.api.states.DefaultState
-
State end definition
- setEnd(End) - Method in class io.serverlessworkflow.api.switchconditions.DataCondition
-
State end definition
- setEnd(End) - Method in class io.serverlessworkflow.api.switchconditions.EventCondition
-
State end definition
- setErrorDefs(List<ErrorDefinition>) - Method in class io.serverlessworkflow.api.workflow.Errors
-
- setErrorRef(String) - Method in class io.serverlessworkflow.api.error.Error
-
Reference to a unique workflow error definition.
- setErrorRefs(List<String>) - Method in class io.serverlessworkflow.api.error.Error
-
References one or more workflow error definitions.
- setErrors(Errors) - Method in class io.serverlessworkflow.api.Workflow
-
Workflow error definitions
- setEventConditions(List<EventCondition>) - Method in class io.serverlessworkflow.api.states.SwitchState
-
Defines conditions evaluated against events
- setEventDataFilter(EventDataFilter) - Method in class io.serverlessworkflow.api.events.OnEvents
-
- setEventDataFilter(EventDataFilter) - Method in class io.serverlessworkflow.api.states.CallbackState
-
- setEventDataFilter(EventDataFilter) - Method in class io.serverlessworkflow.api.switchconditions.EventCondition
-
- setEventDefs(List<EventDefinition>) - Method in class io.serverlessworkflow.api.workflow.Events
-
- setEventRef(EventRef) - Method in class io.serverlessworkflow.api.actions.Action
-
Event References
- setEventRef(String) - Method in class io.serverlessworkflow.api.produce.ProduceEvent
-
References a name of a defined event
(Required)
- setEventRef(String) - Method in class io.serverlessworkflow.api.states.CallbackState
-
References an unique callback event name in the defined workflow events
- setEventRef(String) - Method in class io.serverlessworkflow.api.switchconditions.EventCondition
-
References an unique event name in the defined workflow events
(Required)
- setEventRefs(List<String>) - Method in class io.serverlessworkflow.api.events.OnEvents
-
References one or more unique event names in the defined workflow events
(Required)
- setEvents(Events) - Method in class io.serverlessworkflow.api.Workflow
-
Workflow event definitions
- setEventTimeout(String) - Method in class io.serverlessworkflow.api.timeouts.TimeoutsDefinition
-
Timeout duration to wait for consuming defined events (ISO 8601 duration format)
- setExclusive(boolean) - Method in class io.serverlessworkflow.api.states.EventState
-
If true consuming one of the defined events causes its associated actions to be performed.
- setExpression(String) - Method in class io.serverlessworkflow.api.cron.Cron
-
Repeating interval (cron expression) describing when the workflow instance should be created
(Required)
- setExpression(String) - Method in class io.serverlessworkflow.api.repeat.Repeat
-
Expression evaluated against SubFlow state data.
- setExpressionLang(String) - Method in class io.serverlessworkflow.api.Workflow
-
Identifies the expression language used for workflow expressions.
- setExtensions(List<Extension>) - Method in class io.serverlessworkflow.api.Workflow
-
Workflow Extensions
- setFailOnValidationErrors(boolean) - Method in class io.serverlessworkflow.api.datainputschema.DataInputSchema
-
Determines if workfow execution should continue if there are validation errors
(Required)
- setFromStateData(String) - Method in class io.serverlessworkflow.api.filters.ActionDataFilter
-
Workflow expression that selects state data that the state action can use
- setFunctionDefs(List<FunctionDefinition>) - Method in class io.serverlessworkflow.api.workflow.Functions
-
- setFunctionRef(FunctionRef) - Method in class io.serverlessworkflow.api.actions.Action
-
- setFunctions(Functions) - Method in class io.serverlessworkflow.api.Workflow
-
Workflow function definitions
- setGrantType(OauthDefinition.GrantType) - Method in class io.serverlessworkflow.api.auth.OauthDefinition
-
Defines the grant type
(Required)
- setId(String) - Method in class io.serverlessworkflow.api.actions.Action
-
Unique action identifier
- setId(String) - Method in class io.serverlessworkflow.api.states.DefaultState
-
State unique identifier
- setId(String) - Method in class io.serverlessworkflow.api.Workflow
-
Workflow unique identifier
(Required)
- setIncrement(String) - Method in class io.serverlessworkflow.api.retry.RetryDefinition
-
Static value by which the delay increases during each attempt (ISO 8601 time format)
- setInput(String) - Method in class io.serverlessworkflow.api.filters.StateDataFilter
-
Workflow expression to filter the state data input
- setInputCollection(String) - Method in class io.serverlessworkflow.api.states.ForEachState
-
Workflow expression selecting an array element of the states data
- setInterrupt(boolean) - Method in class io.serverlessworkflow.api.timeouts.WorkflowExecTimeout
-
If `false`, workflow instance is allowed to finish current execution.
- setInterval(String) - Method in class io.serverlessworkflow.api.schedule.Schedule
-
Time interval (ISO 8601 format) describing when the workflow starting state is active
- setInvoke(EventRef.Invoke) - Method in class io.serverlessworkflow.api.events.EventRef
-
Specifies if the function should be invoked sync or async.
- setInvoke(FunctionRef.Invoke) - Method in class io.serverlessworkflow.api.functions.FunctionRef
-
Specifies if the function should be invoked sync or async.
- setInvoke(SubFlowRef.Invoke) - Method in class io.serverlessworkflow.api.functions.SubFlowRef
-
Specifies if the function should be invoked sync or async.
- setIterationParam(String) - Method in class io.serverlessworkflow.api.states.ForEachState
-
Name of the iteration parameter that can be referenced in actions/workflow.
- setJitter(String) - Method in class io.serverlessworkflow.api.retry.RetryDefinition
-
Absolute maximum amount of random time added or subtracted from the delay between each retry (ISO 8601 duration format)
- setKeepActive(boolean) - Method in class io.serverlessworkflow.api.Workflow
-
If 'true', workflow instances is not terminated when there are no active execution paths.
- setKey(String) - Method in class io.serverlessworkflow.api.Workflow
-
Workflow Domain-specific identifier
- setKind(EventDefinition.Kind) - Method in class io.serverlessworkflow.api.events.EventDefinition
-
Defines the events as either being consumed or produced by the workflow.
- setMax(int) - Method in class io.serverlessworkflow.api.repeat.Repeat
-
Sets the maximum amount of repeat executions
- setMaxAttempts(String) - Method in class io.serverlessworkflow.api.retry.RetryDefinition
-
Maximum number of retry attempts.
- setMaxDelay(String) - Method in class io.serverlessworkflow.api.retry.RetryDefinition
-
Maximum time delay between retry attempts (ISO 8601 duration format)
- setMessage(String) - Method in class io.serverlessworkflow.api.validation.ValidationError
-
- setMetadata(Map<String, String>) - Method in class io.serverlessworkflow.api.auth.BasicAuthDefinition
-
Metadata
- setMetadata(Map<String, String>) - Method in class io.serverlessworkflow.api.auth.BearerAuthDefinition
-
Metadata
- setMetadata(Map<String, String>) - Method in class io.serverlessworkflow.api.auth.OauthDefinition
-
Metadata
- setMetadata(Map<String, String>) - Method in class io.serverlessworkflow.api.events.EventDefinition
-
Metadata
- setMetadata(Map<String, String>) - Method in class io.serverlessworkflow.api.functions.FunctionDefinition
-
Metadata
- setMetadata(Map<String, String>) - Method in class io.serverlessworkflow.api.states.DefaultState
-
Metadata
- setMetadata(Map<String, String>) - Method in class io.serverlessworkflow.api.Workflow
-
Metadata
- setMode(ForEachState.Mode) - Method in class io.serverlessworkflow.api.states.ForEachState
-
Specifies how iterations are to be performed (sequentially or in parallel)
- setMultiplier(String) - Method in class io.serverlessworkflow.api.retry.RetryDefinition
-
Multiplier value by which interval increases during each attempt (ISO 8601 time format)
- setName(String) - Method in class io.serverlessworkflow.api.actions.Action
-
Unique action definition name
- setName(String) - Method in class io.serverlessworkflow.api.auth.AuthDefinition
-
Unique auth definition name
- setName(String) - Method in class io.serverlessworkflow.api.branches.Branch
-
Branch name
- setName(String) - Method in class io.serverlessworkflow.api.error.ErrorDefinition
-
Domain-specific error name
(Required)
- setName(String) - Method in class io.serverlessworkflow.api.events.EventDefinition
-
Event Definition unique name
- setName(String) - Method in class io.serverlessworkflow.api.functions.FunctionDefinition
-
Function unique name
(Required)
- setName(String) - Method in class io.serverlessworkflow.api.retry.RetryDefinition
-
Unique retry strategy name
(Required)
- setName(String) - Method in class io.serverlessworkflow.api.states.DefaultState
-
Unique name of the state
(Required)
- setName(String) - Method in class io.serverlessworkflow.api.switchconditions.DataCondition
-
Data condition name
- setName(String) - Method in class io.serverlessworkflow.api.switchconditions.EventCondition
-
Event condition name
- setName(String) - Method in class io.serverlessworkflow.api.Workflow
-
Workflow name
(Required)
- setNextState(String) - Method in class io.serverlessworkflow.api.transitions.Transition
-
State to transition to next
(Required)
- setNonRetryableErrors(List<String>) - Method in class io.serverlessworkflow.api.actions.Action
-
List of unique references to defined workflow errors for which the action should not be retried.
- setNumCompleted(String) - Method in class io.serverlessworkflow.api.states.ParallelState
-
Used when completionType is set to 'atLeast' to specify the minimum number of branches that must complete before the state will transition.
- setOauth(OauthDefinition) - Method in class io.serverlessworkflow.api.auth.AuthDefinition
-
- setOnErrors(List<Error>) - Method in class io.serverlessworkflow.api.states.DefaultState
-
State error handling definitions
- setOnEvents(List<OnEvents>) - Method in class io.serverlessworkflow.api.states.EventState
-
Define what events trigger one or more actions to be performed
- setOnParentComplete(SubFlowRef.OnParentComplete) - Method in class io.serverlessworkflow.api.functions.SubFlowRef
-
If invoke is 'async', specifies how subflow execution should behave when parent workflow completes.
- setOperation(String) - Method in class io.serverlessworkflow.api.functions.FunctionDefinition
-
- setOutput(String) - Method in class io.serverlessworkflow.api.filters.StateDataFilter
-
Workflow expression that filters the state data output
- setOutputCollection(String) - Method in class io.serverlessworkflow.api.states.ForEachState
-
Workflow expression specifying an array element of the states data to add the results of each iteration
- setPassword(String) - Method in class io.serverlessworkflow.api.auth.BasicAuthDefinition
-
String or a workflow expression.
- setPassword(String) - Method in class io.serverlessworkflow.api.auth.OauthDefinition
-
String or a workflow expression.
- setProduceEvents(List<ProduceEvent>) - Method in class io.serverlessworkflow.api.end.End
-
Array of events to be produced
- setProduceEvents(List<ProduceEvent>) - Method in class io.serverlessworkflow.api.transitions.Transition
-
Array of events to be produced
- setPropertySource(Properties) - Method in interface io.serverlessworkflow.api.interfaces.WorkflowPropertySource
-
- setRefName(String) - Method in class io.serverlessworkflow.api.functions.FunctionRef
-
Name of the referenced function
(Required)
- setRefValue(String) - Method in class io.serverlessworkflow.api.workflow.Auth
-
- setRefValue(String) - Method in class io.serverlessworkflow.api.workflow.Constants
-
- setRefValue(String) - Method in class io.serverlessworkflow.api.workflow.Errors
-
- setRefValue(String) - Method in class io.serverlessworkflow.api.workflow.Events
-
- setRefValue(String) - Method in class io.serverlessworkflow.api.workflow.Functions
-
- setRefValue(String) - Method in class io.serverlessworkflow.api.workflow.Retries
-
- setRefValue(String) - Method in class io.serverlessworkflow.api.workflow.Secrets
-
- setRequestedIssuer(String) - Method in class io.serverlessworkflow.api.auth.OauthDefinition
-
String or a workflow expression.
- setRequestedSubject(String) - Method in class io.serverlessworkflow.api.auth.OauthDefinition
-
String or a workflow expression.
- setResultEventRef(String) - Method in class io.serverlessworkflow.api.events.EventRef
-
Reference to the unique name of a 'consumed' event definition
(Required)
- setResultEventTimeout(String) - Method in class io.serverlessworkflow.api.events.EventRef
-
Maximum amount of time (ISO 8601 format) to wait for the result event.
- setResults(String) - Method in class io.serverlessworkflow.api.filters.ActionDataFilter
-
Workflow expression that filters the actions data results
- setRetries(Retries) - Method in class io.serverlessworkflow.api.Workflow
-
Workflow retry definitions
- setRetryableErrors(List<String>) - Method in class io.serverlessworkflow.api.actions.Action
-
List of unique references to defined workflow errors for which the action should be retried.
- setRetryDefs(List<RetryDefinition>) - Method in class io.serverlessworkflow.api.workflow.Retries
-
- setRetryRef(String) - Method in class io.serverlessworkflow.api.actions.Action
-
References a defined workflow retry definition.
- setRunBefore(String) - Method in class io.serverlessworkflow.api.timeouts.WorkflowExecTimeout
-
Name of a workflow state to be executed before workflow instance is terminated
- setSchedule(Schedule) - Method in class io.serverlessworkflow.api.start.Start
-
Start state schedule definition
- setSchema(String) - Method in class io.serverlessworkflow.api.datainputschema.DataInputSchema
-
URI of the JSON Schema used to validate the workflow data input
(Required)
- setSchemaValidationEnabled(boolean) - Method in interface io.serverlessworkflow.api.interfaces.WorkflowValidator
-
- setScheme(AuthDefinition.Scheme) - Method in class io.serverlessworkflow.api.auth.AuthDefinition
-
Defines the auth type
- setScopes(List<String>) - Method in class io.serverlessworkflow.api.auth.OauthDefinition
-
Array containing strings or workflow expressions.
- setSecretDefs(List<String>) - Method in class io.serverlessworkflow.api.workflow.Secrets
-
- setSecrets(Secrets) - Method in class io.serverlessworkflow.api.Workflow
-
Workflow secrets definitions
- setSelectionSet(String) - Method in class io.serverlessworkflow.api.functions.FunctionRef
-
Only used if function type is 'graphql'.
- setSingle(String) - Method in class io.serverlessworkflow.api.timeouts.StateExecTimeout
-
Single state execution timeout, not including retries (ISO 8601 duration format)
- setSleep(Sleep) - Method in class io.serverlessworkflow.api.actions.Action
-
- setSource(String) - Method in class io.serverlessworkflow.api.events.EventDefinition
-
CloudEvent source UUID
- setSource(String) - Method in interface io.serverlessworkflow.api.interfaces.WorkflowDiagram
-
- setSource(String) - Method in interface io.serverlessworkflow.api.interfaces.WorkflowValidator
-
- setSpecVersion(String) - Method in class io.serverlessworkflow.api.Workflow
-
Serverless Workflow schema version
- setStart(Start) - Method in class io.serverlessworkflow.api.Workflow
-
State start definition
- setStateDataFilter(StateDataFilter) - Method in class io.serverlessworkflow.api.states.DefaultState
-
- setStateExecTimeout(StateExecTimeout) - Method in class io.serverlessworkflow.api.timeouts.TimeoutsDefinition
-
- setStateName(String) - Method in class io.serverlessworkflow.api.start.Start
-
Name of the starting workflow state
- setStates(List<State>) - Method in class io.serverlessworkflow.api.Workflow
-
State Definitions
(Required)
- setStopOnEvents(List<String>) - Method in class io.serverlessworkflow.api.repeat.Repeat
-
List referencing defined consumed workflow events.
- setSubFlowRef(SubFlowRef) - Method in class io.serverlessworkflow.api.actions.Action
-
- setSubjectToken(String) - Method in class io.serverlessworkflow.api.auth.OauthDefinition
-
String or a workflow expression.
- setTemplate(String) - Method in interface io.serverlessworkflow.api.interfaces.WorkflowDiagram
-
- setTerminate(boolean) - Method in class io.serverlessworkflow.api.end.End
-
If true, completes all execution flows in the given workflow instance
- setTimeouts(TimeoutsDefinition) - Method in class io.serverlessworkflow.api.branches.Branch
-
Timeouts Definition
- setTimeouts(TimeoutsDefinition) - Method in class io.serverlessworkflow.api.states.DefaultState
-
Timeouts Definition
- setTimeouts(TimeoutsDefinition) - Method in class io.serverlessworkflow.api.Workflow
-
Timeouts Definition
- setTimezone(String) - Method in class io.serverlessworkflow.api.schedule.Schedule
-
Timezone name used to evaluate the cron expression.
- setToken(String) - Method in class io.serverlessworkflow.api.auth.BearerAuthDefinition
-
String or a workflow expression.
- setToStateData(String) - Method in class io.serverlessworkflow.api.filters.ActionDataFilter
-
Workflow expression that selects a state data element to which the action results should be added/merged into.
- setToStateData(String) - Method in class io.serverlessworkflow.api.filters.EventDataFilter
-
Workflow expression that selects a state data element to which the event payload should be added/merged into.
- setTotal(String) - Method in class io.serverlessworkflow.api.timeouts.StateExecTimeout
-
Total state execution timeout, including retries (ISO 8601 duration format)
(Required)
- setTransition(Transition) - Method in class io.serverlessworkflow.api.defaultdef.DefaultConditionDefinition
-
- setTransition(Transition) - Method in class io.serverlessworkflow.api.error.Error
-
(Required)
- setTransition(Transition) - Method in class io.serverlessworkflow.api.states.DefaultState
-
- setTransition(Transition) - Method in class io.serverlessworkflow.api.switchconditions.DataCondition
-
(Required)
- setTransition(Transition) - Method in class io.serverlessworkflow.api.switchconditions.EventCondition
-
(Required)
- setTriggerEventRef(String) - Method in class io.serverlessworkflow.api.events.EventRef
-
Reference to the unique name of a 'produced' event definition
(Required)
- setType(String) - Method in class io.serverlessworkflow.api.events.EventDefinition
-
CloudEvent type
- setType(FunctionDefinition.Type) - Method in class io.serverlessworkflow.api.functions.FunctionDefinition
-
Defines the function type.
- setType(DefaultState.Type) - Method in class io.serverlessworkflow.api.states.DefaultState
-
State type
(Required)
- setType(String) - Method in class io.serverlessworkflow.api.validation.ValidationError
-
- setUseData(boolean) - Method in class io.serverlessworkflow.api.filters.EventDataFilter
-
If set to false, event payload is not added/merged to state data.
- setUsedForCompensation(boolean) - Method in class io.serverlessworkflow.api.states.CallbackState
-
If true, this state is used to compensate another state.
- setUsedForCompensation(boolean) - Method in class io.serverlessworkflow.api.states.ForEachState
-
If true, this state is used to compensate another state.
- setUsedForCompensation(boolean) - Method in class io.serverlessworkflow.api.states.InjectState
-
If true, this state is used to compensate another state.
- setUsedForCompensation(boolean) - Method in class io.serverlessworkflow.api.states.OperationState
-
If true, this state is used to compensate another state.
- setUsedForCompensation(boolean) - Method in class io.serverlessworkflow.api.states.ParallelState
-
If true, this state is used to compensate another state.
- setUsedForCompensation(boolean) - Method in class io.serverlessworkflow.api.states.SleepState
-
If true, this state is used to compensate another state.
- setUsedForCompensation(boolean) - Method in class io.serverlessworkflow.api.states.SwitchState
-
If true, this state is used to compensate another state.
- setUseResults(boolean) - Method in class io.serverlessworkflow.api.filters.ActionDataFilter
-
If set to false, action data results are not added/merged to state data.
- setUsername(String) - Method in class io.serverlessworkflow.api.auth.BasicAuthDefinition
-
String or a workflow expression.
- setUsername(String) - Method in class io.serverlessworkflow.api.auth.OauthDefinition
-
String or a workflow expression.
- setValidUntil(String) - Method in class io.serverlessworkflow.api.cron.Cron
-
Specific date and time (ISO 8601 format) when the cron expression invocation is no longer valid
- setVersion(String) - Method in class io.serverlessworkflow.api.end.ContinueAs
-
Version of the workflow to continue execution as
- setVersion(String) - Method in class io.serverlessworkflow.api.functions.SubFlowRef
-
Version of the sub-workflow to be invoked
- setVersion(String) - Method in class io.serverlessworkflow.api.Workflow
-
Workflow version
(Required)
- setWorkflow(Workflow) - Method in interface io.serverlessworkflow.api.interfaces.WorkflowDiagram
-
- setWorkflow(Workflow) - Method in interface io.serverlessworkflow.api.interfaces.WorkflowValidator
-
- setWorkflowExecTimeout(WorkflowExecTimeout) - Method in class io.serverlessworkflow.api.end.ContinueAs
-
- setWorkflowExecTimeout(WorkflowExecTimeout) - Method in class io.serverlessworkflow.api.timeouts.TimeoutsDefinition
-
- setWorkflowId(String) - Method in class io.serverlessworkflow.api.end.ContinueAs
-
Unique id of the workflow to continue execution as
- setWorkflowId(String) - Method in class io.serverlessworkflow.api.functions.SubFlowRef
-
Unique id of the sub-workflow to be invoked
(Required)
- showLegend(boolean) - Method in interface io.serverlessworkflow.api.interfaces.WorkflowDiagram
-
- Sleep - Class in io.serverlessworkflow.api.sleep
-
- Sleep() - Constructor for class io.serverlessworkflow.api.sleep.Sleep
-
No args constructor for use in serialization
- Sleep(String, String) - Constructor for class io.serverlessworkflow.api.sleep.Sleep
-
- SleepState - Class in io.serverlessworkflow.api.states
-
This state is used to wait for events from event sources and then transitioning to a next state
- SleepState() - Constructor for class io.serverlessworkflow.api.states.SleepState
-
No args constructor for use in serialization
- SleepState(String, String, DefaultState.Type) - Constructor for class io.serverlessworkflow.api.states.SleepState
-
- SleepStateSerializer - Class in io.serverlessworkflow.api.serializers
-
- SleepStateSerializer() - Constructor for class io.serverlessworkflow.api.serializers.SleepStateSerializer
-
- SleepStateSerializer(Class<SleepState>) - Constructor for class io.serverlessworkflow.api.serializers.SleepStateSerializer
-
- Start - Class in io.serverlessworkflow.api.start
-
State start definition
- Start() - Constructor for class io.serverlessworkflow.api.start.Start
-
- StartDefinitionDeserializer - Class in io.serverlessworkflow.api.deserializers
-
- StartDefinitionDeserializer() - Constructor for class io.serverlessworkflow.api.deserializers.StartDefinitionDeserializer
-
- StartDefinitionDeserializer(Class<?>) - Constructor for class io.serverlessworkflow.api.deserializers.StartDefinitionDeserializer
-
- StartDefinitionDeserializer(WorkflowPropertySource) - Constructor for class io.serverlessworkflow.api.deserializers.StartDefinitionDeserializer
-
- StartDefinitionSerializer - Class in io.serverlessworkflow.api.serializers
-
- StartDefinitionSerializer() - Constructor for class io.serverlessworkflow.api.serializers.StartDefinitionSerializer
-
- StartDefinitionSerializer(Class<Start>) - Constructor for class io.serverlessworkflow.api.serializers.StartDefinitionSerializer
-
- State - Interface in io.serverlessworkflow.api.interfaces
-
- StateDataFilter - Class in io.serverlessworkflow.api.filters
-
- StateDataFilter() - Constructor for class io.serverlessworkflow.api.filters.StateDataFilter
-
- StateDeserializer - Class in io.serverlessworkflow.api.deserializers
-
- StateDeserializer() - Constructor for class io.serverlessworkflow.api.deserializers.StateDeserializer
-
- StateDeserializer(Class<?>) - Constructor for class io.serverlessworkflow.api.deserializers.StateDeserializer
-
- StateDeserializer(WorkflowPropertySource) - Constructor for class io.serverlessworkflow.api.deserializers.StateDeserializer
-
- StateExecTimeout - Class in io.serverlessworkflow.api.timeouts
-
- StateExecTimeout() - Constructor for class io.serverlessworkflow.api.timeouts.StateExecTimeout
-
No args constructor for use in serialization
- StateExecTimeout(String) - Constructor for class io.serverlessworkflow.api.timeouts.StateExecTimeout
-
- StateExecTimeoutDeserializer - Class in io.serverlessworkflow.api.deserializers
-
- StateExecTimeoutDeserializer() - Constructor for class io.serverlessworkflow.api.deserializers.StateExecTimeoutDeserializer
-
- StateExecTimeoutDeserializer(Class<?>) - Constructor for class io.serverlessworkflow.api.deserializers.StateExecTimeoutDeserializer
-
- StateExecTimeoutDeserializer(WorkflowPropertySource) - Constructor for class io.serverlessworkflow.api.deserializers.StateExecTimeoutDeserializer
-
- StateExecTimeoutSerializer - Class in io.serverlessworkflow.api.serializers
-
- StateExecTimeoutSerializer() - Constructor for class io.serverlessworkflow.api.serializers.StateExecTimeoutSerializer
-
- StateExecTimeoutSerializer(Class<StateExecTimeout>) - Constructor for class io.serverlessworkflow.api.serializers.StateExecTimeoutSerializer
-
- StringValueDeserializer - Class in io.serverlessworkflow.api.deserializers
-
- StringValueDeserializer() - Constructor for class io.serverlessworkflow.api.deserializers.StringValueDeserializer
-
- StringValueDeserializer(WorkflowPropertySource) - Constructor for class io.serverlessworkflow.api.deserializers.StringValueDeserializer
-
- StringValueDeserializer(Class<?>) - Constructor for class io.serverlessworkflow.api.deserializers.StringValueDeserializer
-
- SubFlowRef - Class in io.serverlessworkflow.api.functions
-
- SubFlowRef() - Constructor for class io.serverlessworkflow.api.functions.SubFlowRef
-
No args constructor for use in serialization
- SubFlowRef(String) - Constructor for class io.serverlessworkflow.api.functions.SubFlowRef
-
- SubFlowRef.Invoke - Enum in io.serverlessworkflow.api.functions
-
- SubFlowRef.OnParentComplete - Enum in io.serverlessworkflow.api.functions
-
- SubFlowRefDeserializer - Class in io.serverlessworkflow.api.deserializers
-
- SubFlowRefDeserializer() - Constructor for class io.serverlessworkflow.api.deserializers.SubFlowRefDeserializer
-
- SubFlowRefDeserializer(Class<?>) - Constructor for class io.serverlessworkflow.api.deserializers.SubFlowRefDeserializer
-
- SubFlowRefDeserializer(WorkflowPropertySource) - Constructor for class io.serverlessworkflow.api.deserializers.SubFlowRefDeserializer
-
- SubFlowRefSerializer - Class in io.serverlessworkflow.api.serializers
-
- SubFlowRefSerializer() - Constructor for class io.serverlessworkflow.api.serializers.SubFlowRefSerializer
-
- SubFlowRefSerializer(Class<SubFlowRef>) - Constructor for class io.serverlessworkflow.api.serializers.SubFlowRefSerializer
-
- SwitchCondition - Interface in io.serverlessworkflow.api.interfaces
-
- SwitchState - Class in io.serverlessworkflow.api.states
-
Permits transitions to other states based on criteria matching
- SwitchState() - Constructor for class io.serverlessworkflow.api.states.SwitchState
-
No args constructor for use in serialization
- SwitchState(String, DefaultState.Type) - Constructor for class io.serverlessworkflow.api.states.SwitchState
-
- SwitchStateSerializer - Class in io.serverlessworkflow.api.serializers
-
- SwitchStateSerializer() - Constructor for class io.serverlessworkflow.api.serializers.SwitchStateSerializer
-
- SwitchStateSerializer(Class<SwitchState>) - Constructor for class io.serverlessworkflow.api.serializers.SwitchStateSerializer
-
- validate() - Method in interface io.serverlessworkflow.api.interfaces.WorkflowValidator
-
- ValidationError - Class in io.serverlessworkflow.api.validation
-
- ValidationError() - Constructor for class io.serverlessworkflow.api.validation.ValidationError
-
- value() - Method in enum io.serverlessworkflow.api.auth.AuthDefinition.Scheme
-
- value() - Method in enum io.serverlessworkflow.api.auth.OauthDefinition.GrantType
-
- value() - Method in enum io.serverlessworkflow.api.events.EventDefinition.Kind
-
- value() - Method in enum io.serverlessworkflow.api.events.EventRef.Invoke
-
- value() - Method in enum io.serverlessworkflow.api.events.OnEvents.ActionMode
-
- value() - Method in enum io.serverlessworkflow.api.functions.FunctionDefinition.Type
-
- value() - Method in enum io.serverlessworkflow.api.functions.FunctionRef.Invoke
-
- value() - Method in enum io.serverlessworkflow.api.functions.SubFlowRef.Invoke
-
- value() - Method in enum io.serverlessworkflow.api.functions.SubFlowRef.OnParentComplete
-
- value() - Method in enum io.serverlessworkflow.api.states.DefaultState.Type
-
- value() - Method in enum io.serverlessworkflow.api.states.ForEachState.Mode
-
- value() - Method in enum io.serverlessworkflow.api.states.OperationState.ActionMode
-
- value() - Method in enum io.serverlessworkflow.api.states.ParallelState.CompletionType
-
- valueOf(String) - Static method in enum io.serverlessworkflow.api.auth.AuthDefinition.Scheme
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.serverlessworkflow.api.auth.OauthDefinition.GrantType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.serverlessworkflow.api.events.EventDefinition.Kind
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.serverlessworkflow.api.events.EventRef.Invoke
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.serverlessworkflow.api.events.OnEvents.ActionMode
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.serverlessworkflow.api.functions.FunctionDefinition.Type
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.serverlessworkflow.api.functions.FunctionRef.Invoke
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.serverlessworkflow.api.functions.SubFlowRef.Invoke
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.serverlessworkflow.api.functions.SubFlowRef.OnParentComplete
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.serverlessworkflow.api.states.DefaultState.Type
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.serverlessworkflow.api.states.ForEachState.Mode
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.serverlessworkflow.api.states.OperationState.ActionMode
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.serverlessworkflow.api.states.ParallelState.CompletionType
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum io.serverlessworkflow.api.auth.AuthDefinition.Scheme
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum io.serverlessworkflow.api.auth.OauthDefinition.GrantType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum io.serverlessworkflow.api.events.EventDefinition.Kind
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum io.serverlessworkflow.api.events.EventRef.Invoke
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum io.serverlessworkflow.api.events.OnEvents.ActionMode
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum io.serverlessworkflow.api.functions.FunctionDefinition.Type
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum io.serverlessworkflow.api.functions.FunctionRef.Invoke
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum io.serverlessworkflow.api.functions.SubFlowRef.Invoke
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum io.serverlessworkflow.api.functions.SubFlowRef.OnParentComplete
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum io.serverlessworkflow.api.states.DefaultState.Type
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum io.serverlessworkflow.api.states.ForEachState.Mode
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum io.serverlessworkflow.api.states.OperationState.ActionMode
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum io.serverlessworkflow.api.states.ParallelState.CompletionType
-
Returns an array containing the constants of this enum type, in
the order they are declared.