Beberapa metode API Google Cloud memerlukan waktu yang cukup lama untuk diselesaikan.
Alih-alih memblokir hingga pekerjaan selesai, metode ini menampilkan resource Operation yang mewakili operasi yang sedang berlangsung sehingga aplikasi Anda dapat melakukan polling untuk status dan hasil akhirnya.
Library Klien Cloud untuk Rust menyediakan helper untuk menangani operasi yang berjalan lama (LRO) ini. Dokumen ini menunjukkan cara memulai LRO, melakukan polling secara otomatis hingga selesai, memeriksa update progres menengah, dan melakukan polling secara manual.
Sebelum memulai
Dokumen ini menggunakan Cloud Storage untuk membuat contoh kode tetap konkret, meskipun konsep yang sama berlaku untuk layanan Google Cloud apa pun yang menggunakan LRO.
Sebelum menjalankan kode dalam dokumen ini, selesaikan prasyarat berikut:
- Buat atau pilih projectGoogle Cloud dengan penagihan diaktifkan.
- Ikuti Memulai Rust untuk menyiapkan lingkungan pengembangan dan kredensial Anda.
- Buat bucket Cloud Storage dengan namespace hierarkis diaktifkan, dan buat folder sumber untuk diganti namanya.
- Beri akun utama Anda peran Identity and Access Management (IAM) dengan izin untuk
mengelola folder, seperti Storage Admin (
roles/storage.admin).
Dependensi
Tambahkan library klien dan crate LRO ke file Cargo.toml Anda:
cargo add google-cloud-storage google-cloud-lro google-cloud-longrunning anyhow
Tambahkan tokio untuk eksekusi asinkron dan timer:
cargo add tokio --features full
Memulai operasi yang berjalan lama
Contoh dalam dokumen ini memanggil operasi ganti nama folder Cloud Storage, yang menampilkan LRO. Untuk memulai LRO
secara langsung dan mendapatkan resource Operation awal, selesaikan langkah-langkah
berikut:
Tambahkan deklarasi
useuntuk mempersingkat jalur jenis:Tentukan fungsi
asyncyang menerima ID bucket, ID folder sumber, dan ID folder tujuan:Lakukan inisialisasi klien
StorageControl:Buat builder permintaan
rename_folder:Kirim permintaan dan tunggu resource
Operationawal, yang mewakili operasi latar belakang:
Setelah memulai operasi, tunggu hingga operasi selesai untuk mengambil hasil akhirnya.
Melakukan polling otomatis pada operasi yang berjalan lama
Untuk sebagian besar kasus penggunaan, gunakan metode until_done dari karakteristik Poller, bukan
memanggil send secara langsung. Poller memulai LRO, melakukan polling sesuai dengan kebijakan backoff dan error klien, serta me-resolve ke respons akhir:
Masukkan trait
Pollerke dalam cakupan:Lakukan inisialisasi klien
StorageControldan konfigurasi builder permintaanrename_folder:Panggil
pollerdanuntil_donepada builder permintaan untuk menunggu penyelesaian dan mencetak hasilnya:
Menyelesaikan kode polling otomatis
Fungsi berikut menunjukkan contoh polling otomatis yang lengkap:
Melakukan polling operasi yang berjalan lama dengan hasil sementara
Metode until_done hanya menampilkan hasil akhir dan menghilangkan update metadata perantara. Jika aplikasi Anda memerlukan update progres saat LRO
berjalan, dapatkan poller dengan poller dan panggil poll dalam loop:
Impor
PollerdanPollingResult:Konversikan builder permintaan menjadi poller menggunakan
poller:Panggil
poller.poll().awaitdalam loop untuk memproses statusInProgress,PollingError, danCompleted:
Saat memanggil poll secara langsung, loop Anda mengontrol penundaan antara upaya
polling. Pilih penundaan yang sesuai dengan durasi operasi yang diharapkan.
Kode lengkap untuk polling dengan hasil menengah
Fungsi berikut menunjukkan loop poll lengkap:
Melakukan polling operasi yang berjalan lama secara manual
Meskipun karakteristik Poller menangani hampir semua kasus penggunaan, Anda juga dapat melakukan polling
Operation secara manual menggunakan get_operation:
Setelah memulai LRO dengan
send, masukkan loop dan periksa kolomdone:Periksa
operation.result. KolomresultadalahOptionkarena beberapa operasi, seperti penghapusan, selesai tanpa menampilkan payload. Untukrename_folder, layanan akan menampilkan resourceFolder:Periksa apakah operasi selesai dengan error. Varian error berisi pesan
Statusyang diformat oleh contoh berikut menjadi error, atau yang dapat Anda konversi menjadi error klien menggunakanError::service:Jika operasi berhasil, ekstrak payload
Anyke jenis responsFolderyang diharapkan:Tambahkan arm karakter pengganti karena enum di Library Klien Cloud untuk Rust ditandai
#[non_exhaustive]:Opsional: Saat
operation.doneadalahfalse, ekstrakoperation.metadatauntuk memeriksa update progres:Tunggu sebelum melakukan polling lagi. Contoh ini tidur selama 500 md tetap untuk singkatnya; dalam kode produksi, gunakan backoff eksponensial yang dipotong:
Panggil
get_operationdenganoperation.nameuntuk memuat ulang status operasi:
Kode polling manual lengkap
Fungsi berikut menggabungkan semua langkah polling manual: