Operation
使用集合让一切井井有条
根据您的偏好保存内容并对其进行分类。
此资源表示一项由网络 API 调用引发的长时间运行的操作。
JSON 表示法 |
{
"name": string,
"metadata": {
"@type": string,
field1: ...,
...
},
"done": boolean,
// Union field result can be only one of the following:
"error": {
object (Status )
},
"response": {
"@type": string,
field1: ...,
...
}
// End of list of possible types for union field result .
} |
字段 |
name |
string
由服务器分配的名称,该名称仅在最初返回它的那项服务中是唯一的。如果您使用默认 HTTP 映射,则 name 应是以 operations/{unique_id} 结尾的资源名称。
|
metadata |
object
与操作关联的服务专属元数据。它通常包含进度信息和常见元数据(如创建时间)。一些服务可能不会提供此类元数据。任何返回长时间运行操作的方法都应记录元数据类型(如果有的话)。 此对象可以包含任意类型的字段。附加字段 "@type" 包含用于标示相应类型的 URI。示例:{ "id": 1234, "@type": "types.example.com/standard/id" } 。
|
done |
boolean
如果值为 false ,则表示操作仍在进行中。如果为 true ,则表示操作已完成,其结果不是 error 就是 response 。
|
联合字段 result 。操作结果,可以是 error ,也可以是有效的 response 。如果 done == false ,则既不会设置 error ,也不会设置 response 。如果 done == true ,则可以仅设置 error 或 response 中的一个。部分服务可能不会提供结果。result 只能是下列其中一项: |
error |
object (Status )
操作失败或被取消时表示有错误发生的结果。
|
response |
object
操作的常规成功响应。如果原始方法在成功时不返回任何数据(如 Delete ),则响应为 google.protobuf.Empty 。如果原始方法为标准 Get /Create /Update 方法,则响应应该为资源。对于其他方法,响应类型应为 XxxResponse ,其中 Xxx 是原始方法的名称。例如,如果原始方法名称为 TakeSnapshot() ,则推断的响应类型为 TakeSnapshotResponse 。 此对象可以包含任意类型的字段。附加字段 "@type" 包含用于标示相应类型的 URI。示例:{ "id": 1234, "@type": "types.example.com/standard/id" } 。
|
如未另行说明,那么本页面中的内容已根据知识共享署名 4.0 许可获得了许可,并且代码示例已根据 Apache 2.0 许可获得了许可。有关详情,请参阅 Google 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC):2025-07-25。
[null,null,["最后更新时间 (UTC):2025-07-25。"],[[["\u003cp\u003eThis resource describes the JSON representation of a long-running operation initiated by a network API call.\u003c/p\u003e\n"],["\u003cp\u003eThe representation includes fields for operation name (\u003ccode\u003ename\u003c/code\u003e), metadata (\u003ccode\u003emetadata\u003c/code\u003e), completion status (\u003ccode\u003edone\u003c/code\u003e), and result (\u003ccode\u003eresult\u003c/code\u003e).\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eresult\u003c/code\u003e field provides either an error (\u003ccode\u003eerror\u003c/code\u003e) or a response (\u003ccode\u003eresponse\u003c/code\u003e) based on the operation outcome.\u003c/p\u003e\n"],["\u003cp\u003eWhile the operation is in progress, \u003ccode\u003edone\u003c/code\u003e is \u003ccode\u003efalse\u003c/code\u003e and neither \u003ccode\u003eerror\u003c/code\u003e nor \u003ccode\u003eresponse\u003c/code\u003e are set; upon completion, \u003ccode\u003edone\u003c/code\u003e becomes \u003ccode\u003etrue\u003c/code\u003e and either \u003ccode\u003eerror\u003c/code\u003e or \u003ccode\u003eresponse\u003c/code\u003e is populated.\u003c/p\u003e\n"]]],["This content defines the structure of a long-running operation's JSON representation. It includes fields for `name` (server-assigned identifier), `metadata` (service-specific data), and `done` (operation status). If `done` is true, the `result` field will contain either an `error` object (for failed operations) or a `response` object (for successful ones). `result` field can only contain one of them. Otherwise, it contains neither of them.\n"],null,["# Operation\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n\nThis resource represents a long-running operation that is the result of a network API call.\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"metadata\": { \"@type\": string, field1: ..., ... }, \"done\": boolean, // Union field `result` can be only one of the following: \"error\": { object (/streetview/publish/reference/rest/v1/Status) }, \"response\": { \"@type\": string, field1: ..., ... } // End of list of possible types for union field `result`. } ``` |\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` | `object` 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. An object containing fields of an arbitrary type. An additional field `\"@type\"` contains a URI identifying the type. Example: `{ \"id\": 1234, \"@type\": \"types.example.com/standard/id\" }`. |\n| `done` | `boolean` 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` may be set. Some services might not provide the result. `result` can be only one of the following: ||\n| `error` | `object (`[Status](/streetview/publish/reference/rest/v1/Status)`)` The error result of the operation in case of failure or cancellation. |\n| `response` | `object` The normal, successful response of the operation. 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`. An object containing fields of an arbitrary type. An additional field `\"@type\"` contains a URI identifying the type. Example: `{ \"id\": 1234, \"@type\": \"types.example.com/standard/id\" }`. |"]]