REST リソース: projects.locations.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 マッピングを使用している場合、nameoperations/some/unique/name の形式になります。

metadata

object

{

createTime: オペレーションが作成された時刻。

endTime: オペレーションが実行を完了した時刻。

target: オペレーションのターゲットに対応するサーバー定義のリソースパス。

verb: オペレーションによって実行される動詞の名前。

statusDetail: 人が読める形式のオペレーションのステータス(存在する場合)。

cancelRequested: ユーザーがオペレーションのキャンセルをリクエストしたかどうかを示します。正常にキャンセルされたオペレーションは Operation.error 値を持ち、google.rpc.Status.code が 1 になります。これは、Code.CANCELLED に相当します。

apiVersion: オペレーションを開始するために使用された API のバージョン。

}

done

boolean

値が false の場合は、オペレーションが進行中であることを意味します。true の場合、オペレーションは完了しており、error または response が利用可能です。

共用体フィールド result。オペレーションの結果。error または有効な response になります。done == false の場合は、errorresponse のいずれも設定されません。done == true の場合は、error または response のいずれか 1 つが設定されます。result に設定できるのは次のいずれかのみです。
error

object(Status)

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

response

object

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

メソッド

cancel

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

delete

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

get

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

list

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