REST リソース: operations

リソース: Operation

このリソースは、ネットワーク 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/some/unique/name の形式になります。

metadata

object

オペレーションに関連付けられているサービス固有のメタデータ。通常は進捗情報や、作成日時などの共通メタデータが含まれます。一部のサービスでは、このようなメタデータが提供されないこともあります。メタデータがある場合、長時間実行オペレーションを返すメソッドでは、メタデータの型をドキュメント化しておく必要があります。

任意のデータ型のフィールドを含むオブジェクト。タイプを識別する URI を含む追加フィールド "@type"。例: { "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 のいずれか 1 つが設定されます。result に設定できるのは次のいずれかのみです。
error

object(Status)

失敗またはキャンセルされた場合のエラー結果。

response

object

成功した場合はオペレーションの通常のレスポンス。元のメソッドで成功時にデータが返されない場合（Delete など）、レスポンスは google.protobuf.Empty になります。元のメソッドが標準の Get/Create/Update である場合、レスポンスはリソースになります。他のメソッドについては、レスポンスのデータ型が XxxResponse（Xxx は元のメソッド名）になります。たとえば、元のメソッド名が TakeSnapshot() であれば、レスポンスのデータ型は TakeSnapshotResponse になると推測できます。

任意のデータ型のフィールドを含むオブジェクト。タイプを識別する URI を含む追加フィールド "@type"。例: { "id": 1234, "@type": "types.example.com/standard/id" }。

メソッド

cancel

 長時間実行オペレーションの非同期キャンセルを開始します。

delete

 長時間実行オペレーションを削除します。

get

 長時間実行オペレーションの最新状態を取得します。

list

 リクエストで指定されたフィルタに一致するオペレーションを一覧表示します。