AI-generated Key Takeaways
-
This method waits for a specified long-running operation to complete or reach a timeout, returning the latest state.
-
The HTTP request uses a POST method with a specific URL structure including the operation name.
-
The request body can optionally include a
timeout
parameter to specify the maximum wait duration. -
If successful, the response body contains an instance of the Operation resource.
-
Authorization requires the
https://www.googleapis.com/auth/checks
OAuth scope.
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code.UNIMPLEMENTED
. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
HTTP request
POST https://checks.googleapis.com/v1alpha/{name=accounts/*/apps/*/operations/*}:wait
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
name |
The name of the operation resource to wait on. |
Request body
The request body contains data with the following structure:
JSON representation |
---|
{ "timeout": string } |
Fields | |
---|---|
timeout |
The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. A duration in seconds with up to nine fractional digits, ending with ' |
Response body
If successful, the response body contains an instance of Operation
.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/checks
For more information, see the OAuth 2.0 Overview.