Package google.longrunning
コレクションでコンテンツを整理
必要に応じて、コンテンツの保存と分類を行います。
オペレーション
このリソースは、ネットワーク 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 のどちらか一方のみが設定されます。result は次のいずれかになります。 |
error |
Status
失敗またはキャンセルされた場合のオペレーションのエラー結果。
|
response |
Any
成功した場合はオペレーションの通常のレスポンス。元のメソッドで成功時にデータが返されない場合(Delete など)、レスポンスは google.protobuf.Empty になります。元のメソッドが標準の Get /Create /Update である場合、レスポンスはリソースになります。他のメソッドについては、レスポンスの型が XxxResponse (Xxx は元のメソッド名)になります。たとえば、元のメソッド名が TakeSnapshot() であれば、レスポンスの型は TakeSnapshotResponse になると推測できます。
|
特に記載のない限り、このページのコンテンツはクリエイティブ・コモンズの表示 4.0 ライセンスにより使用許諾されます。コードサンプルは Apache 2.0 ライセンスにより使用許諾されます。詳しくは、Google Developers サイトのポリシーをご覧ください。Java は Oracle および関連会社の登録商標です。
最終更新日 2025-07-25 UTC。
[null,null,["最終更新日 2025-07-25 UTC。"],[[["\u003cp\u003eThe \u003ccode\u003eOperation\u003c/code\u003e resource represents a long-running operation initiated by a network API call, containing details about its progress and outcome.\u003c/p\u003e\n"],["\u003cp\u003eOperations are identified by a unique \u003ccode\u003ename\u003c/code\u003e and can include service-specific \u003ccode\u003emetadata\u003c/code\u003e for progress tracking.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003edone\u003c/code\u003e field indicates operation completion status, with \u003ccode\u003eerror\u003c/code\u003e or \u003ccode\u003eresponse\u003c/code\u003e providing details upon completion.\u003c/p\u003e\n"],["\u003cp\u003eThe operation's outcome is represented by either an \u003ccode\u003eerror\u003c/code\u003e object for failures or a \u003ccode\u003eresponse\u003c/code\u003e object for successes, depending on the original method's expected return type.\u003c/p\u003e\n"]]],["The `Operation` message represents a long-running network API call. It includes a server-assigned `name` and `metadata` for progress and details. The `done` field indicates if the operation is complete. The `result` field, a union, contains either an `error` status or a successful `response`. If `done` is false, both `error` and `response` are unset. If `done` is true, only one of the two fields will have a value.\n"],null,["# Package google.longrunning\n\nIndex\n-----\n\n- [Operation](/spectrum-access-system/reference/rpc/google.longrunning#google.longrunning.Operation) (message)\n\nOperation\n---------\n\nThis resource represents a long-running operation that is the result of a network API call.\n\n| Fields ||\n|------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| `name` | `string` The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. |\n| `metadata` | [Any](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Any) Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. |\n| `done` | `bool` If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. |\n| Union field `result`. The operation result, which can be either an `error` or a valid `response`. If `done` == `false`, neither `error` nor `response` is set. If `done` == `true`, exactly one of `error` or `response` is set. `result` can be only one of the following: |||\n| `error` | [Status](/spectrum-access-system/reference/rpc/google.rpc#google.rpc.Status) The error result of the operation in case of failure or cancellation. |\n| `response` | [Any](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Any) The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. |"]]