package
2.2.5
Repository: https://github.com/serverlessworkflow/sdk-go.git
Documentation: pkg.go.dev

# Functions

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Constants

ActionModeParallel specifies actions should be performed in parallel.
ActionModeSequential specifies actions should be performed in sequence.
AuthTypeBasic ...
AuthTypeBearer ...
AuthTypeOAuth2 ...
No description provided by the author
CELExpressionLang.
CompletionTypeAllOf defines all branches must complete execution before the state can transition/end.
CompletionTypeAtLeast defines state can transition/end once at least the specified number of branches have completed execution.
EventKindConsumed means the event continuation of workflow instance execution.
EventKindProduced means the event was created during workflow instance execution.
No description provided by the author
ForEachModeTypeParallel specifies iterations should be done parallel.
ForEachModeTypeSequential specifies iterations should be done sequentially.
FunctionTypeAsyncAPI a combination of the AsyncApi definition document URI and the particular service operation that needs to be invoked, separated by a '#'.
FunctionTypeCustom property defines a list of function types that are set by the specification.
FunctionTypeExpression defines the expression syntax.
FunctionTypeGraphQL a combination of the GraphQL schema definition URI and the particular service name and service method name that needs to be invoked, separated by a '#'.
FunctionTypeOData a combination of the GraphQL schema definition URI and the particular service name and service method name that needs to be invoked, separated by a '#'.
FunctionTypeREST a combination of the function/service OpenAPI definition document URI and the particular service operation that needs to be invoked, separated by a '#'.
FunctionTypeRPC a combination of the gRPC proto document URI and the particular service name and service method name that needs to be invoked, separated by a '#'.
GrantTypeClientCredentials ...
GrantTypePassword ...
GrantTypeTokenExchange ...
No description provided by the author
InvokeKindAsync meaning that workflow execution should just invoke the target and should not wait until its completion.
InvokeKindSync meaning that worfklow execution should wait until the target completes.
JqExpressionLang ...
JsonPathExpressionLang ...
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
StateTypeCallback ...
StateTypeDelay ...
StateTypeEvent ...
StateTypeForEach ...
StateTypeInject ...
StateTypeOperation ...
StateTypeParallel ...
StateTypeSleep ...
StateTypeSwitch ...
No description provided by the author
UnlimitedTimeout description for unlimited timeouts.
No description provided by the author

# Structs

Action specify invocations of services or other workflows during workflow execution.
ActionDataFilter used to filter action data results.
Auth definitions can be used to define authentication information that should be applied to resources defined in the operation property of function definitions.
AuthProperties ...
BaseState ...
BaseWorkflow describes the partial Workflow definition that does not rely on generic interfaces to make it easy for custom unmarshalers implementations to unmarshal the common data structure.
BasicAuthProperties Basic Auth Info.
BearerAuthProperties Bearer auth information.
Branch Definition.
BranchTimeouts defines the specific timeout settings for branch.
CallbackState executes a function and waits for callback event that indicates completion of the task.
CallbackStateTimeout defines timeout settings for callback state.
Common schema for Serverless Workflow specification.
Constants Workflow constants are used to define static, and immutable, data which is available to Workflow Expressions.
ContinueAs can be used to stop the current workflow execution and start another one (of the same or a different type).
Correlation define event correlation rules for an event.
Cron ...
DataCondition specify a data-based condition statement which causes a transition to another workflow state if evaluated to true.
DataInputSchema Used to validate the workflow data input against a defined JSON Schema.
DefaultCondition Can be either a transition or end definition.
DelayState Causes the workflow execution to delay for a specified duration.
End definition.
Error declaration for workflow definitions.
Event used to define events and their correlations.
EventCondition specify events which the switch state must wait for.
EventDataFilter used to filter consumed event payloads.
EventRef defining invocation of a function via event.
EventState await one or more events and perform actions when they are received.
EventStateTimeout defines timeout settings for event state.
ForEachState used to execute actions for each element of a data set.
ForEachStateTimeout defines timeout settings for foreach state.
Function ...
FunctionRef defines the reference to a reusable function definition.
InjectState used to inject static data into state data input.
InjectStateTimeout defines timeout settings for inject state.
OAuth2AuthProperties OAuth2 information.
Object is used to allow integration with DeepCopy tool by replacing 'interface' generic type.
OnError ...
OnEvents define which actions are be performed for the one or more events.
OperationState defines a set of actions to be performed in sequence or in parallel.
OperationStateTimeout defines the specific timeout settings for operation state.
ParallelState Consists of a number of states that are executed in parallel.
ParallelStateTimeout defines the specific timeout settings for parallel state.
ProduceEvent Defines the event (CloudEvent format) to be produced when workflow execution completes or during a workflow transitions.
Retry ...
Schedule ...
Sleep defines time periods workflow execution should sleep before & after function execution.
SleepState suspends workflow execution for a given time duration.
SleepStateTimeout defines timeout settings for sleep state.
Start definition.
No description provided by the author
StateDataFilter ...
StateExecTimeout defines workflow state execution timeout.
SwitchState is workflow's gateways: direct transitions onf a workflow based on certain conditions.
SwitchStateTimeout defines the specific timeout settings for switch state.
Timeouts ...
Transition Serverless workflow states can have one or more incoming and outgoing transitions (from/to other states).
No description provided by the author
Workflow base definition.
WorkflowExecTimeout property defines the workflow execution timeout.
WorkflowRef holds a reference for a workflow definition.

# Type aliases

ActionMode specifies how actions are to be performed.
No description provided by the author
AuthType can be "basic", "bearer", or "oauth2".
CompletionType define on how to complete branch execution.
No description provided by the author
No description provided by the author
No description provided by the author
EventKind defines this event as either `consumed` or `produced`.
No description provided by the author
No description provided by the author
ForEachModeType Specifies how iterations are to be performed (sequentially or in parallel).
No description provided by the author
FunctionType ...
GrantType ...
InvokeKind defines how the target is invoked.
Metadata information.
CompletionType define on how to complete branch execution.
No description provided by the author
Secrets allow you to access sensitive information, such as passwords, OAuth tokens, ssh keys, etc inside your Workflow Expressions.
+kubebuilder:validation:MinItems=1.
StateType ...
No description provided by the author
No description provided by the author