リソース: Operation
このリソースは、ネットワーク API 呼び出しの結果の長時間実行オペレーションを示します。
JSON 表現 | |
---|---|
{ "name": string, "metadata": { "@type": string, field1: ..., ... }, "done": boolean, // Union field |
フィールド | ||
---|---|---|
name |
サーバーによって割り当てられる名前で、その名前を最初に返した同じサービス内でのみ一意になります。デフォルトの HTTP マッピングを使用している場合、 |
|
metadata |
オペレーションに関連付けられているサービス固有のメタデータ。通常は進捗情報や、作成日時などの共通メタデータが含まれます。一部のサービスでは、このようなメタデータが提供されないこともあります。メタデータがある場合、長時間実行オペレーションを返すメソッドでは、メタデータの型をドキュメント化しておく必要があります。 任意のデータ型のフィールドを含むオブジェクト。タイプを識別する URI を含む追加フィールド |
|
done |
値が |
|
共用体フィールド result 。オペレーションの結果。error または有効な response になります。done == false の場合は、error と response のいずれも設定されません。done == true の場合は、error または response のいずれか 1 つが設定されます。result に設定できるのは次のいずれかのみです。 |
||
error |
失敗またはキャンセルされた場合のエラー結果。 |
|
response |
成功した場合はオペレーションの通常のレスポンス。元のメソッドで成功時にデータが返されない( 任意のデータ型のフィールドを含むオブジェクト。タイプを識別する URI を含む追加フィールド |
メソッド |
|
---|---|
|
長時間実行オペレーションの非同期キャンセルを開始します。 |
|
長時間実行オペレーションを削除します。 |
|
長時間実行オペレーションの最新状態を取得します。 |
|
リクエストで指定されたフィルタに一致するオペレーションを一覧表示します。 |