資源:操作
此資源表示長時間運行的操作,該操作是網路 API 呼叫的結果。
該操作的response
欄位將是UploadReleaseResponse 。
JSON 表示 |
---|
{ "name": string, "metadata": { "@type": string, field1: ..., ... }, "done": boolean, // Union field |
領域 | |
---|---|
name | 伺服器分配的名稱,僅在最初傳回它的相同服務中是唯一的。如果您使用預設的 HTTP 映射,則該 |
metadata | 與操作關聯的特定於服務的元資料。它通常包含進度資訊和通用元數據,例如建立時間。某些服務可能不提供此類元資料。任何傳回長時間運行操作的方法都應記錄元資料類型(如果有)。 包含任意類型欄位的物件。附加欄位 |
done | 如果值為 |
聯盟場result 。操作結果,可以是error ,也可以是有效response 。如果done == false ,則不會設定error 或response 。如果done == true ,則可以設定error 或response 之一。某些服務可能無法提供結果。 result 只能是以下之一: | |
error | 失敗或取消時操作的錯誤結果。 |
response | 操作成功時的正常反應。在本例中,它將是UploadReleaseResponse 。 |
地位
Status
類型定義了適合不同程式設計環境的邏輯錯誤模型,包括REST API和RPC API。它由gRPC使用。每條Status
訊息包含三部分資料:錯誤代碼、錯誤訊息和錯誤詳細資料。
您可以在API 設計指南中找到有關此錯誤模型以及如何使用它的更多資訊。
JSON 表示 |
---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
領域 | |
---|---|
code | 狀態碼,應該是 |
message | 面向開發人員的錯誤訊息,應為英文。任何面向使用者的錯誤訊息都應本地化並在 |
details[] | 包含錯誤詳細資訊的訊息清單。有一組通用的訊息類型可供 API 使用。 包含任意類型欄位的物件。附加欄位 |
方法 | |
---|---|
| 取得長時間運行的操作的最新狀態。 |