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 |
Kolom | |
---|---|
name |
Nama yang ditetapkan server, yang hanya unik dalam layanan yang sama yang awalnya menampilkannya. Jika Anda menggunakan pemetaan HTTP default, |
metadata |
Kolom ini akan berisi objek Objek yang berisi kolom dengan jenis arbitrer. Kolom tambahan |
done |
Jika nilainya |
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 , maka hanya satu dari error atau response yang dapat ditetapkan. Beberapa layanan mungkin tidak memberikan hasil. result hanya dapat berupa salah satu dari berikut: |
|
error |
Kolom ini tidak akan selalu ditetapkan jika operasi dibuat oleh |
response |
Kolom ini akan berisi objek Objek yang berisi kolom dengan jenis arbitrer. Kolom tambahan |
Status
Jenis Status
menentukan model error logis yang cocok untuk lingkungan pemrograman yang berbeda, termasuk REST API dan RPC API. 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 menggunakannya dalam Panduan Desain API.
Representasi JSON |
---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
Kolom | |
---|---|
code |
Kode status, yang harus berupa nilai enum |
message |
Pesan error yang ditampilkan ke developer dan seharusnya dalam bahasa Inggris. Setiap pesan error yang ditampilkan kepada pengguna harus dilokalkan dan dikirim di kolom |
details[] |
Daftar pesan yang membawa detail error. Ada sekumpulan jenis pesan umum yang dapat digunakan oleh API. Objek yang berisi kolom dengan jenis arbitrer. Kolom tambahan |
Metode |
|
---|---|
|
Mendapatkan status terbaru dari operasi yang berjalan lama. |