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):2023-12-01。
[null,null,["最后更新时间 (UTC):2023-12-01。"],[[["The `Operation` resource represents a long-running operation initiated by a network API call."],["Each operation has a unique name, metadata (often with progress information), and a status indicating if it's done."],["Upon completion (`done` is `true`), an operation provides either an `error` or a `response` indicating the outcome."],["The `response` field contains the operation's result, which varies depending on the original API method called."]]],["A long-running network API call is represented by an \"Operation\" resource. This resource includes a unique `name`, service-specific `metadata` about progress, and a `done` status flag. Upon completion (`done` is true), the `result` field will contain either an `error` status or a successful `response`. If the operation is in progress (`done` is false) `result` will not be set. The `response` contains data if it was a successful operation.\n"]]