REST Resource: operations

Resource: Operation

Resource ini mewakili operasi yang berjalan lama yang merupakan hasil dari panggilan API jaringan.

Representasi 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.
}
Kolom
name

string

Nama server yang ditetapkan, yang hanya bersifat unik dalam layanan yang sama yang awalnya menampilkannya. Jika Anda menggunakan pemetaan HTTP default, name harus berupa nama resource yang diakhiri dengan operations/{unique_id}.
metadata

object

Metadata khusus layanan yang terkait dengan operasi. File ini biasanya berisi informasi progres dan metadata umum seperti waktu pembuatan. Beberapa layanan mungkin tidak menyediakan metadata tersebut. Setiap metode yang menampilkan operasi yang berjalan lama harus mendokumentasikan tipe metadata, jika ada.

Objek yang berisi kolom tipe arbitrer. Kolom tambahan "@type" berisi URI yang mengidentifikasi jenis. Contoh: { "id": 1234, "@type": "types.example.com/standard/id" }.
done

boolean

Jika nilainya adalah false, berarti operasi masih berlangsung. Jika true, operasi selesai, dan error atau response tersedia.
Kolom union result. Hasil operasi, yang dapat berupa error atau response yang valid. Jika done == false, error atau response tidak ditetapkan. Jika done == true, hanya salah satu dari error atau response yang dapat ditetapkan. Beberapa layanan mungkin tidak memberikan hasil. result hanya dapat berupa salah satu dari berikut:
error

object (Status)

Hasil error operasi jika terjadi kegagalan atau pembatalan.
response

object

Respons normal yang berhasil dari operasi. Jika metode asli tidak menampilkan data saat berhasil, seperti Delete, responsnya adalah google.protobuf.Empty. Jika metode asli adalah Get/Create/Update standar, responsnya harus berupa resource. Untuk metode lain, respons harus memiliki jenis XxxResponse, dengan Xxx yang merupakan nama metode asli. Misalnya, jika nama metode asli adalah TakeSnapshot(), jenis respons yang disimpulkan adalah TakeSnapshotResponse.

Objek yang berisi kolom tipe arbitrer. Kolom tambahan "@type" berisi URI yang mengidentifikasi jenis. Contoh: { "id": 1234, "@type": "types.example.com/standard/id" }.

Status

Jenis Status menentukan model error logis yang cocok untuk berbagai lingkungan pemrograman, meliputi REST API dan RPC API. Jenis error ini digunakan oleh gRPC. Setiap pesan Status berisi tiga bagian data: kode error, pesan error, dan detail error.

Anda dapat mencari tahu lebih lanjut tentang model error ini dan cara penanganannya di Panduan Desain API.

Representasi JSON 
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
Kolom
code

integer

Kode status, harus berupa nilai enum dari google.rpc.Code.
message

string

Pesan error yang ditampilkan ke developer dan seharusnya dalam bahasa Inggris. Setiap pesan error yang ditampilkan kepada pengguna harus dilokalkan dan dikirim di kolom google.rpc.Status.details, atau dilokalkan oleh klien.
details[]

object

Daftar pesan yang membawa detail error. Ada seperangkat jenis pesan umum untuk digunakan API.

Objek yang berisi kolom tipe arbitrer. Kolom tambahan "@type" berisi URI yang mengidentifikasi jenis. Contoh: { "id": 1234, "@type": "types.example.com/standard/id" }.

Metode

cancel

 Memulai pembatalan asinkron pada operasi yang berjalan lama.

delete

 Menghapus operasi yang berjalan lama.

get

 Mengambil status terbaru dari operasi yang berjalan lama.

list

 Menampilkan operasi yang sesuai dengan filter yang ditentukan dalam permintaan.