索引
Operations
(インターフェース)-
CancelOperationRequest
(メッセージ) -
DeleteOperationRequest
(メッセージ) -
GetOperationRequest
(メッセージ) -
ListOperationsRequest
(メッセージ) -
ListOperationsResponse
(メッセージ) -
Operation
(メッセージ) -
WaitOperationRequest
(メッセージ)
オペレーション
API サービスを使用して長時間実行オペレーションを管理します。
通常、API メソッドの完了に時間がかかる場合、クライアントにOperation
返すように設計できます。クライアントはこのインターフェイスを使用して、オペレーション リソースをポーリングすることで実際の応答を非同期で受信したり、オペレーション リソースを別の API に渡したりできます ( Pub/Sub API など)を使用して応答を受信します。長時間実行オペレーションを返す API サービスは、開発者が一貫したクライアント エクスペリエンスを実現できるように、 Operations
インターフェイスを実装する必要があります。
操作のキャンセル |
---|
長時間実行操作で非同期キャンセルを開始します。サーバーは操作をキャンセルするために最善の努力をしますが、成功は保証されません。サーバーがこのメソッドをサポートしていない場合は、
|
削除操作 |
---|
長時間実行されるオペレーションを削除します。このメソッドは、クライアントが操作結果にもう興味がないことを示します。操作はキャンセルされません。サーバーがこのメソッドをサポートしていない場合は、
|
Getオペレーション |
---|
長時間実行される操作の最新の状態を取得します。クライアントは、このメソッドを使用して、API サービスが推奨する間隔で操作結果をポーリングできます。
|
リスト操作 |
---|
リクエスト内の指定されたフィルターに一致するオペレーションをリストします。サーバーがこのメソッドをサポートしていない場合は、
|
待機操作 |
---|
指定された長時間実行操作が完了するか、最大でも指定されたタイムアウトに達するまで待機し、最新の状態を返します。操作がすでに完了している場合は、最新の状態がすぐに返されます。指定されたタイムアウトがデフォルトの HTTP/RPC タイムアウトより大きい場合は、HTTP/RPC タイムアウトが使用されます。サーバーがこのメソッドをサポートしていない場合は、
|
オペレーションリクエストのキャンセル
Operations.CancelOperation
のリクエスト メッセージ。
田畑 | |
---|---|
name | キャンセルする操作リソースの名前。 |
削除操作リクエスト
Operations.DeleteOperation
のリクエスト メッセージ。
田畑 | |
---|---|
name | 削除する操作リソースの名前。 |
GetOperationRequest
Operations.GetOperation
のリクエスト メッセージ。
田畑 | |
---|---|
name | 操作リソースの名前。 |
ListOperationsRequest
Operations.ListOperations
のリクエスト メッセージ。
田畑 | |
---|---|
name | オペレーションの親リソースの名前。 |
filter | 標準のリストフィルター。 |
page_size | 標準のリストのページ サイズ。 |
page_token | 標準のリストページトークン。 |
リスト操作応答
Operations.ListOperations
の応答メッセージ。
田畑 | |
---|---|
operations[] | リクエストで指定されたフィルターに一致する操作のリスト。 |
next_page_token | 標準のリストの次ページ トークン。 |
手術
このリソースは、ネットワーク API 呼び出しの結果である長時間実行操作を表します。
田畑 | |
---|---|
name | サーバーによって割り当てられた名前。最初にそれを返した同じサービス内でのみ一意です。デフォルトの HTTP マッピングを使用する場合、 |
metadata | 操作に関連付けられたサービス固有のメタデータ。通常、これには進行状況情報と作成時間などの共通のメタデータが含まれます。一部のサービスでは、そのようなメタデータが提供されない場合があります。長時間実行オペレーションを返すメソッドは、メタデータ型がある場合はそれを文書化する必要があります。 |
done | 値が |
共用体フィールドresult 。操作の結果。 error または有効なresponse いずれかになります。 done == false の場合、 error もresponse も設定されません。 done == true の場合、 error またはresponse のいずれか 1 つだけを設定できます。一部のサービスでは結果が得られない場合があります。 result 次のいずれか 1 つだけになります。 | |
error | 失敗またはキャンセルされた場合の操作のエラー結果。 |
response | 操作の正常な正常な応答。元のメソッドが成功時にデータを返さない場合 ( |
WaitOperationRequest
Operations.WaitOperation
のリクエスト メッセージ。
田畑 | |
---|---|
name | 待機する操作リソースの名前。 |
timeout | タイムアウトになるまでの最大待機時間。空白のままにすると、待機時間は最大でも基礎となる HTTP/RPC プロトコルで許可される時間になります。 RPC コンテキストの期限も指定されている場合は、短い方が使用されます。 |