Creates a new execution using the latest revision of the given workflow.
This method waits—the workflow execution is paused—until the operation is
complete, fails, or times out. The default timeout value is 1800
seconds (30
minutes) and can be changed to a maximum value of 31536000
seconds (one year)
for long-running operations using the connector_params
field.
The connector uses polling to monitor the long-running operation, which might
generate additional billable steps. The polling policy for the long-running
operation can be configured. For example, if you set skip_polling
to True
,
the connector invocation call is non-blocking if the initial request succeeds;
otherwise, retries might occur.
For more information about connector-specific parameters (connector_params
),
see Invoke a connector call.
For more information about retries and long-running operations, see Understand connectors.
Note that if skip_polling
is set to True
, create()
returns a response
containing an instance of Execution
unlike the run()
method which doesn't
return anything. (If skip_polling
is set to False
, run()
returns the
workflow execution's result as a JSON-decoded object.)
Arguments
Parameters | |
---|---|
parent |
Required. Name of the workflow for which an execution should be created. Format: projects/{project}/locations/{location}/workflows/{workflow} The latest revision of the workflow will be used. |
body |
Required. |
Raised exceptions
Exceptions | |
---|---|
ConnectionError |
In case of a network problem (such as DNS failure or refused connection). |
HttpError |
If the response status is >= 400 (excluding 429 and 503). |
TimeoutError |
If a long-running operation takes longer to finish than the specified timeout limit. |
TypeError |
If an operation or function receives an argument of the wrong type. |
ValueError |
If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout. |
OperationError |
If the long-running operation finished unsuccessfully. |
ResponseTypeError |
If the long-running operation returned a response of the wrong type. |
Response
If successful, the response contains an instance of Execution
.
Subworkflow snippet
Some fields might be optional or required. To identify required fields, refer to the API documentation.
YAML
- create: call: googleapis.workflowexecutions.v1beta.projects.locations.workflows.executions.create args: parent: ... body: argument: ... callLogLevel: ... result: createResult
JSON
[ { "create": { "call": "googleapis.workflowexecutions.v1beta.projects.locations.workflows.executions.create", "args": { "parent": "...", "body": { "argument": "...", "callLogLevel": "..." } }, "result": "createResult" } } ]