Package google.longrunning

Chỉ mục

Hoạt động tính toán

Quản lý các hoạt động diễn ra trong thời gian dài bằng dịch vụ API.

Khi một phương thức API thường mất nhiều thời gian để hoàn thành, phương thức đó có thể được thiết kế để trả về Operation cho ứng dụng khách và ứng dụng có thể sử dụng giao diện này để nhận phản hồi thực một cách không đồng bộ bằng cách thăm dò tài nguyên hoạt động hoặc truyền tài nguyên thao tác đến một API khác (chẳng hạn như API Pub/Sub) để nhận phản hồi. Bất kỳ dịch vụ API nào trả về hoạt động lâu dài đều phải triển khai giao diện Operations để nhà phát triển có thể có trải nghiệm khách hàng nhất quán.

CancelOperation

rpc CancelOperation(CancelOperationRequest) returns (Empty)

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. Máy chủ sẽ cố gắng hết sức để huỷ thao tác, nhưng thành công không được đảm bảo. Nếu không hỗ trợ phương thức này, máy chủ sẽ trả về google.rpc.Code.UNIMPLEMENTED. Ứng dụng có thể sử dụng Operations.GetOperation hoặc các phương thức khác để kiểm tra xem thao tác huỷ có thành công hay không hoặc thao tác có hoàn tất mặc dù đã huỷ hay không. Khi huỷ thành công, toán tử sẽ không bị xoá; thay vào đó, nó trở thành một toán tử có giá trị Operation.error với google.rpc.Status.code là 1, tương ứng với Code.CANCELLED.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/cloud-platform
DeleteOperation

rpc DeleteOperation(DeleteOperationRequest) returns (Empty)

Xoá một thao tác diễn ra trong thời gian dài. Phương thức này cho biết máy khách không còn quan tâm đến kết quả hoạt động nữa. Thao tác này không huỷ thao tác. Nếu không hỗ trợ phương thức này, máy chủ sẽ trả về google.rpc.Code.UNIMPLEMENTED.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/cloud-platform
GetOperation

rpc GetOperation(GetOperationRequest) returns (Operation)

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. Ứng dụng có thể sử dụng phương thức này để thăm dò kết quả hoạt động theo khoảng thời gian theo đề xuất của dịch vụ API.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/cloud-platform
ListOperations

rpc ListOperations(ListOperationsRequest) returns (ListOperationsResponse)

Liệt kê những thao tác khớp với bộ lọc đã chỉ định trong yêu cầu. Nếu không hỗ trợ phương thức này, máy chủ sẽ trả về UNIMPLEMENTED.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/cloud-platform
WaitOperation

rpc WaitOperation(WaitOperationRequest) returns (Operation)

Chờ cho đến khi hoàn tất thao tác diễn ra trong thời gian dài đã chỉ định hoặc đạt đến tối đa thời gian chờ đã chỉ định, trả về trạng thái mới nhất. Nếu thao tác đã được thực hiện, trạng thái mới nhất sẽ được trả về ngay lập tức. Nếu thời gian chờ được chỉ định lớn hơn thời gian chờ HTTP/RPC mặc định, thì thời gian chờ HTTP/RPC sẽ được sử dụng. Nếu không hỗ trợ phương thức này, máy chủ sẽ trả về google.rpc.Code.UNIMPLEMENTED. Lưu ý rằng phương pháp này được áp dụng trên cơ sở nỗ lực tối đa. Hàm này có thể trả về trạng thái mới nhất trước thời gian chờ đã chỉ định (kể cả ngay lập tức), nghĩa là ngay cả phản hồi ngay lập tức cũng không đảm bảo rằng thao tác đã hoàn tất.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/cloud-platform

CancelOperationRequest

Tin nhắn yêu cầu cho Operations.CancelOperation.

Trường
name

string

Tên của tài nguyên thao tác sẽ bị huỷ.

DeleteOperationRequest

Tin nhắn yêu cầu cho Operations.DeleteOperation.

Trường
name

string

Tên của tài nguyên hoạt động cần xoá.

GetOperationRequest

Tin nhắn yêu cầu cho Operations.GetOperation.

Trường
name

string

Tên của tài nguyên hoạt động.

ListOperationsRequest

Tin nhắn yêu cầu cho Operations.ListOperations.

Trường
name

string

Tên tài nguyên mẹ của thao tác.
filter

string

Bộ lọc danh sách chuẩn.
page_size

int32

Kích thước trang danh sách chuẩn.
page_token

string

Mã thông báo trang danh sách chuẩn.

ListOperationsResponse

Tin nhắn phản hồi cho Operations.ListOperations.

Trường
operations[]

Operation

Danh sách các thao tác khớp với bộ lọc được chỉ định trong yêu cầu.
next_page_token

string

Mã thông báo tiêu chuẩn trên trang tiếp theo của Danh sách.

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.

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

Any

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ó.
done

bool

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ả error và response đề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

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

Any

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.

WaitOperationRequest

Tin nhắn yêu cầu cho Operations.WaitOperation.

Trường
name

string

Tên của tài nguyên thao tác để chờ.
timeout

Duration

Thời lượng tối đa để chờ trước khi hết thời gian chờ. Nếu để trống, thời gian chờ sẽ tối đa là thời gian được giao thức HTTP/RPC cơ bản cho phép. Nếu bạn cũng chỉ định thời hạn đối với bối cảnh RPC, thì thời hạn ngắn hơn sẽ được sử dụng.