このページは Cloud Translation API によって翻訳されました。

Package google.longrunning

重要: 丸かっこ内の URL にアクセスするには、インターネットに接続する必要があります。この URL は、エアギャップ環境外からアクセスするために提供されます。

運用

API サービスで長時間実行オペレーションを管理します。

完了するまでの時間が通常でも長くなる API メソッドについては、クライアントに Operation を返すように設計できます。クライアントはこのインターフェースを使用することで、オペレーションリソースをポーリングして実際のレスポンスを非同期的に受信できます。また、オペレーションリソースを別の API（Google Cloud Pub/Sub API など）に渡してレスポンスを受信することもできます。長時間実行オペレーションを返す API サービスでは、デベロッパーがクライアントの動作の一貫性を期待できるように、Operations インターフェースを実装する必要があります。

GetOperation

GetOperation
`rpc GetOperation(GetOperationRequest) returns (Operation)` 長時間実行オペレーションの最新状態を取得します。クライアントはこのメソッドを使用して、API サービスで推奨される間隔でオペレーションの結果をポーリングできます。

rpc GetOperation(GetOperationRequest) returns (Operation)

長時間実行オペレーションの最新状態を取得します。クライアントはこのメソッドを使用して、API サービスで推奨される間隔でオペレーションの結果をポーリングできます。

ListOperations

ListOperations
`rpc ListOperations(ListOperationsRequest) returns (ListOperationsResponse)` リクエストで指定したフィルタに一致するオペレーションを一覧表示します。このメソッドがサーバーでサポートされていない場合は、`UNIMPLEMENTED` を返します。注: `name` バインディングを使用すると、`users//operations` などの異なるリソース名スキームを使用するために、API サービスがバインディングをオーバーライドできます。バインディングをオーバーライドするときに、API サービスは `"/v1/{name=users/}/operations"` のようなバインディングをサービス構成に追加する場合があります。下位互換性を維持するため、デフォルトの名前にはオペレーションのコレクション ID が含まれています。ただし、オーバーライドを行うユーザーは、名前のバインディングが親リソースであり、オペレーションコレクション ID がないことを確認する必要があります。

rpc ListOperations(ListOperationsRequest) returns (ListOperationsResponse)

リクエストで指定したフィルタに一致するオペレーションを一覧表示します。このメソッドがサーバーでサポートされていない場合は、UNIMPLEMENTED を返します。

注: name バインディングを使用すると、users/*/operations などの異なるリソース名スキームを使用するために、API サービスがバインディングをオーバーライドできます。バインディングをオーバーライドするときに、API サービスは "/v1/{name=users/*}/operations" のようなバインディングをサービス構成に追加する場合があります。下位互換性を維持するため、デフォルトの名前にはオペレーションのコレクション ID が含まれています。ただし、オーバーライドを行うユーザーは、名前のバインディングが親リソースであり、オペレーションコレクション ID がないことを確認する必要があります。

GetOperationRequest

Operations.GetOperation に対するリクエストメッセージ。

フィールド

フィールド
`name`	`string` オペレーションリソースの名前。

name

string

オペレーションリソースの名前。

ListOperationsRequest

Operations.ListOperations に対するリクエストメッセージ。

フィールド
`name`	`string` オペレーションの親リソースの名前。
`filter`	`string` 標準リストフィルタ。
`page_size`	`int32` 標準的なリストのページサイズ。
`page_token`	`string` 標準的なリストのページトークン。

ListOperationsResponse

Operations.ListOperations に対するレスポンスメッセージ。

フィールド

フィールド
`operations[]`	`Operation` リクエストで指定されたフィルタに一致するオペレーションのリスト。
`next_page_token`	`string` 標準的なリストの次ページのトークン。

operations[]

Operation

リクエストで指定されたフィルタに一致するオペレーションのリスト。

next_page_token

string

標準的なリストの次ページのトークン。

オペレーション

このリソースは、ネットワーク API 呼び出しの結果の長時間実行オペレーションを示します。

フィールド
`name`	`string` サーバーによって割り当てられる名前。最初にその名前を返すサービスと同じサービス内でのみ一意になります。デフォルトの HTTP マッピングを使用している場合は、`name` を `operations/{unique_id}` で終わるリソース名にします。
`metadata`	`Any (https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Any)` オペレーションに関連付けられているサービス固有のメタデータ。通常は進捗情報や、作成日時などの共通メタデータが含まれます。一部のサービスでは、このようなメタデータが提供されないこともあります。メタデータがある場合、長時間実行オペレーションを返すメソッドでは、メタデータの型をドキュメント化しておく必要があります。
`done`	`bool` 値が `false` の場合は、オペレーションが進行中であることを意味します。`true` の場合、オペレーションは完了しており、`error` または `response` が利用可能です。
共用体フィールド `result`。オペレーションの結果。`error` または有効な `response` になります。`done` == `false` の場合、`error` も `response` も設定されません。`done` == `true` の場合、`error` または `response` のどちらか一方のみが設定されます。一部のサービスでは結果が返されない場合があります。`result` は次のいずれかになります。
`error`	`Status (/distributed-cloud/hosted/docs/latest/gdch/apis/vertex-ai/translation/rpc/google.rpc#google.rpc.Status)` 失敗またはキャンセルされた場合のオペレーションのエラー結果。
`response`	`Any (https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Any)` 成功した場合はオペレーションの通常のレスポンス。元のメソッドで成功時にデータが返されない場合（`Delete` など）、レスポンスは `google.protobuf.Empty` になります。元のメソッドが標準の `Get`/`Create`/`Update` である場合、レスポンスはリソースになります。他のメソッドについては、レスポンスの型が `XxxResponse`（`Xxx` は元のメソッド名）になります。たとえば、元のメソッド名が `TakeSnapshot()` であれば、レスポンスの型は `TakeSnapshotResponse` になると推測できます。