REST Resource: 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 do 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 do máy chủ chỉ định (chỉ là duy nhất trong cùng một dịch vụ trả về tên này ban đầu). Nếu bạn sử dụng cách liên kết HTTP mặc định, thì name phải là tên tài nguyên kết thúc bằng operations/{unique_id}.
metadata

object

Trường này sẽ chứa một đối tượng DevicesLongRunningOperationMetadata nếu thao tác được tạo bởi claimAsync, unclaimAsync hoặc updateMetadataAsync.

Đối tượng chứa các trường thuộc một loại tùy ý. 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, điều đó có nghĩa là thao tác này vẫn đang được tiến hành. Nếu true thì hoạt động đã hoàn tất và bạn có thể thực hiện error hoặc response.
Trường liên kết result. Kết quả hoạt động, có thể là error hoặc response hợp lệ. Nếu done == false thì cả error và response đều chưa được đặt. Nếu done == true, bạn có thể đặt chính xác một trong 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)

Trường này sẽ luôn không được đặt nếu thao tác được tạo bởi claimAsync, unclaimAsync hoặc updateMetadataAsync. Trong trường hợp này, thông tin lỗi cho từng thiết bị được đặt trong response.perDeviceStatus.result.status.
response

object

Trường này sẽ chứa một đối tượng DevicesLongRunningOperationResponse nếu thao tác được tạo bởi claimAsync, unclaimAsync hoặc updateMetadataAsync.

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

Trạng thái

Loại Status xác định mô hình lỗi logic phù hợp với nhiều môi trường lập trình, bao gồm cả API REST và API RPC. gRPC sử dụng công cụ này. Mỗi thông báo Status chứa 3 phần dữ liệu: mã lỗi, thông báo lỗi và thông tin chi tiết về lỗi.

Bạn có thể tìm hiểu thêm về mô hình lỗi này và cách làm việc với mô hình đó trong Hướng dẫn thiết kế API.

Biểu diễn dưới dạng JSON 
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
Các trường
code

integer

Mã trạng thái phải là một giá trị enum của google.rpc.Code.
message

string

Thông báo lỗi nhà phát triển phải hiển thị bằng tiếng Anh. Mọi thông báo lỗi mà người dùng nhìn thấy phải được bản địa hoá và được gửi trong trường google.rpc.Status.details, hoặc phải được ứng dụng khách bản địa hoá.
details[]

object

Danh sách thông báo có thông tin chi tiết về lỗi. Có một tập hợp các loại thông báo phổ biến để API sử dụng.

Đối tượng chứa các trường thuộc một loại tùy ý. 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 pháp

get

 Xem trạng thái mới nhất của một thao tác chạy trong thời gian dài.