Operation

Tài nguyên này đại diện cho một hoạt động lâu dài là kết quả của lệnh gọi API mạng.

Đại 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, tên này chỉ duy nhất trong dịch vụ trả về nó ban đầu. Nếu bạn sử dụng mặc định HTTP lập bản đồ, các name nên có định dạng của operations/some/unique/name .

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 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. Bất kỳ phương thức nào trả về một hoạt động chạy dài 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 kiểu tùy ý. Một trường bổ sung "@type" chứa một URI xác định các loại. Ví dụ: { "id": 1234, "@type": "types.example.com/standard/id" } .

done

boolean

Nếu giá trị là false , nó có nghĩa là hoạt động vẫn được tiến hành. Nếu true , các hoạt động được hoàn tất, và một trong hai error hoặc response có sẵn.

Lĩnh vực Liên minh result . Kết quả hoạt động, đó có thể là một error hoặc một hợp lệ response . Nếu done == false , không phải error cũng không response được thiết lập. Nếu done == true , chính xác một trong những error hay response được thiết lập. result có thể chỉ là một trong những điều sau đây:
error

object( Status )

Kết quả lỗi của hoạt động trong trường hợp không thành công hoặc hủy bỏ.

response

object

Các 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 pháp ban đầu trả về không có dữ liệu về thành công, chẳng hạn như Delete , phản ứng là google.protobuf.Empty . Nếu phương pháp ban đầu là tiêu chuẩn Get / Create / Update , phản ứng nên là tài nguyên. Đối với các phương pháp khác, phản ứng nên có các loại XxxResponse , nơi Xxx là tên phương pháp ban đầu. Ví dụ, nếu tên phương pháp ban đầu là TakeSnapshot() , loại phản ứng suy ra là TakeSnapshotResponse .

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