REST Resource: operations

リソース: オペレーション

このリソースは、ネットワーク 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 マッピングを使用する場合、 name operations/{unique_id}で終わるリソース名にする必要があります。

metadata

object

操作に関連付けられたサービス固有のメタデータ。通常、これには進行状況情報と作成時間などの共通のメタデータが含まれます。一部のサービスでは、そのようなメタデータが提供されない場合があります。長時間実行オペレーションを返すメソッドは、メタデータ型がある場合はそれを文書化する必要があります。

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

done

boolean

値がfalseの場合、操作がまだ進行中であることを意味します。 trueの場合、操作は完了し、 errorまたはresponseいずれかが使用可能になります。

ユニオンフィールドのresult 。操作の結果。 errorまたは有効なresponseいずれかになります。 done == falseの場合、 errorresponseも設定されません。 done == trueの場合、 errorまたはresponseのいずれか 1 つだけを設定できます。一部のサービスでは結果が得られない場合があります。 result次のいずれか 1 つだけになります。
error

object ( Status )

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

response

object

成功した場合の操作の通常の応答。元のメソッドが成功時にデータを返さない場合 ( Deleteなど)、応答はgoogle.protobuf.Emptyです。元のメソッドが標準のGet / Create / Updateの場合、応答はリソースである必要があります。他のメソッドの場合、応答のタイプはXxxResponseである必要があります。 Xxxは元のメソッド名です。たとえば、元のメソッド名がTakeSnapshot()の場合、推論される応答タイプはTakeSnapshotResponseです。

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

状態

Statusタイプは、REST API や RPC API などのさまざまなプログラミング環境に適した論理エラー モデルを定義します。 gRPCによって使用されます。各Statusメッセージには、エラー コード、エラー メッセージ、エラーの詳細という 3 つのデータが含まれています。

このエラー モデルとその操作方法の詳細については、 「API 設計ガイド」を参照してください。

JSON表現
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
田畑
code

integer

ステータス コード。 google.rpc.Codeの列挙値である必要があります。

message

string

開発者向けのエラー メッセージ。英語である必要があります。ユーザー向けのエラー メッセージはローカライズしてgoogle.rpc.Status.detailsフィールドに送信するか、クライアントによってローカライズする必要があります。

details[]

object

エラーの詳細を伝えるメッセージのリスト。 API で使用する共通のメッセージ タイプのセットがあります。

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

メソッド

get

長時間実行される操作の最新の状態を取得します。