REST Resource: projects.databases.operations

Tài nguyên: Hoạt động

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 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,

  // 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.
}
Trường
name

string

Tên do máy chủ chỉ định, 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, 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 thao tác. Tệp này thường chứa thông tin về tiến trình và siêu dữ liệu phổ biến, chẳng hạn như thời gian tạo. Một số dịch vụ có thể không cung cấp những siêu dữ liệu như vậy. Bất kỳ phương thức nào trả về một hoạt động 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ó.

Đối tượng chứa các trường thuộc kiểu tuỳ ý. Trường "@type" bổ sung 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, tức là hoạt động vẫn đang được thực hiện. Nếu là true, thì thao tác đã hoàn tất và error hoặc response có thể sử dụng được.

Trường 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ả errorresponse đều không được đặt. Nếu done == true, bạn có thể đặt chính xác một trong hai thuộc tính 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:
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 bình 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 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 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 có kiểu 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ì kiểu phản hồi dự đoán sẽ là TakeSnapshotResponse.

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

Phương thức

cancel

Bắt đầu quá trình huỷ không đồng bộ đối với một hoạt động diễn ra 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 hoạt động diễn ra trong thời gian dài.

list

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