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 đại diện cho một hoạt động diễn ra trong thời gian dài là kết quả của một 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, 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, chẳng hạn như thời gian tạo. Một số dịch vụ có thể không cung cấp những siêu dữ liệu như vậy. Bất kỳ phương thức nào trả về một hoạt động diễn ra trong thời gian dài đều phải ghi lại loại siêu dữ liệu, nếu có. Đối tượng chứa các trường thuộc kiểu tuỳ ý. Trường "@type" bổ sung chứa URI xác định loại. Ví dụ: { "id": 1234, "@type": "types.example.com/standard/id" } .
|
done |
boolean
Nếu giá trị là false , tức là hoạt động vẫn đang được thực hiện. Nếu là true , thì thao tác đã hoàn tất và error hoặc response có thể sử dụng được.
|
Trường 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 thuộc tính 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: |
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 bị huỷ.
|
response |
object
Phản hồi bình thường, thành công của thao tác. Nếu phương thức ban đầu không trả về dữ liệu 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 ban đầu là Get /Create /Update chuẩn, 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ì kiểu phản hồi dự đoán sẽ là TakeSnapshotResponse . Đối tượng chứa các trường thuộc kiểu tuỳ ý. Trường "@type" bổ sung chứa URI xác định loại. Ví dụ: { "id": 1234, "@type": "types.example.com/standard/id" } .
|
Trạng thái
Loại Status
xác định mô hình lỗi logic phù hợp với nhiều môi trường lập trình, bao gồm cả API REST và API RPC. gRPC sử dụng. Mỗi thông báo Status
chứa 3 phần dữ liệu: mã lỗi, thông báo lỗi và chi tiết lỗi.
Bạn có thể tìm hiểu thêm về mô hình lỗi này và cách xử lý lỗi trong Hướng dẫn thiết kế API.
Biểu diễn dưới dạng JSON |
{
"code": integer,
"message": string,
"details": [
{
"@type": string,
field1: ...,
...
}
]
} |
Trường |
code |
integer
Mã trạng thái phải là một giá trị enum của google.rpc.Code .
|
message |
string
Một thông báo lỗi dành cho nhà phát triển, phải bằng tiếng Anh. Mọi thông báo lỗi dành cho người dùng phải được bản địa hoá và gửi trong trường google.rpc.Status.details hoặc được ứng dụng bản địa hoá.
|
details[] |
object
Danh sách các thông báo cho biết thông tin chi tiết về lỗi. Có một nhóm các loại thông báo phổ biến để API sử dụng. Đối tượng chứa các trường thuộc kiểu tuỳ ý. Trường "@type" bổ sung chứa URI xác định loại. Ví dụ: { "id": 1234, "@type": "types.example.com/standard/id" } .
|
Trừ khi 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: 2024-05-02 UTC.
[{
"type": "thumb-down",
"id": "missingTheInformationINeed",
"label":"Thiếu thông tin tôi cần"
},{
"type": "thumb-down",
"id": "tooComplicatedTooManySteps",
"label":"Quá phức tạp/quá nhiều bước"
},{
"type": "thumb-down",
"id": "outOfDate",
"label":"Đã lỗi thời"
},{
"type": "thumb-down",
"id": "translationIssue",
"label":"Vấn đề về bản dịch"
},{
"type": "thumb-down",
"id": "samplesCodeIssue",
"label":"Vấn đề về mẫu/mã"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Khác"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Dễ hiểu"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Giúp tôi giải quyết được vấn đề"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Khác"
}]