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 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC):2025-07-25。
[null,null,["最后更新时间 (UTC):2025-07-25。"],[[["\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`. |"]]