資源:Operation
這個資源表示屬於網路 API 呼叫結果的長時間執行作業。
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 |
作業的正常且成功回應。如果原始方法在執行成功時沒有傳回資料 (例如 包含任意類型欄位的物件。額外的 |
狀態
Status
類型會定義適用於不同程式設計環境 (包含 REST API 和遠端程序呼叫 (RPC) API) 的邏輯錯誤模型。gRPC 會使用這個模型。每個 Status
訊息包含三部分的資料:錯誤代碼、錯誤訊息和錯誤詳細資料。
如要進一步瞭解這個錯誤模型,以及如何使用這個錯誤模型,請參閱 API 設計指南。
JSON 表示法 |
---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
欄位 | |
---|---|
code |
狀態碼,應為 |
message |
向開發人員顯示的錯誤訊息,應以英文呈現。凡是向使用者顯示的錯誤訊息,都應透過 |
details[] |
附有錯誤詳細資料的訊息清單。這是供 API 使用的一組常用訊息類型。 包含任意類型欄位的物件。額外的 |
方法 |
|
---|---|
|
開始以非同步的方式,取消長時間執行的作業。 |
|
刪除長時間執行的作業。 |
|
取得長時間執行的作業的最新狀態。 |
|
列出符合要求中指定篩選器的作業。 |