Waits for the specified Operation resource to return as DONE
or for
the request to approach the 2 minute deadline, and retrieves the
specified Operation resource. This method differs from the GET
method
in that it waits for no more than the default deadline (2 minutes) and
then returns the current state of the operation, which might be DONE
or still in progress. This method is called on a best-effort basis.
Specifically: - In uncommon cases, when the server is overloaded, the
request might return before the default deadline is reached, or might
return after zero seconds. - If the default deadline is reached, there
is no guarantee that the operation is actually done when the method
returns. Be prepared to retry if the operation is not DONE
.
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. See the
Connectors reference.
The connector uses polling to monitor the long-running operation, which might generate additional billable steps. For more information about retries and long-running operations, refer to Understand connectors.
The polling policy for the long-running operation can be configured. To set the
connector-specific parameters (connector_params
), refer to
Invoke a connector call.
Arguments
Parameters | |
---|---|
operation |
Required. Name of the Operations resource to return.
|
project |
Required. Project ID for this request.
|
region |
Required. Name of the region for this request.
|
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 Operation
.
Subworkflow snippet
Some fields might be optional or required. To identify required fields, refer to the API documentation.
YAML
- wait: call: googleapis.compute.v1.regionOperations.wait args: operation: ... project: ... region: ... result: waitResult
JSON
[ { "wait": { "call": "googleapis.compute.v1.regionOperations.wait", "args": { "operation": "...", "project": "...", "region": "..." }, "result": "waitResult" } } ]