资源:Operation
此资源表示由网络 API 调用引发的长时间运行的操作。
JSON 表示法 |
---|
{ "name": string, "metadata": { "@type": string, field1: ..., ... }, "done": boolean, // Union field |
字段 | |
---|---|
name |
由服务器分配的名称,该名称仅在最初返回它的那项服务中是唯一的。如果您使用默认 HTTP 映射,则 |
metadata |
与操作关联的服务专属元数据。它通常包含进度信息和常见元数据(如创建时间)。一些服务可能不会提供此类元数据。任何返回长时间运行的操作的方法都应记录元数据类型(如果有的话)。 此对象可以包含任意类型的字段。附加字段 |
done |
如果值为 |
联合字段 result 。操作结果,可以是 error ,也可以是有效的 response 。如果 done == false ,则既不会设置 error ,也不会设置 response 。如果 done == true ,则只能设置 error 或 response 中的一项。部分服务可能不会提供结果。result 只能是下列其中一项: |
|
error |
操作失败或被取消时表示有错误发生的结果。 |
response |
操作的常规成功响应。如果原始方法在成功时不返回任何数据(如 此对象可以包含任意类型的字段。附加字段 |
方法 |
|
---|---|
|
对长时间运行的操作启动异步取消。 |
|
删除长时间运行的操作。 |
|
获取长时间运行的操作的最新状态。 |
|
列出与请求中指定的过滤条件匹配的操作。 |