Returns an execution of the given name.
Arguments
Parameters | |
---|---|
name |
Required. Name of the execution to be retrieved. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}
|
view |
Optional. A view defining which fields should be filled in the returned execution. The API will default to the FULL view.
|
Enum type. Can be one of the following: | |
EXECUTION_VIEW_UNSPECIFIED |
The default / unset value. |
BASIC |
Includes only basic metadata about the execution. Following fields are returned: name, start_time, end_time, state and workflow_revision_id. |
FULL |
Includes all data. |
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. |
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
- get: call: googleapis.workflowexecutions.v1.projects.locations.workflows.executions.get args: name: ... view: ... result: getResult
JSON
[ { "get": { "call": "googleapis.workflowexecutions.v1.projects.locations.workflows.executions.get", "args": { "name": "...", "view": "..." }, "result": "getResult" } } ]