REST Resource: projects.operations

リソース: Operation

このリソースは、ネットワーク API 呼び出しの結果である長時間実行オペレーションを表します。

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

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "error": {
    object (Status)
  },
  "response": {
    "@type": string,
    field1: ...,
    ...
  }
  // End of mutually exclusive fields.
}
フィールド
name

string

サーバーによって割り当てられる名前。最初にその名前を返すサービスと同じサービス内でのみ一意になります。デフォルトの HTTP マッピングを使用している場合は、name を operations/{unique_id} で終わるリソース名にします。
metadata

object

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

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

boolean

値が false の場合は、オペレーションが進行中であることを意味します。true の場合、オペレーションは完了しており、error または response が利用可能です。
オペレーションの結果。error または有効な response になります。done == false の場合、error も response も設定されません。done == true の場合、error または response のいずれか 1 つだけを設定できます。一部のサービスでは結果が返されない場合があります。相互に排他的なフィールドのリストは次のとおりです。レスポンスで設定されるフィールドは、次のうち最大 1 つです。
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

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

wait

 指定された長時間実行オペレーションが完了するか、指定されたタイムアウトに達するまで待機し、最新の状態を返します。