等待指定的長時間執行作業完成或最多達到指定逾時時間,並傳回最新狀態。如果作業已經完成,系統會立刻傳回最新狀態。如果指定的逾時時間比預設的 HTTP/RPC 逾時時間還要長,則會使用 HTTP/RPC 逾時時間。如果伺服器不支援這個方法,則會傳回 google.rpc.Code.UNIMPLEMENTED
。請注意,這個方法會盡可能完成作業。由於它可能會在作業達到指定的逾時時間 (包含立即) 之前就傳回最新狀態,因此就算您立即收到回應,也不代表作業已經完成。
HTTP 要求
POST https://adsdatahub.googleapis.com/v1/{name=operations/**}:wait
這個網址使用 gRPC 轉碼語法。
路徑參數
參數 | |
---|---|
name |
要等待的作業資源名稱。 |
要求主體
要求主體的資料會採用以下結構:
JSON 表示法 |
---|
{ "timeout": string } |
欄位 | |
---|---|
timeout |
逾時前的等待時間上限。如果留空,系統最多會等待基本 HTTP/RPC 通訊協定允許的時間。如果同時指定了 RPC 內容期限,則系統會採用較短的期限。 持續時間以秒為單位,最多九個小數位數,結尾為 ' |
回應主體
如果成功,回應主體會包含 Operation
的執行例項。
授權範圍
需要下列 OAuth 範圍:
https://www.googleapis.com/auth/adsdatahub