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 membuat waktu. Beberapa layanan mungkin tidak menyediakan metadata semacam itu. Setiap metode yang menampilkan operasi yang berjalan lama harus mendokumentasikan tipe metadata, jika ada. |
done |
Jika nilainya |
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 hasilnya. result hanya dapat berupa salah satu dari berikut: |
|
error |
Hasil error operasi jika terjadi kegagalan atau pembatalan. |
response |
Respons operasi normal dan berhasil. Jika metode asli tidak menampilkan data saat berhasil, seperti |
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. |