Package google.longrunning

Chỉ mục

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

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

Khi một phương thức API thường mất nhiều thời gian để hoàn tất, phương thức đó có thể được thiết kế để trả về Operation cho máy khách và máy khách 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 thao tác 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. Mọi dịch vụ API trả về các thao tác diễn ra trong thời gian dài đều phải triển khai giao diện Operations để nhà phát triển có thể có trải nghiệm nhất quán với ứng dụng.

CancelOperation

rpc CancelOperation(CancelOperationRequest) returns (Empty)

Bắt đầu huỷ không đồng bộ trên một thao tác chạy trong thời gian dài. Máy chủ sẽ cố gắng hết sức để huỷ thao tác, nhưng không đảm bảo thành công. Nếu máy chủ không hỗ trợ phương thức này, thì máy chủ sẽ trả về google.rpc.Code.UNIMPLEMENTED. Các ứng dụng có thể dùng Operations.GetOperation hoặc các phương thức khác để kiểm tra xem việc huỷ có thành công hay không hoặc liệu thao tác có hoàn tất hay không mặc dù đã huỷ. Khi huỷ thành công, thao tác sẽ không bị xoá; thay vào đó, thao tác sẽ trở thành một thao tác 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 kéo dài. Phương thức này cho biết rằng ứng dụng khách không còn quan tâm đến kết quả của thao tác nữa. Thao tác này không huỷ thao tác. Nếu máy chủ không hỗ trợ phương thức này, thì 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)

Lấy trạng thái mới nhất của một thao tác diễn ra trong thời gian dài. Ứng dụng có thể dùng phương thức này để thăm dò kết quả của thao tác theo khoảng thời gian mà dịch vụ API đề xuất.

Phạm vi uỷ quyền

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

  • https://www.googleapis.com/auth/cloud-platform
Quyền IAM

Yêu cầu quyền IAM sau đây trên tài nguyên name:

  • routeoptimization.operations.get

Để biết thêm thông tin, hãy xem tài liệu về IAM.
ListOperations

rpc ListOperations(ListOperationsRequest) returns (ListOperationsResponse)

Liệt kê các thao tác khớp với bộ lọc đã chỉ định trong yêu cầu. Nếu máy chủ không hỗ trợ phương thức này, thì 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 thao tác kéo 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. Nếu thao tác đã hoàn tất, 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 máy chủ không hỗ trợ phương thức này, thì máy chủ sẽ trả về google.rpc.Code.UNIMPLEMENTED. Xin lưu ý rằng phương thức này được thực hiện trên cơ sở nỗ lực tối đa. Phương thức 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), tức là ngay cả khi có phản hồi ngay lập tức, thì 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

Thông báo yêu cầu cho Operations.CancelOperation.

Trường
name

string

Tên của tài nguyên thao tác cần huỷ.

DeleteOperationRequest

Thông báo yêu cầu cho Operations.DeleteOperation.

Trường
name

string

Tên của tài nguyên thao tác cần xoá.

GetOperationRequest

Thông báo yêu cầu cho Operations.GetOperation.

Trường
name

string

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

ListOperationsRequest

Thông báo yêu cầu cho Operations.ListOperations.

Trường
name

string

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

string

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

int32

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

string

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

ListOperationsResponse

Thông báo 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 trang tiếp theo của Danh sách tiêu chuẩn.

Hoạt động

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.

Trường
name

string

Tên do máy chủ chỉ định, chỉ có 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

Any

Siêu dữ liệu dành riêng cho dịch vụ liên quan đến thao tác. Thường thì tệp 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. Một số dịch vụ có thể không cung cấp siêu dữ liệu như vậy. Mọi phương thứ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ó).
done

bool

Nếu giá trị là false, tức là thao tác vẫn đang diễn ra. Nếu true, thao tác sẽ hoàn tất và có thể dùng error hoặc response.
Trường nhóm result. 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 đặt. Nếu done == true, bạn chỉ có thể đặt một trong hai tham 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 trạng thái sau:
error

Status

Kết quả lỗi của thao tác trong trường hợp thất bại hoặc 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 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 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ì loại phản hồi được suy luận là TakeSnapshotResponse.

WaitOperationRequest

Thông báo yêu cầu cho Operations.WaitOperation.

Trường
name

string

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

Duration

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