Sumber daya: Operasi
Sumber daya ini mewakili operasi yang berjalan lama yang merupakan hasil dari panggilan API jaringan.
Bidang response
operasi akan menjadi UploadReleaseResponse .
Representasi JSON |
---|
{ "name": string, "metadata": { "@type": string, field1: ..., ... }, "done": boolean, // Union field |
bidang | |
---|---|
name | Nama yang ditetapkan server, yang hanya unik dalam layanan yang sama yang mengembalikannya. 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. Metode apa pun yang mengembalikan operasi yang berjalan lama harus mendokumentasikan jenis metadata, jika ada. Objek yang berisi bidang dengan tipe arbitrer. Bidang tambahan |
done | Jika nilainya |
result lapangan serikat. Hasil operasi, yang dapat berupa error atau response yang valid. Jika done == false , baik error maupun response tidak disetel. Jika done == true , salah satu error atau response dapat ditetapkan. Beberapa layanan mungkin tidak memberikan hasil. result hanya dapat berupa salah satu dari berikut ini: | |
error | Hasil kesalahan operasi jika terjadi kegagalan atau pembatalan. |
response | Respon normal operasi jika berhasil. Dalam hal ini akan menjadi UploadReleaseResponse . |
Status
Tipe Status
mendefinisikan model kesalahan logis yang cocok untuk berbagai lingkungan pemrograman, termasuk REST API dan RPC API. Ini digunakan oleh gRPC . Setiap pesan Status
berisi tiga bagian data: kode kesalahan, pesan kesalahan, dan rincian kesalahan.
Anda dapat mengetahui lebih lanjut tentang model kesalahan ini dan cara mengatasinya di Panduan Desain API .
Representasi JSON |
---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
bidang | |
---|---|
code | Kode status, yang seharusnya merupakan nilai enum dari |
message | Pesan kesalahan yang ditujukan kepada pengembang, yang seharusnya dalam bahasa Inggris. Pesan kesalahan apa pun yang dilihat pengguna harus dilokalkan dan dikirim di bidang |
details[] | Daftar pesan yang berisi rincian kesalahan. Ada serangkaian jenis pesan umum yang dapat digunakan oleh API. Objek yang berisi bidang dengan tipe arbitrer. Bidang tambahan |
Metode | |
---|---|
| Mendapatkan status terbaru dari operasi yang berjalan lama. |