REST Resource: operations

Resource: Operasi

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

Objek QueryMetadata berisi data khusus layanan yang terkait dengan operasi.

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

boolean

Jika nilainya false, artinya operasi masih berlangsung. Jika true, operasi selesai dan error atau response akan tersedia.
Kolom union result. Hasil operasi, yang dapat berupa error atau response yang valid. Jika done == false, error atau response tidak akan ditetapkan. Jika done == true, tepat satu dari error atau response 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

Objek QueryResponse, yang ditampilkan jika operasi kueri berhasil.

Objek yang berisi kolom jenis 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 lingkungan pemrograman yang berbeda, termasuk REST API dan RPC API. Ini digunakan oleh gRPC. Setiap pesan Status berisi tiga bagian data: kode error, pesan error, dan detail error.

Anda dapat mengetahui selengkapnya tentang model error ini dan cara mengatasinya di Panduan Desain API.

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

integer

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

string

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

object

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

Objek yang berisi kolom jenis 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

 Mendapatkan status terbaru dari operasi yang berjalan lama.

list

 Mencantumkan operasi yang cocok dengan filter yang ditentukan dalam permintaan.

wait

 Menunggu hingga operasi berjalan lama yang ditentukan selesai atau mencapai waktu tunggu maksimum yang ditentukan, menampilkan status terbaru.