REST Resource: operations

資源：操作

此資源表示長時間運行的操作，該操作是網路 API 呼叫的結果。

JSON 表示
{
  "name": string,
  "metadata": {
    "@type": string,
    field1: ...,
    ...
  },
  "done": boolean,

  // Union field result can be only one of the following:
  "error": {
    object (Status)
  },
  "response": {
    "@type": string,
    field1: ...,
    ...
  }
  // End of list of possible types for union field result.
}
領域
name

string

伺服器分配的名稱，僅在最初傳回它的相同服務中是唯一的。如果您使用預設的 HTTP 映射，則該name應該是以operations/{unique_id}結尾的資源名稱。

metadata

object

與操作關聯的特定於服務的元資料。它通常包含進度資訊和通用元數據，例如建立時間。某些服務可能不提供此類元資料。任何傳回長時間運行操作的方法都應記錄元資料類型（如果有）。

包含任意類型欄位的物件。附加欄位"@type"包含標識類型的 URI。範例： { "id": 1234, "@type": "types.example.com/standard/id" } 。

done

boolean

如果值為false ，則表示操作仍在進行中。如果true ，則操作完成，且error或response可用。

聯盟場result 。操作結果，可以是error ，也可以是有效response 。如果done == false ，則不會設定error或response 。如果done == true ，則可以設定error或response之一。某些服務可能無法提供結果。 result只能是以下之一：
error

object ( Status )

失敗或取消時操作的錯誤結果。

response

object

操作成功時的正常反應。如果原始方法未傳回成功資料（例如Delete ，則回應為google.protobuf.Empty 。如果原始方法是標準Get / Create / Update ，則回應應該是資源。對於其他方法，回應應具有類型XxxResponse ，其中Xxx是原始方法名稱。例如，如果原始方法名稱為TakeSnapshot() ，則推斷的回應類型為TakeSnapshotResponse 。

包含任意類型欄位的物件。附加欄位"@type"包含標識類型的 URI。範例： { "id": 1234, "@type": "types.example.com/standard/id" } 。

地位

Status類型定義了適合不同程式設計環境的邏輯錯誤模型，包括REST API和RPC API。它由gRPC使用。每條Status訊息包含三部分資料：錯誤代碼、錯誤訊息和錯誤詳細資料。

您可以在API 設計指南中找到有關此錯誤模型以及如何使用它的更多資訊。

JSON 表示
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
領域
code

integer

狀態碼，應該是google.rpc.Code的枚舉值。

message

string

面向開發人員的錯誤訊息，應為英文。任何面向使用者的錯誤訊息都應本地化並在google.rpc.Status.details欄位中發送，或由客戶端本地化。

details[]

object

包含錯誤詳細資訊的訊息清單。有一組通用的訊息類型可供 API 使用。

包含任意類型欄位的物件。附加欄位"@type"包含標識類型的 URI。範例： { "id": 1234, "@type": "types.example.com/standard/id" } 。

方法

get

取得長時間運行的操作的最新狀態。