このリソースは、ネットワーク API 呼び出しの結果で、長時間継続する操作を表します。
JSON 表現 |
---|
{ "name": string, "metadata": { "@type": string, field1: ..., ... }, "done": boolean, // Union field |
フィールド | |
---|---|
name |
サーバーによって割り当てられた一意の名前。 |
metadata |
転送オペレーション オブジェクトを表します。 任意の型のフィールドを含むオブジェクト。追加フィールドの |
done |
値が |
共用体フィールド result 。オペレーションの結果。error または有効な response になります。done == false の場合、error も response も設定されません。done == true の場合、error または response のどちらか 1 つだけが設定されます。一部のサービスでは結果が返されない場合があります。result は次のいずれかになります。 |
|
error |
失敗またはキャンセルされた場合のオペレーションのエラー結果。 |
response |
オペレーションの通常の成功レスポンス。元のメソッドで成功時にデータが返されない場合( 任意の型のフィールドを含むオブジェクト。追加フィールドの |
ステータス
Status
型は、REST API や RPC API など、さまざまなプログラミング環境に適した論理エラーモデルを定義します。gRPC により使用されます。各 Status
メッセージには、エラーコード、エラー メッセージ、エラーの詳細という 3 種類のデータが含まれます。
このエラーモデルと操作方法について詳しくは、API 設計ガイドをご覧ください。
JSON 表現 |
---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
フィールド | |
---|---|
code |
ステータス コード。 |
message |
デベロッパー向けのエラー メッセージ。英語で記述します。ユーザー向けのエラー メッセージは、ローカライズして |
details[] |
エラーの詳細を保持するメッセージのリスト。API が使用する共通のメッセージ タイプのセットがあります。 任意のデータ型のフィールドを含むオブジェクト。追加フィールドの |