Operation
Sử dụng bộ sưu tập để sắp xếp ngăn nắp các trang
Lưu và phân loại nội dung dựa trên lựa chọn ưu tiên của bạn.
Tài nguyên này biểu thị một hoạt động chạy trong thời gian dài là kết quả của lệnh gọi API mạng.
Biểu diễn dưới dạng 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 .
} |
Trường |
name |
string
Tên do máy chủ chỉ định. Tên này chỉ là duy nhất trong cùng một dịch vụ ban đầu trả về tên đó. Nếu bạn sử dụng mục ánh xạ HTTP mặc định, name phải là tên tài nguyên kết thúc bằng operations/{unique_id} .
|
metadata |
object
Siêu dữ liệu dành riêng cho dịch vụ được liên kết với thao tác. Tệp này thường chứa thông tin về tiến trình và siêu dữ liệu phổ biến như thời gian tạo. Một số dịch vụ có thể không cung cấp siêu dữ liệu như vậy. Mọi phương thức trả về một tác vụ chạy trong thời gian dài đều phải ghi nhận loại siêu dữ liệu, nếu có. Một đối tượng có chứa các trường thuộc loại tuỳ ý. Trường bổ sung "@type" chứa URI xác định kiểu. Ví dụ: { "id": 1234, "@type": "types.example.com/standard/id" } .
|
done |
boolean
Nếu giá trị là false , điều đó có nghĩa là thao tác vẫn đang diễn ra. Nếu là true , thao tác này sẽ hoàn tất và có thể dùng được error hoặc response .
|
Trường kết hợp result . Kết quả của thao tác, có thể là error hoặc response hợp lệ. Nếu done == false , thì cả error và response đều không được đặt. Nếu done == true , bạn có thể đặt chính xác một trong hai giá trị error hoặc response . Một số dịch vụ có thể không cung cấp kết quả. result chỉ có thể là một trong những trạng thái sau đây: |
error |
object (Status )
Kết quả lỗi của thao tác trong trường hợp không thành công hoặc huỷ.
|
response |
object
Phản hồi thành công, bình thường của hoạt động. Nếu phương thức ban đầu không trả về dữ liệu nào khi thành công, chẳng hạn như Delete , thì phản hồi sẽ là google.protobuf.Empty . Nếu phương thức gốc là phương thức chuẩn Get /Create /Update , thì phản hồi phải là tài nguyên. Đối với các phương thức khác, phản hồi phải có kiểu XxxResponse , trong đó Xxx là tên phương thức ban đầu. Ví dụ: nếu tên phương thức ban đầu là TakeSnapshot() , thì loại phản hồi được dự đoán sẽ là TakeSnapshotResponse . Một đối tượng có chứa các trường thuộc loại tuỳ ý. Trường bổ sung "@type" chứa URI xác định kiểu. Ví dụ: { "id": 1234, "@type": "types.example.com/standard/id" } .
|
Trừ phi có lưu ý khác, nội dung của trang này được cấp phép theo Giấy phép ghi nhận tác giả 4.0 của Creative Commons và các mẫu mã lập trình được cấp phép theo Giấy phép Apache 2.0. Để biết thông tin chi tiết, vui lòng tham khảo Chính sách trang web của Google Developers. Java là nhãn hiệu đã đăng ký của Oracle và/hoặc các đơn vị liên kết với Oracle.
Cập nhật lần gần đây nhất: 2025-07-25 UTC.
[null,null,["Cập nhật lần gần đây nhất: 2025-07-25 UTC."],[[["\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\" }`. |"]]