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

Package google.longrunning

インデックス

Operations（インターフェース）
CancelOperationRequest（メッセージ）
GetOperationRequest（メッセージ）
ListOperationsRequest（メッセージ）
ListOperationsResponse（メッセージ）
Operation（メッセージ）

運用

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

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

CancelOperation

CancelOperation
`rpc CancelOperation(CancelOperationRequest) returns (Empty)` 長時間実行オペレーションの非同期キャンセルを開始します。サーバーは操作のキャンセルに全力を尽くしますが、成功は保証されません。このメソッドがサーバーでサポートされていない場合は、`google.rpc.Code.UNIMPLEMENTED` を返します。クライアントは `Operations.GetOperation` などのメソッドを使用して、キャンセルが成功したか、あるいはキャンセルしたにもかかわらずオペレーションが完了したかを確認できます。キャンセルが成功するとそのオペレーションは削除されず、`google.rpc.Status.code` が `1` の `Operation.error` 値を持つオペレーションになります。これは `Code.CANCELLED` に相当します。認可スコープ次の OAuth スコープのいずれかが必要です。 `https://www.googleapis.com/auth/cloud-platform` `https://www.googleapis.com/auth/discoveryengine.readwrite` 詳細については、Authentication Overview をご覧ください。

rpc CancelOperation(CancelOperationRequest) returns (Empty)

長時間実行オペレーションの非同期キャンセルを開始します。サーバーは操作のキャンセルに全力を尽くしますが、成功は保証されません。このメソッドがサーバーでサポートされていない場合は、google.rpc.Code.UNIMPLEMENTED を返します。クライアントは Operations.GetOperation などのメソッドを使用して、キャンセルが成功したか、あるいはキャンセルしたにもかかわらずオペレーションが完了したかを確認できます。キャンセルが成功するとそのオペレーションは削除されず、google.rpc.Status.code が 1 の Operation.error 値を持つオペレーションになります。これは Code.CANCELLED に相当します。

認可スコープ

次の OAuth スコープのいずれかが必要です。

https://www.googleapis.com/auth/cloud-platform
https://www.googleapis.com/auth/discoveryengine.readwrite

詳細については、Authentication Overview をご覧ください。

GetOperation

GetOperation
`rpc GetOperation(GetOperationRequest) returns (Operation)` 長時間実行オペレーションの最新状態を取得します。クライアントはこのメソッドを使用して、API サービスで推奨される間隔でオペレーションの結果をポーリングできます。認可スコープ次の OAuth スコープのいずれかが必要です。 `https://www.googleapis.com/auth/cloud-platform` `https://www.googleapis.com/auth/discoveryengine.readwrite` 詳細については、Authentication Overview をご覧ください。 IAM 権限 `name` リソースに対する次の IAM 権限が必要です。 `discoveryengine.operations.get` 詳細については、IAM のドキュメントをご覧ください。

rpc GetOperation(GetOperationRequest) returns (Operation)

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

認可スコープ

次の OAuth スコープのいずれかが必要です。

https://www.googleapis.com/auth/cloud-platform
https://www.googleapis.com/auth/discoveryengine.readwrite

詳細については、Authentication Overview をご覧ください。

IAM 権限

name リソースに対する次の IAM 権限が必要です。

discoveryengine.operations.get

詳細については、IAM のドキュメントをご覧ください。

ListOperations

ListOperations
`rpc ListOperations(ListOperationsRequest) returns (ListOperationsResponse)` 指定したフィルタに一致するオペレーションをリクエストで一覧表示します。このメソッドがサーバーでサポートされていない場合は、`UNIMPLEMENTED` を返します。認可スコープ次の OAuth スコープのいずれかが必要です。 `https://www.googleapis.com/auth/cloud-platform` `https://www.googleapis.com/auth/discoveryengine.readwrite` 詳細については、Authentication Overview をご覧ください。 IAM 権限 `name` リソースに対する次の IAM 権限が必要です。 `discoveryengine.operations.list` 詳細については、IAM のドキュメントをご覧ください。

rpc ListOperations(ListOperationsRequest) returns (ListOperationsResponse)

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

認可スコープ

次の OAuth スコープのいずれかが必要です。

https://www.googleapis.com/auth/cloud-platform
https://www.googleapis.com/auth/discoveryengine.readwrite

詳細については、Authentication Overview をご覧ください。

IAM 権限

name リソースに対する次の IAM 権限が必要です。

discoveryengine.operations.list

詳細については、IAM のドキュメントをご覧ください。

CancelOperationRequest

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

フィールド

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

name

string

キャンセルするオペレーションリソースの名前。

GetOperationRequest

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

フィールド

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

name

string

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

ListOperationsRequest

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

フィールド
`name`	`string` オペレーションの親リソースの名前。
`filter`	`string` 標準リストフィルタ。
`page_size`	`int32` 標準的なリストのページサイズ。
`page_token`	`string` 標準的なリストのページトークン。
`return_partial_success`	`bool` `true` に設定すると、到達可能なオペレーションは通常どおり返され、到達できないオペレーションは [ListOperationsResponse.unreachable] フィールドで返されます。これは、コレクション間で読み取る場合（`parent` が `"projects/example/locations/-"` に設定されている場合など）にのみ `true` にできます。このフィールドはデフォルトではサポートされていません。サービスまたはプロダクト固有のドキュメントで明示的に記載されていない限り、設定すると `UNIMPLEMENTED` エラーが発生します。

ListOperationsResponse

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

フィールド

フィールド
`operations[]`	`Operation` リクエストで指定されたフィルタに一致するオペレーションのリスト。
`next_page_token`	`string` 標準的なリストの次ページのトークン。
`unreachable[]`	`string` 順序なしリスト。到達できないリソース。リクエストで `ListOperationsRequest.return_partial_success` が設定され、複数のコレクションにまたがって読み取る場合に設定されます（サポートされているすべてのロケーションのすべてのリソースを一覧表示しようとした場合など）。

operations[]

Operation

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

next_page_token

string

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

unreachable[]

string

順序なしリスト。到達できないリソース。リクエストで ListOperationsRequest.return_partial_success が設定され、複数のコレクションにまたがって読み取る場合に設定されます（サポートされているすべてのロケーションのすべてのリソースを一覧表示しようとした場合など）。

オペレーション

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

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