Tài nguyên: Hoạt động
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 |
Trường | |
---|---|
name |
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, |
metadata |
Trường này sẽ chứa đối tượng Một đối tượng có chứa các trường thuộc loại tuỳ ý. Trường bổ sung |
done |
Nếu giá trị là |
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 |
Trường này sẽ luôn không được thiết lập nếu thao tác được tạo bởi |
response |
Trường này sẽ chứa đối tượng Một đối tượng có chứa các trường thuộc loại tuỳ ý. Trường bổ sung |
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. Hàm này được 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à thông tin chi tiết về lỗi.
Bạn có thể tìm hiểu thêm về mô hình lỗi này cũng như cách xử lý 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 |
Mã trạng thái, phải là một giá trị enum của |
message |
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 đều phải được bản địa hoá và gửi trong trường |
details[] |
Danh sách các thông báo chứa thông tin chi tiết về lỗi. Có một nhóm loại thông báo phổ biến để API sử dụng. Một đối tượng có chứa các trường thuộc loại tuỳ ý. Trường bổ sung |
Phương thức |
|
---|---|
|
Lấy trạng thái mới nhất của một hoạt động chạy trong thời gian dài. |