REST Resource: projects.operations

Tài nguyên: Operation

Tài nguyên này đại diện cho một thao tác 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,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "error": {
    object (Status)
  },
  "response": {
    "@type": string,
    field1: ...,
    ...
  }
  // End of mutually exclusive fields.
}
Trường
name

string

Tên do máy chủ chỉ định, chỉ mang tính duy nhất trong cùng một dịch vụ ban đầu trả về tên đó. 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 kết với thao tác. Thường thì siêu dữ liệu này chứa thông tin về tiến trình và siêu dữ liệu chung, chẳng hạn như thời gian tạo. Có thể một số dịch vụ sẽ không cung cấp siêu dữ liệu như vậy. Mọi phương thức có trả về một thao tác 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ó).

Một đối tượng chứa các trường thuộc một loại tuỳ ý. Một trường bổ sung "@type" chứa một 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à thao tác vẫn đang diễn ra. Nếu true, thao tác đã hoàn tất và có thể dùng error hoặc response.
Kết quả của thao tác, có thể là error hoặc response hợp lệ. Nếu done == false, thì error và response đều không được thiết lập. Nếu done == true, bạn chỉ có thể thiết lập một trong hai tham số error hoặc response. Có thể một số dịch vụ sẽ không cung cấp kết quả. Sau đây là danh sách các trường loại trừ lẫn nhau. Tối đa một trong các trường sẽ được đặt trong phản hồi:
error

object (Status)

Kết quả chỉ thao tác bị lỗi trong trường hợp không thành công hoặc huỷ.
response

object

Phản hồi bình thường, thao tác thành công. 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 tiêu 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 là 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ì suy ra loại phản hồi là TakeSnapshotResponse.

Một đối tượng chứa các trường thuộc một loại tuỳ ý. Một trường bổ sung "@type" chứa một URI xác định loại. Ví dụ: { "id": 1234, "@type": "types.example.com/standard/id" }.
Kết thúc các trường xung khắc.

Phương thức

cancel

 Bắt đầu huỷ không đồng bộ trên một thao tác chạy trong thời gian dài.

delete

 Xoá một thao tác diễn ra trong thời gian dài.

get

 Nhận trạng thái mới nhất của một thao tác diễn ra trong thời gian dài.

list

 Liệt kê các thao tác khớp với bộ lọc đã chỉ định trong yêu cầu.

wait

 Chờ cho đến khi thao tác diễn ra trong thời gian dài được chỉ định hoàn tất hoặc đạt đến thời gian chờ tối đa được chỉ định, trả về trạng thái mới nhất.