リソース: オペレーション
このリソースは、ネットワーク API 呼び出しの結果である長時間実行操作を表します。
操作のresponse
フィールドはUploadReleaseResponseになります。
JSON表現 |
---|
{ "name": string, "metadata": { "@type": string, field1: ..., ... }, "done": boolean, // Union field |
田畑 | |
---|---|
name | サーバーによって割り当てられた名前。最初にそれを返した同じサービス内でのみ一意です。デフォルトの HTTP マッピングを使用する場合、 |
metadata | 操作に関連付けられたサービス固有のメタデータ。通常、これには進行状況情報と作成時間などの共通のメタデータが含まれます。一部のサービスでは、そのようなメタデータが提供されない場合があります。長時間実行オペレーションを返すメソッドは、メタデータ型がある場合はそれを文書化する必要があります。 任意の型のフィールドを含むオブジェクト。追加フィールド |
done | 値が |
共用体フィールドresult 。操作の結果。 error または有効なresponse いずれかになります。 done == false の場合、 error もresponse も設定されません。 done == true の場合、 error またはresponse のいずれか 1 つだけを設定できます。一部のサービスでは結果が得られない場合があります。 result 次のいずれか 1 つだけになります。 | |
error | 失敗またはキャンセルされた場合の操作のエラー結果。 |
response | 成功した場合の操作の通常の応答。この場合、それはUploadReleaseResponseになります。 |
状態
Status
タイプは、REST API や RPC API などのさまざまなプログラミング環境に適した論理エラー モデルを定義します。 gRPCによって使用されます。各Status
メッセージには、エラー コード、エラー メッセージ、エラーの詳細という 3 つのデータが含まれています。
このエラー モデルとその操作方法の詳細については、 「API 設計ガイド」を参照してください。
JSON表現 |
---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
田畑 | |
---|---|
code | ステータス コード。 |
message | 開発者向けのエラー メッセージ。英語である必要があります。ユーザー向けのエラー メッセージはローカライズして |
details[] | エラーの詳細を伝えるメッセージのリスト。 API で使用する共通のメッセージ タイプのセットがあります。 任意の型のフィールドを含むオブジェクト。追加フィールド |
メソッド | |
---|---|
| 長時間実行される操作の最新の状態を取得します。 |