Operation

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 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.
}
Các trường
name

string

Tên máy chủ chỉ có trong một dịch vụ ban đầu trả về tên này. Nếu bạn sử dụng á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ụ liên quan đến thao tác. Trang 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. Bất kỳ phương thức nào trả về hoạt động lâu 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 loại tùy ý. Trường bổ sung "@type" có 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, nghĩa là bạn vẫn đang thực hiện thao tác này. Nếu true, thao tác đã hoàn tất và có thể sử dụng error hoặc response.

Trường nhóm result. Kết quả hoạt động, có thể là error hoặc response hợp lệ. Nếu done == false, thì cả errorresponse đều không được đặt. Nếu done == true, bạn có thể đặt chính xác một trong số 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 loạ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 bị huỷ.

response

object

Phản hồi thông 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 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à 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ó loại XxxResponse, trong đó Xxx là tên phương thức gốc. Ví dụ: nếu tên phương thức ban đầu là TakeSnapshot(), thì loại phản hồi được suy luận là TakeSnapshotResponse.

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