指数
Operations
(界面)-
CancelOperationRequest
(消息) -
DeleteOperationRequest
(消息) -
GetOperationRequest
(消息) -
ListOperationsRequest
(消息) -
ListOperationsResponse
(消息) -
Operation
(消息) -
WaitOperationRequest
(消息)
运营
使用 API 服务管理长时间运行的操作。
当一个API方法通常需要很长时间才能完成时,可以设计将Operation
返回给客户端,客户端可以使用该接口通过轮询操作资源来异步接收真正的响应,或者将操作资源传递给另一个API(例如 Pub/Sub API)来接收响应。任何返回长时间运行操作的 API 服务都应实现Operations
接口,以便开发人员可以获得一致的客户端体验。
取消操作 |
---|
开始对长时间运行的操作进行异步取消。服务器会尽最大努力取消该操作,但不保证成功。如果服务器不支持此方法,则会返回
|
删除操作 |
---|
删除长时间运行的操作。该方法表示客户端不再对操作结果感兴趣。它不会取消操作。如果服务器不支持此方法,则会返回
|
获取操作 |
---|
获取长时间运行的操作的最新状态。客户端可以使用此方法按照API服务建议的时间间隔轮询操作结果。
|
列表操作 |
---|
列出与请求中指定过滤器匹配的操作。如果服务器不支持此方法,它将返回
|
等待操作 |
---|
等待指定的长时间运行的操作完成或最多达到指定的超时,然后返回最新状态。如果操作已经完成,则立即返回最新状态。如果指定的超时大于默认的 HTTP/RPC 超时,则使用 HTTP/RPC 超时。如果服务器不支持此方法,则会返回
|
取消操作请求
领域 | |
---|---|
name | 要取消的操作资源的名称。 |
删除操作请求
领域 | |
---|---|
name | 待删除的操作资源名称。 |
获取操作请求
Operations.GetOperation
的请求消息。
领域 | |
---|---|
name | 操作资源的名称。 |
列出操作请求
领域 | |
---|---|
name | 操作的父资源的名称。 |
filter | 标准列表过滤器。 |
page_size | 标准列表页面大小。 |
page_token | 标准列表页面令牌。 |
列表操作响应
领域 | |
---|---|
operations[] | 与请求中指定过滤器匹配的操作列表。 |
next_page_token | 标准列表下一页标记。 |
手术
此资源表示长时间运行的操作,该操作是网络 API 调用的结果。
领域 | |
---|---|
name | 服务器分配的名称,仅在最初返回它的同一服务中是唯一的。如果您使用默认的 HTTP 映射,则该 |
metadata | 与操作关联的特定于服务的元数据。它通常包含进度信息和通用元数据,例如创建时间。某些服务可能不提供此类元数据。任何返回长时间运行操作的方法都应记录元数据类型(如果有)。 |
done | 如果值为 |
联盟场result 。操作结果,可以是error ,也可以是有效response 。如果done == false ,则不会设置error 或response 。如果done == true ,则可以设置error 或response 之一。某些服务可能无法提供结果。 result 只能是以下之一: | |
error | 失败或取消时操作的错误结果。 |
response | 操作正常、成功的响应。如果原始方法未返回成功数据(例如 |
等待操作请求
Operations.WaitOperation
的请求消息。
领域 | |
---|---|
name | 要等待的操作资源的名称。 |
timeout | 超时之前等待的最长时间。如果留空,则等待时间最多为底层 HTTP/RPC 协议允许的时间。如果还指定了 RPC 上下文截止时间,则将使用较短的截止时间。 |