Method: projects.locations.operations.wait
Stay organized with collections
Save and categorize content based on your preferences.
Waits for the specified long-running operation until it 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://automl.googleapis.com/v1/{name}:wait
Path parameters
Parameters |
name |
string
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 |
string (Duration format)
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, terminated by 's '. Example: "3.5s" .
|
Response body
If successful, the response body contains an instance of Operation
.
Authorization Scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2019-12-17 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2019-12-17 UTC."],[[["This endpoint waits for a specified long-running operation to complete or reach a timeout, returning the latest state, with the timeout defaulting to the HTTP/RPC protocol limit if not specified."],["The HTTP request for this operation is a `POST` to `https://automl.googleapis.com/v1/{name}:wait`."],["The `name` parameter, which is required in the URL path, is a string that identifies the operation resource to be waited on."],["The request body accepts a JSON object with a `timeout` field, which is a string in Duration format representing the maximum wait time, such as `\"3.5s\"`."],["Successful requests return a response body that is an instance of the `Operation` type, and authorization requires the `https://www.googleapis.com/auth/cloud-platform` OAuth scope."]]],[]]