Package google.longrunning

索引

运维

使用 API 服务管理长时间运行的操作。

如果某个 API 方法通常需要很长时间才能完成，您可以将其设计为向客户端返回 Operation，而客户端可以使用此接口通过轮询操作资源来异步接收实际响应，或者将操作资源传递给另一个 API（如 Google Cloud Pub/Sub API）来接收响应。任何返回长时间运行操作的 API 服务都应实现 Operations 接口，以便为开发者提供一致的客户端体验。

GetOperation

rpc GetOperation(GetOperationRequest) returns (Operation)

获取长时间运行的操作的最新状态。客户端可以使用此方法，按 API 服务建议的时间间隔来轮询操作结果。

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

如需了解详情，请参阅身份验证概览。

GetOperationRequest

Operations.GetOperation 的请求消息。

字段
name

string

操作资源的名称。

操作

此资源表示由网络 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。