Google Cloud Workflows
Google Cloud Workflows configuration file
| Type | object | stepArray |
|---|---|
| File match |
workflows.json
workflows.yaml
workflows.yml
*.workflows.json
*.workflows.yaml
*.workflows.yml
|
| Schema URL | https://catalog.lintel.tools/schemas/schemastore/google-cloud-workflows/latest.json |
| Source | https://www.schemastore.org/workflows.json |
Validate with Lintel
npx @lintel/lintel checkOrchestrate Workflows consisting of Google Cloud APIs, SaaS APIs or private API endpoints.
One of
Definitions
A subworkflow.
The name of the parameter variable.
An array of objects with a single step.
A single workflow step.
Run a function and return a result.
Pass arguments and their values when calling a function that accepts parameters.
8 nested properties
The type of HTTP request method to use. Required if using call type http.request.
Header fields to supply input to the API.
Body fields to supply input to the API.
Query fields to supply input to the API.
Required if the API being called requires authentication.
4 nested properties
The type of authentication.
Specify token scope to limit an application's access to a user's account.
Specify token scope to limit an application's access to a user's account.
Specifies the audience for the OIDC token. By default, it's set to the same value as url; however, it should be set to your service's root URL.
Time in seconds. How long a request is allowed to run before throwing an exception. Default and maximum values vary by call.
Connector-specific parameters.
4 nested properties
Time in seconds. The end-to-end duration the connector call is allowed to run for before throwing a timeout exception.
Polling policy.
If set to True, the connector invocation call is non-blocking if the initial request to manage or update the resource succeeds
Specify token scope to limit an application's access to a user's account.
Assign the result from a call to this variable.
Define what step Workflows should execute next.
A switch block. A selection mechanism that allows the value of an expression to control the flow of a workflow's execution. If a value matches, that condition's statement is executed.
Iterates over a sequence of numbers or through a collection of data, such as a list or map.
5 nested properties
A loop variable name. Contains the value of the currently iterated element.
An index variable name. Contains the value to the current offset of the iteration.
An expression that evaluates into a list or a list definition. Required, if not using 'range'.
A list of two expressions, specifying the beginning and end of the range, both inclusive. Required, if not using 'in'.
Define a part of your workflow where two or more steps can execute concurrently. A 'parallel' step waits until all the steps defined within it have completed or are interrupted by an unhandled exception; execution then continues.
5 nested properties
The action for other branches when an exception occurs. Optional. The default policy, 'continueAll', results in no further action, and all other branches will attempt to run.
A list of writable variables with parent scope that allow assignments within the 'parallel' step.
The maximum number of branches and iterations that can concurrently execute within a single workflow execution before further branches and iterations are queued to wait. This applies to a single 'parallel' step only and does not cascade. Must be a positive integer and can be either a literal value or an expression.
Execute parallel branches concurrently and the steps in each branch sequentially.
Iterates over a sequence of numbers or through a collection of data, such as a list or map.
5 nested properties
A loop variable name. Contains the value of the currently iterated element.
An index variable name. Contains the value to the current offset of the iteration.
An expression that evaluates into a list or a list definition. Required, if not using 'range'.
A list of two expressions, specifying the beginning and end of the range, both inclusive. Required, if not using 'in'.
Raise an exception.
Define a retry policy to retry steps that return a specific error code.
A try/except structure for error handling.
2 nested properties
The name of a map variable that contains the error message.
Stop a workflow's execution and return a value, variable, or expression.
A list of variable assignment maps.
Run a function and return a result.
Pass arguments and their values when calling a function that accepts parameters.
The type of HTTP request method to use. Required if using call type http.request.
Header fields to supply input to the API.
Body fields to supply input to the API.
Query fields to supply input to the API.
Required if the API being called requires authentication.
4 nested properties
The type of authentication.
Specify token scope to limit an application's access to a user's account.
Specify token scope to limit an application's access to a user's account.
Specifies the audience for the OIDC token. By default, it's set to the same value as url; however, it should be set to your service's root URL.
Time in seconds. How long a request is allowed to run before throwing an exception. Default and maximum values vary by call.
Connector-specific parameters.
4 nested properties
Time in seconds. The end-to-end duration the connector call is allowed to run for before throwing a timeout exception.
Polling policy.
3 nested properties
Time in seconds. Only applies to long-running operation calls.
Time in seconds. Only applies to long-running operation calls.
Time in seconds. Only applies to long-running operation calls.
If set to True, the connector invocation call is non-blocking if the initial request to manage or update the resource succeeds
Specify token scope to limit an application's access to a user's account.
Assign the result from a call to this variable.
Define what step Workflows should execute next.
Stop a workflow's execution and return a value, variable, or expression.
Iterates over a sequence of numbers or through a collection of data, such as a list or map.
A loop variable name. Contains the value of the currently iterated element.
An index variable name. Contains the value to the current offset of the iteration.
An expression that evaluates into a list or a list definition. Required, if not using 'range'.
A list of two expressions, specifying the beginning and end of the range, both inclusive. Required, if not using 'in'.
Define a part of your workflow where two or more steps can execute concurrently. A 'parallel' step waits until all the steps defined within it have completed or are interrupted by an unhandled exception; execution then continues.
The action for other branches when an exception occurs. Optional. The default policy, 'continueAll', results in no further action, and all other branches will attempt to run.
A list of writable variables with parent scope that allow assignments within the 'parallel' step.
The maximum number of branches and iterations that can concurrently execute within a single workflow execution before further branches and iterations are queued to wait. This applies to a single 'parallel' step only and does not cascade. Must be a positive integer and can be either a literal value or an expression.
Execute parallel branches concurrently and the steps in each branch sequentially.
Iterates over a sequence of numbers or through a collection of data, such as a list or map.
5 nested properties
A loop variable name. Contains the value of the currently iterated element.
An index variable name. Contains the value to the current offset of the iteration.
An expression that evaluates into a list or a list definition. Required, if not using 'range'.
A list of two expressions, specifying the beginning and end of the range, both inclusive. Required, if not using 'in'.
An array of objects with a single step.
A switch block. A selection mechanism that allows the value of an expression to control the flow of a workflow's execution. If a value matches, that condition's statement is executed.
Define conditional expressions for a switch block.
An expression to switch on.
Run a function and return a result.
Pass arguments and their values when calling a function that accepts parameters.
8 nested properties
The type of HTTP request method to use. Required if using call type http.request.
Header fields to supply input to the API.
Body fields to supply input to the API.
Query fields to supply input to the API.
Required if the API being called requires authentication.
4 nested properties
The type of authentication.
Specify token scope to limit an application's access to a user's account.
Specify token scope to limit an application's access to a user's account.
Specifies the audience for the OIDC token. By default, it's set to the same value as url; however, it should be set to your service's root URL.
Time in seconds. How long a request is allowed to run before throwing an exception. Default and maximum values vary by call.
Connector-specific parameters.
4 nested properties
Time in seconds. The end-to-end duration the connector call is allowed to run for before throwing a timeout exception.
Polling policy.
If set to True, the connector invocation call is non-blocking if the initial request to manage or update the resource succeeds
Specify token scope to limit an application's access to a user's account.
Assign the result from a call to this variable.
Define what step Workflows should execute next.
A switch block. A selection mechanism that allows the value of an expression to control the flow of a workflow's execution. If a value matches, that condition's statement is executed.
Iterates over a sequence of numbers or through a collection of data, such as a list or map.
5 nested properties
A loop variable name. Contains the value of the currently iterated element.
An index variable name. Contains the value to the current offset of the iteration.
An expression that evaluates into a list or a list definition. Required, if not using 'range'.
A list of two expressions, specifying the beginning and end of the range, both inclusive. Required, if not using 'in'.
Define a part of your workflow where two or more steps can execute concurrently. A 'parallel' step waits until all the steps defined within it have completed or are interrupted by an unhandled exception; execution then continues.
5 nested properties
The action for other branches when an exception occurs. Optional. The default policy, 'continueAll', results in no further action, and all other branches will attempt to run.
A list of writable variables with parent scope that allow assignments within the 'parallel' step.
The maximum number of branches and iterations that can concurrently execute within a single workflow execution before further branches and iterations are queued to wait. This applies to a single 'parallel' step only and does not cascade. Must be a positive integer and can be either a literal value or an expression.
Execute parallel branches concurrently and the steps in each branch sequentially.
Iterates over a sequence of numbers or through a collection of data, such as a list or map.
5 nested properties
A loop variable name. Contains the value of the currently iterated element.
An index variable name. Contains the value to the current offset of the iteration.
An expression that evaluates into a list or a list definition. Required, if not using 'range'.
A list of two expressions, specifying the beginning and end of the range, both inclusive. Required, if not using 'in'.
Raise an exception.
Define a retry policy to retry steps that return a specific error code.
A try/except structure for error handling.
2 nested properties
The name of a map variable that contains the error message.
Stop a workflow's execution and return a value, variable, or expression.
Raise an exception.
A try/except structure for error handling.
A try/except structure for error handling.
The name of a map variable that contains the error message.
Define a retry policy to retry steps that return a specific error code.
Specify token scope to limit an application's access to a user's account.