REST Resource: operations

Nguồn: Hoạt động

Tài nguyên này thể hiện một hoạt động kéo dài là kết quả của lệnh gọi API mạng.

Biểu diễn 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.
}
Lĩnh vực
name

string

Tên do máy chủ gán, chỉ duy nhất trong cùng một dịch vụ trả về nó ban đầu. Nếu bạn sử dụng ánh xạ HTTP mặc định thì 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 hoạt động. Nó thường chứa thông tin tiến độ 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. Bất kỳ phương thức nào trả về một hoạt động chạy dài đều phải ghi lại loại siêu dữ liệu, nếu có.

Một đối tượng chứa các trường thuộc loại tùy ý. Trường bổ sung "@type" 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 , điều đó có nghĩa là thao tác vẫn đang được tiến hành. Nếu true , thao tác đã hoàn tất và có error hoặc response .

result trường liên minh . Kết quả hoạt động, có thể là error hoặc response hợp lệ. Nếu done == false , cả error lẫn response đều không được đặt. Nếu done == true , chính xác một error hoặc response có thể được đặt. 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 điều sau đây:
error

object ( Status )

Kết quả lỗi của thao tác trong trường hợp thất bại hoặc hủy bỏ.

response

object

Phản ứng bình thường của hoạt động trong trường hợp thành công. Nếu phương thức ban đầu không trả về dữ liệu thành công, chẳng hạn như Delete , thì phản hồi là google.protobuf.Empty . Nếu phương thức ban đầu là Get / Create / Update tiêu chuẩn thì phản hồi sẽ là tài nguyên. Đối với các phương thức khác, phản hồi phải có loại 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 suy ra là TakeSnapshotResponse .

Một đối tượng chứa các trường thuộc loại tùy ý. Trường bổ sung "@type" 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 các môi trường lập trình khác nhau, bao gồm API REST và API RPC. Nó được sử dụng bởi gRPC . Mỗi thông báo Status chứa ba 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ý nó trong Hướng dẫn thiết kế API .

Biểu diễn JSON
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
Lĩnh vực
code

integer

Mã trạng thái phải là giá trị enum của google.rpc.Code .

message

string

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 mà người dùng gặp phải phải được bản địa hóa và gửi trong trường google.rpc.Status.details hoặc được khách hàng bản địa hóa.

details[]

object

Danh sách các thông báo chứa chi tiết lỗi. Có một nhóm loại thông báo chung để API sử dụng.

Một đối tượng chứa các trường thuộc loại tùy ý. Trường bổ sung "@type" chứa URI xác định loại. Ví dụ: { "id": 1234, "@type": "types.example.com/standard/id" } .

phương pháp

get

 Nhận trạng thái mới nhất của một hoạt động kéo dài.