Serialized Form
-
Package io.serverlessworkflow.api.types
-
Class io.serverlessworkflow.api.types.AllEventConsumptionStrategy extends Object implements Serializable
- serialVersionUID:
- 992748626954425832L
-
Serialized Fields
-
all
@Valid @NotNull List<EventFilter> all
AllEventConsumptionStrategyConfigurationA list containing all the events that must be consumed. (Required)
-
-
Class io.serverlessworkflow.api.types.AnyEventConsumptionStrategy extends Object implements Serializable
- serialVersionUID:
- 3822427841513687263L
-
Serialized Fields
-
any
@Valid @NotNull List<EventFilter> any
AnyEventConsumptionStrategyConfigurationA list containing any of the events to consume. (Required)
-
-
Class io.serverlessworkflow.api.types.AsyncApiArguments extends Object implements Serializable
- serialVersionUID:
- 8771134120697881487L
-
Serialized Fields
-
authentication
@Valid ReferenceableAuthenticationPolicy authentication
ReferenceableAuthenticationPolicyRepresents a referenceable authentication policy.
-
binding
String binding
WithAsyncAPIBindingThe name of the binding to use. If not set, defaults to the first binding defined by the operation.
-
document
@Valid @NotNull ExternalResource document
ExternalResourceRepresents an external resource. (Required)
-
message
String message
WithAsyncAPIMessageThe name of the message to use. If not set, defaults to the first message defined by the operation.
-
operationRef
@NotNull String operationRef
WithAsyncAPIOperationA reference to the AsyncAPI operation to call. (Required)
-
payload
@Valid WithAsyncAPIPayload payload
WithAsyncAPIPayloadThe payload to call the AsyncAPI operation with, if any.
-
server
String server
WithAsyncAPIServerA a reference to the server to call the specified AsyncAPI operation on. If not set, default to the first server matching the operation's channel.
-
-
Class io.serverlessworkflow.api.types.AuthenticationPolicy extends Object implements Serializable
- serialVersionUID:
- -6002705431157309184L
-
Serialized Fields
-
additionalProperties
@Valid Map<String,Object> additionalProperties
-
basicAuthenticationPolicy
BasicAuthenticationPolicy basicAuthenticationPolicy
-
bearerAuthenticationPolicy
BearerAuthenticationPolicy bearerAuthenticationPolicy
-
digestAuthenticationPolicy
DigestAuthenticationPolicy digestAuthenticationPolicy
-
oAuth2AuthenticationPolicy
OAuth2AuthenticationPolicy oAuth2AuthenticationPolicy
-
openIdConnectAuthenticationPolicy
OpenIdConnectAuthenticationPolicy openIdConnectAuthenticationPolicy
-
value
Object value
-
-
Class io.serverlessworkflow.api.types.AuthenticationPolicyReference extends Object implements Serializable
- serialVersionUID:
- -1915128362813581102L
-
Serialized Fields
-
use
@Size(min=1) @NotNull String use
ReferenceableAuthenticationPolicyNameThe name of the authentication policy to use. (Required)
-
-
Class io.serverlessworkflow.api.types.BasicAuthenticationPolicy extends Object implements Serializable
- serialVersionUID:
- 8922421581972353647L
-
Serialized Fields
-
basic
@Valid @NotNull BasicAuthenticationPolicyConfiguration basic
BasicAuthenticationPolicyConfigurationThe configuration of the basic authentication policy. (Required)
-
-
Class io.serverlessworkflow.api.types.BasicAuthenticationPolicyConfiguration extends Object implements Serializable
- serialVersionUID:
- -7522324792255712249L
-
Serialized Fields
-
basicAuthenticationPolicySecret
SecretBasedAuthenticationPolicy basicAuthenticationPolicySecret
-
basicAuthenticationProperties
BasicAuthenticationProperties basicAuthenticationProperties
-
value
Object value
-
-
Class io.serverlessworkflow.api.types.BasicAuthenticationProperties extends Object implements Serializable
- serialVersionUID:
- 1148475832350745150L
-
Class io.serverlessworkflow.api.types.BearerAuthenticationPolicy extends Object implements Serializable
- serialVersionUID:
- 2556545962402600990L
-
Serialized Fields
-
bearer
@Valid @NotNull BearerAuthenticationPolicyConfiguration bearer
BearerAuthenticationPolicyConfigurationThe configuration of the bearer authentication policy. (Required)
-
-
Class io.serverlessworkflow.api.types.BearerAuthenticationPolicyConfiguration extends Object implements Serializable
- serialVersionUID:
- 1494317805510268261L
-
Serialized Fields
-
bearerAuthenticationPolicySecret
SecretBasedAuthenticationPolicy bearerAuthenticationPolicySecret
-
bearerAuthenticationProperties
BearerAuthenticationProperties bearerAuthenticationProperties
-
value
Object value
-
-
Class io.serverlessworkflow.api.types.BearerAuthenticationProperties extends Object implements Serializable
- serialVersionUID:
- -1933619164748461960L
-
Serialized Fields
-
token
@NotNull String token
The bearer token to use. (Required)
-
-
Class io.serverlessworkflow.api.types.CallAsyncAPI extends TaskBase implements Serializable
- serialVersionUID:
- 4102564326360305038L
-
Serialized Fields
-
call
@Pattern(regexp="asyncapi") @NotNull String call
(Required) -
with
@Valid @NotNull AsyncApiArguments with
AsyncApiArgumentsThe Async API call arguments. (Required)
-
-
Class io.serverlessworkflow.api.types.CallFunction extends TaskBase implements Serializable
- serialVersionUID:
- 5773771416369331468L
-
Serialized Fields
-
call
@NotNull String call
The name of the function to call. (Required) -
with
@Valid FunctionArguments with
FunctionArgumentsA name/value mapping of the parameters, if any, to call the function with.
-
-
Class io.serverlessworkflow.api.types.CallGRPC extends TaskBase implements Serializable
- serialVersionUID:
- 8649969129676689724L
-
Serialized Fields
-
call
@Pattern(regexp="grpc") @NotNull String call
(Required) -
with
@Valid @NotNull GRPCArguments with
GRPCArgumentsThe GRPC call arguments. (Required)
-
-
Class io.serverlessworkflow.api.types.CallHTTP extends TaskBase implements Serializable
- serialVersionUID:
- 6410194285077672922L
-
Serialized Fields
-
call
@Pattern(regexp="http") @NotNull String call
(Required) -
with
@Valid @NotNull HTTPArguments with
HTTPArgumentsThe HTTP call arguments. (Required)
-
-
Class io.serverlessworkflow.api.types.CallOpenAPI extends TaskBase implements Serializable
- serialVersionUID:
- 8635693032540122816L
-
Serialized Fields
-
call
@Pattern(regexp="openapi") @NotNull String call
(Required) -
with
@Valid @NotNull OpenAPIArguments with
OpenAPIArgumentsThe OpenAPI call arguments. (Required)
-
-
Class io.serverlessworkflow.api.types.Catalog extends Object implements Serializable
- serialVersionUID:
- -6904197543555111052L
-
Serialized Fields
-
endpoint
@NotNull Endpoint endpoint
EndpointRepresents an endpoint. (Required)
-
-
Class io.serverlessworkflow.api.types.CatchErrors extends Object implements Serializable
- serialVersionUID:
- 2409539489184055233L
-
Class io.serverlessworkflow.api.types.Constant extends Object implements Serializable
- serialVersionUID:
- 2873428264728643050L
-
Class io.serverlessworkflow.api.types.ConstantBackoff extends Object implements Serializable
- serialVersionUID:
- 2732491760830986062L
-
Serialized Fields
-
constant
@Valid @NotNull Constant constant
The definition of the constant backoff to use, if any. (Required)
-
-
Class io.serverlessworkflow.api.types.Container extends Object implements Serializable
- serialVersionUID:
- 6095448110142639120L
-
Serialized Fields
-
command
String command
ContainerCommandThe command, if any, to execute on the container.
-
environment
@Valid ContainerEnvironment environment
ContainerEnvironmentA key/value mapping of the environment variables, if any, to use when running the configured process.
-
image
@NotNull String image
ContainerImageThe name of the container image to run. (Required)
-
ports
@Valid ContainerPorts ports
ContainerPortsThe container's port mappings, if any.
-
volumes
@Valid ContainerVolumes volumes
ContainerVolumesThe container's volume mappings, if any.
-
-
Class io.serverlessworkflow.api.types.ContainerEnvironment extends Object implements Serializable
- serialVersionUID:
- -2280679524999905552L
-
Class io.serverlessworkflow.api.types.ContainerPorts extends Object implements Serializable
- serialVersionUID:
- -7146533853871517044L
-
Class io.serverlessworkflow.api.types.ContainerVolumes extends Object implements Serializable
- serialVersionUID:
- -4821167750115905028L
-
Class io.serverlessworkflow.api.types.CorrelateProperty extends Object implements Serializable
- serialVersionUID:
- 7786303827821817297L
-
Serialized Fields
-
expect
String expect
CorrelateExpectA constant or a runtime expression, if any, used to determine whether or not the extracted correlation value matches expectations. If not set, the first extracted value will be used as the correlation's expectation.
-
from
@NotNull String from
CorrelateFromA runtime expression used to extract the correlation value from the filtered event. (Required)
-
-
Class io.serverlessworkflow.api.types.DigestAuthenticationPolicy extends Object implements Serializable
- serialVersionUID:
- -4181552813212832023L
-
Serialized Fields
-
digest
@Valid @NotNull DigestAuthenticationPolicyConfiguration digest
DigestAuthenticationPolicyConfigurationThe configuration of the digest authentication policy. (Required)
-
-
Class io.serverlessworkflow.api.types.DigestAuthenticationPolicyConfiguration extends Object implements Serializable
- serialVersionUID:
- 5982114845759757217L
-
Serialized Fields
-
digestAuthenticationPolicySecret
SecretBasedAuthenticationPolicy digestAuthenticationPolicySecret
-
digestAuthenticationProperties
DigestAuthenticationProperties digestAuthenticationProperties
-
value
Object value
-
-
Class io.serverlessworkflow.api.types.DigestAuthenticationProperties extends Object implements Serializable
- serialVersionUID:
- -5180581366907086262L
-
Class io.serverlessworkflow.api.types.Document extends Object implements Serializable
- serialVersionUID:
- -8838629639123887548L
-
Serialized Fields
-
dsl
@Pattern(regexp="^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$") @NotNull String dsl
WorkflowDSLThe version of the DSL used by the workflow. (Required)
-
metadata
@Valid WorkflowMetadata metadata
WorkflowMetadataHolds additional information about the workflow.
-
name
@Pattern(regexp="^[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?$") @NotNull String name
WorkflowNameThe workflow's name. (Required)
-
namespace
@Pattern(regexp="^[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?$") @NotNull String namespace
WorkflowNamespaceThe workflow's namespace. (Required)
-
summary
String summary
WorkflowSummaryThe workflow's Markdown summary.
-
tags
@Valid WorkflowTags tags
WorkflowTagsA key/value mapping of the workflow's tags, if any.
-
title
String title
WorkflowTitleThe workflow's title.
-
version
@Pattern(regexp="^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$") @NotNull String version
WorkflowVersionThe workflow's semantic version. (Required)
-
-
Class io.serverlessworkflow.api.types.DoTask extends TaskBase implements Serializable
- serialVersionUID:
- 8393670305103575571L
-
Class io.serverlessworkflow.api.types.DurationInline extends Object implements Serializable
- serialVersionUID:
- 7837332642676408681L
-
Serialized Fields
-
days
int days
DurationDaysNumber of days, if any.
-
hours
int hours
DurationHoursNumber of days, if any.
-
milliseconds
int milliseconds
DurationMillisecondsNumber of milliseconds, if any.
-
minutes
int minutes
DurationMinutesNumber of minutes, if any.
-
seconds
int seconds
DurationSecondsNumber of seconds, if any.
-
-
Class io.serverlessworkflow.api.types.EmitEventDefinition extends Object implements Serializable
- serialVersionUID:
- -6259979570825313381L
-
Serialized Fields
-
additionalProperties
@Valid Map<String,Object> additionalProperties
-
with
@Valid EventProperties with
EventPropertiesDescribes the properties of an event.
-
-
Class io.serverlessworkflow.api.types.EmitTask extends TaskBase implements Serializable
- serialVersionUID:
- 2564031544961573288L
-
Serialized Fields
-
emit
@Valid @NotNull EmitTaskConfiguration emit
EmitTaskConfigurationThe configuration of an event's emission. (Required)
-
-
Class io.serverlessworkflow.api.types.EmitTaskConfiguration extends Object implements Serializable
- serialVersionUID:
- 5552777140950138116L
-
Serialized Fields
-
event
@Valid @NotNull EmitEventDefinition event
EmitEventDefinitionThe definition of the event to emit. (Required)
-
-
Class io.serverlessworkflow.api.types.EndpointConfiguration extends Object implements Serializable
- serialVersionUID:
- -7546601616894114358L
-
Serialized Fields
-
authentication
@Valid ReferenceableAuthenticationPolicy authentication
ReferenceableAuthenticationPolicyRepresents a referenceable authentication policy.
-
uri
@NotNull EndpointUri uri
EndpointUriThe endpoint's URI. (Required)
-
-
Class io.serverlessworkflow.api.types.Error extends Object implements Serializable
- serialVersionUID:
- 1192273293824075839L
-
Serialized Fields
-
detail
String detail
ErrorDetailsA human-readable explanation specific to this occurrence of the error.
-
instance
ErrorInstance instance
ErrorInstanceA JSON Pointer used to reference the component the error originates from.
-
status
@jakarta.validation.constraints.NotNull int status
ErrorStatusThe status code generated by the origin for this occurrence of the error. (Required)
-
title
String title
ErrorTitleA short, human-readable summary of the error.
-
type
@NotNull ErrorType type
ErrorTypeA URI reference that identifies the error type. (Required)
-
-
Class io.serverlessworkflow.api.types.EventConsumptionStrategy extends Object implements Serializable
- serialVersionUID:
- -6522705069976711326L
-
Serialized Fields
-
allEventConsumptionStrategy
AllEventConsumptionStrategy allEventConsumptionStrategy
-
anyEventConsumptionStrategy
AnyEventConsumptionStrategy anyEventConsumptionStrategy
-
oneEventConsumptionStrategy
OneEventConsumptionStrategy oneEventConsumptionStrategy
-
value
Object value
-
-
Class io.serverlessworkflow.api.types.EventFilter extends Object implements Serializable
- serialVersionUID:
- -2388030005839505305L
-
Serialized Fields
-
correlate
@Valid EventFilterCorrelate correlate
EventFilterCorrelateA correlation is a link between events and data, established by mapping event attributes to specific data attributes, allowing for coordinated processing or handling based on event characteristics.
-
with
@Valid @NotNull EventProperties with
EventPropertiesDescribes the properties of an event. (Required)
-
-
Class io.serverlessworkflow.api.types.EventFilterCorrelate extends Object implements Serializable
- serialVersionUID:
- 6249294157432089395L
-
Serialized Fields
-
additionalProperties
@Valid Map<String,CorrelateProperty> additionalProperties
-
-
Class io.serverlessworkflow.api.types.EventProperties extends Object implements Serializable
- serialVersionUID:
- -2110955420027375712L
-
Serialized Fields
-
additionalProperties
@Valid Map<String,Object> additionalProperties
-
datacontenttype
String datacontenttype
EventDataContentTypeContent type of data value. This attribute enables data to carry any type of content, whereby format and encoding might differ from that of the chosen event format.
-
dataschema
EventDataschema dataschema
EventDataschemaThe schema describing the event format.
-
id
String id
EventIdThe event's unique identifier.
-
source
EventSource source
EventSourceIdentifies the context in which an event happened.
-
subject
String subject
EventSubjectThe subject of the event.
-
time
EventTime time
EventTimeWhen the event occured.
-
type
String type
EventTypeThis attribute contains a value describing the type of event related to the originating occurrence.
-
-
Class io.serverlessworkflow.api.types.Exponential extends Object implements Serializable
- serialVersionUID:
- 3301166202351090489L
-
Class io.serverlessworkflow.api.types.ExponentialBackOff extends Object implements Serializable
- serialVersionUID:
- -2454878091877685042L
-
Serialized Fields
-
exponential
@Valid @NotNull Exponential exponential
The definition of the exponential backoff to use, if any. (Required)
-
-
Class io.serverlessworkflow.api.types.Export extends Object implements Serializable
- serialVersionUID:
- -6700389625479032094L
-
Class io.serverlessworkflow.api.types.Extension extends Object implements Serializable
- serialVersionUID:
- 4976401151480321437L
-
Serialized Fields
-
after
@Valid List<TaskItem> after
TaskListList of named tasks to perform.
-
before
@Valid List<TaskItem> before
TaskListList of named tasks to perform.
-
extend
Extension.ExtensionTarget extend
ExtensionTargetThe type of task to extend. (Required)
-
when
String when
ExtensionConditionA runtime expression, if any, used to determine whether or not the extension should apply in the specified context.
-
-
Class io.serverlessworkflow.api.types.ExtensionItem extends Object implements Serializable
- serialVersionUID:
- 5615568675758526092L
-
Class io.serverlessworkflow.api.types.ExternalResource extends Object implements Serializable
- serialVersionUID:
- 764690311440713779L
-
Class io.serverlessworkflow.api.types.ExternalScript extends Object implements Serializable
- serialVersionUID:
- 2165297956918030950L
-
Serialized Fields
-
source
@Valid @NotNull ExternalResource source
ExternalResourceRepresents an external resource. (Required)
-
-
Class io.serverlessworkflow.api.types.ForkTask extends TaskBase implements Serializable
- serialVersionUID:
- 7012804277356421399L
-
Serialized Fields
-
fork
@Valid @NotNull ForkTaskConfiguration fork
ForkTaskConfigurationThe configuration of the branches to perform concurrently. (Required)
-
-
Class io.serverlessworkflow.api.types.ForkTaskConfiguration extends Object implements Serializable
- serialVersionUID:
- -8929643648679256252L
-
Serialized Fields
-
Class io.serverlessworkflow.api.types.ForTask extends TaskBase implements Serializable
- serialVersionUID:
- 7737935378515942739L
-
Serialized Fields
-
_do
@Valid @NotNull List<TaskItem> _do
TaskListList of named tasks to perform. (Required)
-
_for
@Valid @NotNull ForTaskConfiguration _for
ForTaskConfigurationThe definition of the loop that iterates over a range of values. (Required)
-
_while
String _while
WhileA runtime expression that represents the condition, if any, that must be met for the iteration to continue.
-
-
Class io.serverlessworkflow.api.types.ForTaskConfiguration extends Object implements Serializable
- serialVersionUID:
- -117491654169995060L
-
Serialized Fields
-
at
String at
ForAtThe name of the variable used to store the index of the current item being enumerated.
-
each
String each
ForEachThe name of the variable used to store the current item being enumerated.
-
in
@NotNull String in
ForInA runtime expression used to get the collection to enumerate. (Required)
-
-
Class io.serverlessworkflow.api.types.FunctionArguments extends Object implements Serializable
- serialVersionUID:
- 2378613497144700678L
-
Class io.serverlessworkflow.api.types.GRPCArguments extends Object implements Serializable
- serialVersionUID:
- 6815571419819663852L
-
Serialized Fields
-
arguments
@Valid WithGRPCArguments arguments
WithGRPCArgumentsThe arguments, if any, to call the method with.
-
method
@NotNull String method
WithGRPCMethodThe name of the method to call on the defined GRPC service. (Required)
-
proto
@Valid @NotNull ExternalResource proto
ExternalResourceRepresents an external resource. (Required)
-
service
@Valid @NotNull WithGRPCService service
WithGRPCService(Required)
-
-
Class io.serverlessworkflow.api.types.HTTPArguments extends Object implements Serializable
- serialVersionUID:
- -9092572575898985571L
-
Serialized Fields
-
body
Object body
WithHTTPBodyThe body, if any, of the HTTP request to perform.
-
endpoint
@NotNull Endpoint endpoint
EndpointRepresents an endpoint. (Required)
-
headers
@Valid WithHTTPHeaders headers
WithHTTPHeadersA name/value mapping of the headers, if any, of the HTTP request to perform.
-
method
@NotNull String method
WithHTTPMethodThe HTTP method of the HTTP request to perform. (Required)
-
output
HTTPArguments.WithHTTPOutput output
WithHTTPOutputThe http call output format. Defaults to 'content'.
-
query
@Valid WithHTTPQuery query
WithHTTPQueryA name/value mapping of the query parameters, if any, of the HTTP request to perform.
-
-
Class io.serverlessworkflow.api.types.InlineScript extends Object implements Serializable
- serialVersionUID:
- -4197518263874918433L
-
Serialized Fields
-
code
@NotNull String code
InlineScriptCode(Required)
-
-
Class io.serverlessworkflow.api.types.Input extends Object implements Serializable
- serialVersionUID:
- 1005689059288471104L
-
Class io.serverlessworkflow.api.types.Linear extends Object implements Serializable
- serialVersionUID:
- 4319141786753429929L
-
Class io.serverlessworkflow.api.types.LinearBackoff extends Object implements Serializable
- serialVersionUID:
- 6332691503115794704L
-
Serialized Fields
-
linear
@Valid @NotNull Linear linear
The definition of the linear backoff to use, if any. (Required)
-
-
Class io.serverlessworkflow.api.types.ListenTask extends TaskBase implements Serializable
- serialVersionUID:
- 8734760744939401059L
-
Serialized Fields
-
listen
@Valid @NotNull ListenTaskConfiguration listen
ListenTaskConfigurationThe configuration of the listener to use. (Required)
-
-
Class io.serverlessworkflow.api.types.ListenTaskConfiguration extends Object implements Serializable
- serialVersionUID:
- -4842262523954278479L
-
Serialized Fields
-
to
@Valid @NotNull EventConsumptionStrategy to
EventConsumptionStrategyDescribe the event consumption strategy to adopt. (Required)
-
-
Class io.serverlessworkflow.api.types.Oauth2 extends Object implements Serializable
- serialVersionUID:
- -6235096643880429172L
-
Serialized Fields
-
endpoints
@Valid OAuth2AuthenticationPropertiesEndpoints endpoints
OAuth2AuthenticationPropertiesEndpointsThe endpoint configurations for OAuth2.
-
-
Class io.serverlessworkflow.api.types.OAuth2AutenthicationData extends Object implements Serializable
- serialVersionUID:
- -2195227164396101725L
-
Serialized Fields
-
actor
@Valid OAuth2TokenDefinition actor
OAuth2TokenDefinitionRepresents an OAuth2 token.
-
audiences
@Valid List<String> audiences
OAuth2AutenthicationDataAudiencesThe audiences, if any, to request the token for.
-
authority
UriTemplate authority
UriTemplate -
client
@Valid OAuth2AutenthicationDataClient client
OAuth2AutenthicationDataClientThe definition of an OAuth2 client.
-
grant
OAuth2AutenthicationData.OAuth2AutenthicationDataGrant grant
OAuth2AutenthicationDataGrantThe grant type to use.
-
issuers
@Valid List<String> issuers
OAuth2IssuersA list that contains that contains valid issuers that will be used to check against the issuer of generated tokens.
-
password
String password
OAuth2AutenthicationDataPasswordThe password to use. Used only if the grant type is Password.
-
request
@Valid OAuth2TokenRequest request
OAuth2TokenRequestThe configuration of an OAuth2 token request
-
scopes
@Valid List<String> scopes
OAuth2AutenthicationDataScopesThe scopes, if any, to request the token for.
-
subject
@Valid OAuth2TokenDefinition subject
OAuth2TokenDefinitionRepresents an OAuth2 token.
-
username
String username
OAuth2AutenthicationDataUsernameThe username to use. Used only if the grant type is Password.
-
-
Class io.serverlessworkflow.api.types.OAuth2AutenthicationDataClient extends Object implements Serializable
- serialVersionUID:
- 8554699705317304904L
-
Serialized Fields
-
assertion
String assertion
ClientAssertionA JWT containing a signed assertion with your application credentials.
-
authentication
OAuth2AutenthicationDataClient.ClientAuthentication authentication
ClientAuthenticationThe authentication method to use to authenticate the client.
-
id
String id
ClientIdThe client id to use.
-
secret
String secret
ClientSecretThe client secret to use, if any.
-
-
Class io.serverlessworkflow.api.types.OAuth2AuthenticationPolicy extends Object implements Serializable
- serialVersionUID:
- -747403453948486158L
-
Serialized Fields
-
oauth2
@Valid @NotNull OAuth2AuthenticationPolicyConfiguration oauth2
OAuth2AuthenticationPolicyConfigurationThe configuration of the OAuth2 authentication policy. (Required)
-
-
Class io.serverlessworkflow.api.types.OAuth2AuthenticationPolicyConfiguration extends Object implements Serializable
- serialVersionUID:
- -5368336006929541201L
-
Serialized Fields
-
oAuth2AuthenticationPolicySecret
SecretBasedAuthenticationPolicy oAuth2AuthenticationPolicySecret
-
oAuth2ConnectAuthenticationProperties
OAuth2ConnectAuthenticationProperties oAuth2ConnectAuthenticationProperties
-
value
Object value
-
-
Class io.serverlessworkflow.api.types.OAuth2AuthenticationPropertiesEndpoints extends Object implements Serializable
- serialVersionUID:
- -4801966173556581818L
-
Serialized Fields
-
introspection
String introspection
OAuth2IntrospectionEndpointThe relative path to the introspection endpoint. Defaults to `/oauth2/introspect`.
-
revocation
String revocation
OAuth2RevocationEndpointThe relative path to the revocation endpoint. Defaults to `/oauth2/revoke`.
-
token
String token
OAuth2TokenEndpointThe relative path to the token endpoint. Defaults to `/oauth2/token`.
-
-
Class io.serverlessworkflow.api.types.OAuth2ConnectAuthenticationProperties extends Object implements Serializable
- serialVersionUID:
- 4983487903902778853L
-
Serialized Fields
-
oauth2
Oauth2 oauth2
-
oAuth2AutenthicationData
OAuth2AutenthicationData oAuth2AutenthicationData
-
value
Object value
-
-
Class io.serverlessworkflow.api.types.OAuth2TokenDefinition extends Object implements Serializable
- serialVersionUID:
- -5120477047353180521L
-
Class io.serverlessworkflow.api.types.OAuth2TokenRequest extends Object implements Serializable
- serialVersionUID:
- -7277792680592967951L
-
Serialized Fields
-
encoding
OAuth2TokenRequest.Oauth2TokenRequestEncoding encoding
Oauth2TokenRequestEncoding
-
-
Class io.serverlessworkflow.api.types.OneEventConsumptionStrategy extends Object implements Serializable
- serialVersionUID:
- 2366699950439598036L
-
Serialized Fields
-
one
@Valid @NotNull EventFilter one
EventFilterAn event filter is a mechanism used to selectively process or handle events based on predefined criteria, such as event type, source, or specific attributes. (Required)
-
-
Class io.serverlessworkflow.api.types.OpenAPIArguments extends Object implements Serializable
- serialVersionUID:
- 2180235379785986460L
-
Serialized Fields
-
authentication
@Valid ReferenceableAuthenticationPolicy authentication
ReferenceableAuthenticationPolicyRepresents a referenceable authentication policy.
-
document
@Valid @NotNull ExternalResource document
ExternalResourceRepresents an external resource. (Required)
-
operationId
@NotNull String operationId
WithOpenAPIOperationThe id of the OpenAPI operation to call. (Required)
-
output
OpenAPIArguments.WithOpenAPIOutput output
WithOpenAPIOutputThe http call output format. Defaults to 'content'.
-
parameters
@Valid WithOpenAPIParameters parameters
WithOpenAPIParametersA name/value mapping of the parameters of the OpenAPI operation to call.
-
-
Class io.serverlessworkflow.api.types.OpenIdConnectAuthenticationPolicy extends Object implements Serializable
- serialVersionUID:
- 2363435375563277328L
-
Serialized Fields
-
oidc
@Valid @NotNull OpenIdConnectAuthenticationPolicyConfiguration oidc
OpenIdConnectAuthenticationPolicyConfigurationThe configuration of the OpenIdConnect authentication policy. (Required)
-
-
Class io.serverlessworkflow.api.types.OpenIdConnectAuthenticationPolicyConfiguration extends Object implements Serializable
- serialVersionUID:
- 8460615522427860181L
-
Serialized Fields
-
openIdConnectAuthenticationPolicySecret
SecretBasedAuthenticationPolicy openIdConnectAuthenticationPolicySecret
-
openIdConnectAuthenticationProperties
OAuth2AutenthicationData openIdConnectAuthenticationProperties
-
value
Object value
-
-
Class io.serverlessworkflow.api.types.Output extends Object implements Serializable
- serialVersionUID:
- -55775510704139405L
-
Class io.serverlessworkflow.api.types.RaiseTask extends TaskBase implements Serializable
- serialVersionUID:
- 5846125716284176841L
-
Serialized Fields
-
raise
@Valid @NotNull RaiseTaskConfiguration raise
RaiseTaskConfigurationThe definition of the error to raise. (Required)
-
-
Class io.serverlessworkflow.api.types.RaiseTaskConfiguration extends Object implements Serializable
- serialVersionUID:
- 8932457748147274169L
-
Serialized Fields
-
error
@NotNull RaiseTaskError error
RaiseTaskError(Required)
-
-
Class io.serverlessworkflow.api.types.ReferenceableAuthenticationPolicy extends Object implements Serializable
- serialVersionUID:
- 401169992960946617L
-
Serialized Fields
-
authenticationPolicy
AuthenticationPolicy authenticationPolicy
-
authenticationPolicyReference
AuthenticationPolicyReference authenticationPolicyReference
-
value
Object value
-
-
Class io.serverlessworkflow.api.types.RetryBackoff extends Object implements Serializable
- serialVersionUID:
- -1186216687973238422L
-
Serialized Fields
-
constantBackoff
ConstantBackoff constantBackoff
-
exponentialBackOff
ExponentialBackOff exponentialBackOff
-
linearBackoff
LinearBackoff linearBackoff
-
value
Object value
-
-
Class io.serverlessworkflow.api.types.RetryLimit extends Object implements Serializable
- serialVersionUID:
- 3151618768568391717L
-
Serialized Fields
-
attempt
@Valid RetryLimitAttempt attempt
RetryLimitAttempt -
duration
Duration duration
-
-
Class io.serverlessworkflow.api.types.RetryLimitAttempt extends Object implements Serializable
- serialVersionUID:
- -7689261231005985734L
-
Serialized Fields
-
count
int count
RetryLimitAttemptCountThe maximum amount of retry attempts, if any.
-
duration
Duration duration
-
-
Class io.serverlessworkflow.api.types.RetryPolicy extends Object implements Serializable
- serialVersionUID:
- -993006429178361898L
-
Serialized Fields
-
backoff
@Valid RetryBackoff backoff
RetryBackoffThe retry duration backoff.
-
delay
Duration delay
-
exceptWhen
String exceptWhen
RetryExcepWhenA runtime expression used to determine whether or not to retry running the task, in a given context.
-
jitter
@Valid RetryPolicyJitter jitter
RetryPolicyJitterThe parameters, if any, that control the randomness or variability of the delay between retry attempts.
-
limit
@Valid RetryLimit limit
RetryLimitThe retry limit, if any.
-
when
String when
RetryWhenA runtime expression, if any, used to determine whether or not to retry running the task, in a given context.
-
-
Class io.serverlessworkflow.api.types.RetryPolicyJitter extends Object implements Serializable
- serialVersionUID:
- -1408242735729632192L
-
Class io.serverlessworkflow.api.types.RunContainer extends Object implements Serializable
- serialVersionUID:
- 9132802901210115990L
-
Serialized Fields
-
container
@Valid @NotNull Container container
ContainerThe configuration of the container to run. (Required)
-
-
Class io.serverlessworkflow.api.types.RunScript extends Object implements Serializable
- serialVersionUID:
- 6997884533395425880L
-
Serialized Fields
-
script
@Valid @NotNull Script script
ScriptThe configuration of the script to run. (Required)
-
-
Class io.serverlessworkflow.api.types.RunShell extends Object implements Serializable
- serialVersionUID:
- -4151575942410437725L
-
Serialized Fields
-
shell
@Valid @NotNull Shell shell
ShellThe configuration of the shell command to run. (Required)
-
-
Class io.serverlessworkflow.api.types.RunTask extends TaskBase implements Serializable
- serialVersionUID:
- 1790072845022448982L
-
Serialized Fields
-
run
@Valid @NotNull RunTaskConfiguration run
RunTaskConfigurationThe configuration of the process to execute. (Required)
-
-
Class io.serverlessworkflow.api.types.RunTaskConfiguration extends Object implements Serializable
- serialVersionUID:
- 3933927401744565348L
-
Serialized Fields
-
await
boolean await
AwaitProcessCompletionWhether to await the process completion before continuing.
-
runContainer
RunContainer runContainer
-
runScript
RunScript runScript
-
runShell
RunShell runShell
-
runWorkflow
RunWorkflow runWorkflow
-
value
Object value
-
-
Class io.serverlessworkflow.api.types.RunWorkflow extends Object implements Serializable
- serialVersionUID:
- -8545127281603329468L
-
Serialized Fields
-
workflow
@Valid @NotNull SubflowConfiguration workflow
SubflowConfigurationThe configuration of the workflow to run. (Required)
-
-
Class io.serverlessworkflow.api.types.Schedule extends Object implements Serializable
- serialVersionUID:
- 140709710440295586L
-
Serialized Fields
-
after
Duration after
-
cron
String cron
ScheduleCronSpecifies the schedule using a cron expression, e.g., '0 0 * * *' for daily at midnight.
-
every
Duration every
-
on
@Valid EventConsumptionStrategy on
EventConsumptionStrategyDescribe the event consumption strategy to adopt.
-
-
Class io.serverlessworkflow.api.types.Schema extends Object implements Serializable
- serialVersionUID:
- 7823919531911950336L
-
Serialized Fields
-
format
String format
SchemaFormatThe schema's format. Defaults to 'json'. The (optional) version of the format can be set using `{format}:{version}`.
-
schemaExternal
SchemaExternal schemaExternal
-
schemaInline
SchemaInline schemaInline
-
value
Object value
-
-
Class io.serverlessworkflow.api.types.SchemaExternal extends Object implements Serializable
- serialVersionUID:
- -281847305029950972L
-
Serialized Fields
-
resource
@Valid @NotNull ExternalResource resource
ExternalResourceRepresents an external resource. (Required)
-
-
Class io.serverlessworkflow.api.types.SchemaInline extends Object implements Serializable
- serialVersionUID:
- 4386957133877652996L
-
Serialized Fields
-
document
@NotNull Object document
The schema's inline definition. (Required)
-
-
Class io.serverlessworkflow.api.types.Script extends Object implements Serializable
- serialVersionUID:
- 7938356327697911103L
-
Serialized Fields
-
arguments
@Valid ScriptArguments arguments
ScriptArgumentsA key/value mapping of the arguments, if any, to use when running the configured script.
-
environment
@Valid ScriptEnvironment environment
ScriptEnvironmentA key/value mapping of the environment variables, if any, to use when running the configured script process.
-
externalScript
ExternalScript externalScript
-
inlineScript
InlineScript inlineScript
-
language
@NotNull String language
ScriptLanguageThe language of the script to run. (Required)
-
value
Object value
-
-
Class io.serverlessworkflow.api.types.ScriptArguments extends Object implements Serializable
- serialVersionUID:
- -4028193038331333683L
-
Class io.serverlessworkflow.api.types.ScriptEnvironment extends Object implements Serializable
- serialVersionUID:
- 2937544793065652347L
-
Class io.serverlessworkflow.api.types.SecretBasedAuthenticationPolicy extends Object implements Serializable
- serialVersionUID:
- 4463556007795808936L
-
Serialized Fields
-
use
@Size(min=1) @NotNull String use
SecretBasedAuthenticationPolicyNameThe name of the authentication policy to use. (Required)
-
-
Class io.serverlessworkflow.api.types.SetTask extends TaskBase implements Serializable
- serialVersionUID:
- 4601395713843122554L
-
Serialized Fields
-
set
@Valid @NotNull SetTaskConfiguration set
SetTaskConfigurationThe data to set. (Required)
-
-
Class io.serverlessworkflow.api.types.SetTaskConfiguration extends Object implements Serializable
- serialVersionUID:
- 7311302913559485533L
-
Class io.serverlessworkflow.api.types.Shell extends Object implements Serializable
- serialVersionUID:
- -4177945241442723917L
-
Serialized Fields
-
arguments
@Valid ShellArguments arguments
ShellArgumentsA list of the arguments of the shell command to run.
-
command
@NotNull String command
ShellCommandThe shell command to run. (Required)
-
environment
@Valid ShellEnvironment environment
ShellEnvironmentA key/value mapping of the environment variables, if any, to use when running the configured process.
-
-
Class io.serverlessworkflow.api.types.ShellArguments extends Object implements Serializable
- serialVersionUID:
- 8948898772519875114L
-
Class io.serverlessworkflow.api.types.ShellEnvironment extends Object implements Serializable
- serialVersionUID:
- -8786420880541224286L
-
Class io.serverlessworkflow.api.types.SubflowConfiguration extends Object implements Serializable
- serialVersionUID:
- -2918860046276868816L
-
Serialized Fields
-
input
@Valid SubflowInput input
SubflowInputThe data, if any, to pass as input to the workflow to execute. The value should be validated against the target workflow's input schema, if specified.
-
name
@NotNull String name
SubflowNameThe name of the workflow to run. (Required)
-
namespace
@NotNull String namespace
SubflowNamespaceThe namespace the workflow to run belongs to. (Required)
-
version
@NotNull String version
SubflowVersionThe version of the workflow to run. Defaults to latest. (Required)
-
-
Class io.serverlessworkflow.api.types.SubflowInput extends Object implements Serializable
- serialVersionUID:
- -5316475928913392907L
-
Class io.serverlessworkflow.api.types.SwitchCase extends Object implements Serializable
- serialVersionUID:
- -1695766134384576749L
-
Serialized Fields
-
then
@NotNull FlowDirective then
FlowDirectiveRepresents different transition options for a workflow. (Required)
-
when
String when
SwitchCaseConditionA runtime expression used to determine whether or not the case matches.
-
-
Class io.serverlessworkflow.api.types.SwitchItem extends Object implements Serializable
- serialVersionUID:
- 2604749525674435832L
-
Serialized Fields
-
name
String name
-
switchCase
SwitchCase switchCase
-
-
Class io.serverlessworkflow.api.types.SwitchTask extends TaskBase implements Serializable
- serialVersionUID:
- -8224937307001699126L
-
Serialized Fields
-
_switch
@Size(min=1) @Valid @NotNull List<SwitchItem> _switch
SwitchTaskConfigurationThe definition of the switch to use. (Required)
-
-
Class io.serverlessworkflow.api.types.TaskBase extends Object implements Serializable
- serialVersionUID:
- -2383885712873823411L
-
Serialized Fields
-
_if
String _if
TaskBaseIfA runtime expression, if any, used to determine whether or not the task should be run.
-
export
@Valid Export export
ExportSet the content of the context. .
-
input
@Valid Input input
InputConfigures the input of a workflow or task.
-
metadata
@Valid TaskMetadata metadata
TaskMetadataHolds additional information about the task.
-
output
@Valid Output output
OutputConfigures the output of a workflow or task.
-
then
FlowDirective then
FlowDirectiveRepresents different transition options for a workflow.
-
timeout
TaskTimeout timeout
TaskTimeout
-
-
Class io.serverlessworkflow.api.types.TaskItem extends Object implements Serializable
- serialVersionUID:
- -5433836956772486133L
-
Class io.serverlessworkflow.api.types.TaskMetadata extends Object implements Serializable
- serialVersionUID:
- -5153304375961534374L
-
Class io.serverlessworkflow.api.types.Timeout extends Object implements Serializable
- serialVersionUID:
- 1532589983808381933L
-
Serialized Fields
-
after
@NotNull Duration after
(Required)
-
-
Class io.serverlessworkflow.api.types.TryTask extends TaskBase implements Serializable
- serialVersionUID:
- -7507645702321341331L
-
Serialized Fields
-
_catch
@Valid @NotNull TryTaskCatch _catch
TryTaskCatchThe object used to define the errors to catch. (Required)
-
_try
@Valid @NotNull List<TaskItem> _try
TaskListList of named tasks to perform. (Required)
-
-
Class io.serverlessworkflow.api.types.TryTaskCatch extends Object implements Serializable
- serialVersionUID:
- -2980534664391804822L
-
Serialized Fields
-
_do
@Valid List<TaskItem> _do
TaskListList of named tasks to perform.
-
as
String as
CatchAsThe name of the runtime expression variable to save the error as. Defaults to 'error'.
-
errors
@Valid CatchErrors errors
CatchErrorsThe configuration of a concept used to catch errors.
-
exceptWhen
String exceptWhen
CatchExceptWhenA runtime expression used to determine whether or not to catch the filtered error.
-
retry
Retry retry
-
when
String when
CatchWhenA runtime expression used to determine whether or not to catch the filtered error.
-
-
Class io.serverlessworkflow.api.types.Use extends Object implements Serializable
- serialVersionUID:
- -8485027501412762808L
-
Serialized Fields
-
authentications
@Valid UseAuthentications authentications
UseAuthenticationsThe workflow's reusable authentication policies.
-
catalogs
@Valid UseCatalogs catalogs
UseCatalogsThe workflow's reusable catalogs.
-
errors
@Valid UseErrors errors
UseErrorsThe workflow's reusable errors.
-
extensions
@Valid List<ExtensionItem> extensions
UseExtensionsThe workflow's extensions.
-
functions
@Valid UseFunctions functions
UseFunctionsThe workflow's reusable functions.
-
retries
@Valid UseRetries retries
UseRetriesThe workflow's reusable retry policies.
-
secrets
@Valid List<String> secrets
UseSecretsThe workflow's reusable secrets.
-
timeouts
@Valid UseTimeouts timeouts
UseTimeoutsThe workflow's reusable timeouts.
-
-
Class io.serverlessworkflow.api.types.UseAuthentications extends Object implements Serializable
- serialVersionUID:
- 1939980009192415075L
-
Serialized Fields
-
additionalProperties
@Valid Map<String,AuthenticationPolicy> additionalProperties
-
-
Class io.serverlessworkflow.api.types.UseCatalogs extends Object implements Serializable
- serialVersionUID:
- 737387449299831678L
-
Class io.serverlessworkflow.api.types.UseErrors extends Object implements Serializable
- serialVersionUID:
- 3619218347629154700L
-
Class io.serverlessworkflow.api.types.UseFunctions extends Object implements Serializable
- serialVersionUID:
- 3806744985098419387L
-
Class io.serverlessworkflow.api.types.UseRetries extends Object implements Serializable
- serialVersionUID:
- 3408004230593904453L
-
Serialized Fields
-
additionalProperties
@Valid Map<String,RetryPolicy> additionalProperties
-
-
Class io.serverlessworkflow.api.types.UseTimeouts extends Object implements Serializable
- serialVersionUID:
- -3306700904689443912L
-
Class io.serverlessworkflow.api.types.WaitTask extends TaskBase implements Serializable
- serialVersionUID:
- -5218405439371544692L
-
Serialized Fields
-
wait
@NotNull Duration wait
(Required)
-
-
Class io.serverlessworkflow.api.types.WithAsyncAPIPayload extends Object implements Serializable
- serialVersionUID:
- -6551349149118535908L
-
Class io.serverlessworkflow.api.types.WithGRPCArguments extends Object implements Serializable
- serialVersionUID:
- 579799421401796365L
-
Class io.serverlessworkflow.api.types.WithGRPCService extends Object implements Serializable
- serialVersionUID:
- -4587144747811442743L
-
Serialized Fields
-
authentication
@Valid ReferenceableAuthenticationPolicy authentication
ReferenceableAuthenticationPolicyRepresents a referenceable authentication policy.
-
host
@Pattern(regexp="^[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?$") @NotNull String host
WithGRPCServiceHostThe hostname of the GRPC service to call. (Required)
-
name
@NotNull String name
WithGRPCServiceNameThe name of the GRPC service to call. (Required)
-
port
@jakarta.validation.constraints.DecimalMin("0"),@jakarta.validation.constraints.DecimalMax("65535") int port
WithGRPCServicePostThe port number of the GRPC service to call.
-
-
Class io.serverlessworkflow.api.types.WithHTTPHeaders extends Object implements Serializable
- serialVersionUID:
- -6312345528560717530L
-
Class io.serverlessworkflow.api.types.WithHTTPQuery extends Object implements Serializable
- serialVersionUID:
- 3647014975623529034L
-
Class io.serverlessworkflow.api.types.WithOpenAPIParameters extends Object implements Serializable
- serialVersionUID:
- 5418890653268485260L
-
Class io.serverlessworkflow.api.types.Workflow extends Object implements Serializable
- serialVersionUID:
- -9024292420012108146L
-
Serialized Fields
-
_do
@Valid @NotNull List<TaskItem> _do
TaskListList of named tasks to perform. (Required)
-
document
@Valid @NotNull Document document
DocumentDocuments the workflow. (Required)
-
input
@Valid Input input
InputConfigures the input of a workflow or task.
-
output
@Valid Output output
OutputConfigures the output of a workflow or task.
-
schedule
@Valid Schedule schedule
ScheduleSchedules the workflow.
-
timeout
DoTimeout timeout
DoTimeout -
use
@Valid Use use
UseDefines the workflow's reusable components.
-
-
Class io.serverlessworkflow.api.types.WorkflowMetadata extends Object implements Serializable
- serialVersionUID:
- 7952968809206009125L
-
Class io.serverlessworkflow.api.types.WorkflowTags extends Object implements Serializable
- serialVersionUID:
- 1017438847142571817L
-
-
Package io.serverlessworkflow.serialization
-
Class io.serverlessworkflow.serialization.BeanDeserializerModifierWithValidation extends com.fasterxml.jackson.databind.deser.BeanDeserializerModifier implements Serializable
- serialVersionUID:
- 1L
-
Class io.serverlessworkflow.serialization.BeanDeserializerWithValidation extends com.fasterxml.jackson.databind.deser.BeanDeserializer implements Serializable
- serialVersionUID:
- 1L
-