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 |
Kolom | |
---|---|
name |
Nama server yang ditetapkan, yang hanya bersifat unik dalam layanan yang sama yang awalnya menampilkannya. Jika Anda menggunakan pemetaan HTTP default, |
metadata |
Metadata khusus layanan yang terkait dengan operasi. Biasanya berisi informasi kemajuan 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 |
done |
Jika nilainya adalah |
Kolom union result . Hasil operasi, yang dapat berupa error atau response yang valid. Jika done == false , error atau response tidak 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 |
Hasil error operasi jika terjadi kegagalan atau pembatalan. |
response |
Respons operasi yang normal dan berhasil. Jika metode asli tidak menampilkan data saat berhasil, seperti Objek yang berisi kolom tipe arbitrer. Kolom tambahan |
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 |
Kode status, harus berupa nilai enum dari |
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 seperangkat jenis pesan umum untuk digunakan API. Objek yang berisi kolom tipe arbitrer. Kolom tambahan |
Metode |
|
---|---|
|
Memulai pembatalan asinkron pada operasi yang berjalan lama. |
|
Menghapus operasi yang berjalan lama. |
|
Mengambil status terbaru dari operasi yang berjalan lama. |
|
Menampilkan operasi yang sesuai dengan filter yang ditentukan dalam permintaan. |