Memulai pembatalan asinkron pada operasi yang berjalan lama. Server berusaha semaksimal mungkin untuk membatalkan operasi, tetapi keberhasilan tidak dijamin. Jika server tidak mendukung metode ini, google.rpc.Code.UNIMPLEMENTED
akan ditampilkan. Klien dapat menggunakan Operations.GetOperation
atau metode lain untuk memeriksa apakah pembatalan berhasil atau apakah operasi selesai meskipun terjadi pembatalan. Jika pembatalan berhasil, operasi tidak dihapus; sebagai gantinya, operasi ini menjadi operasi dengan nilai Operation.error
dengan google.rpc.Status.code
1, yang sesuai dengan Code.CANCELLED
.
Permintaan HTTP
POST https://firestore.googleapis.com/v1/{name=projects/*/databases/*/operations/*}:cancel
URL menggunakan sintaksis gRPC Transcoding.
Parameter jalur
Parameter | |
---|---|
name |
Nama resource operasi yang akan dibatalkan. |
Isi permintaan
Isi permintaan harus kosong.
Isi respons
Jika berhasil, isi respons akan kosong.
Cakupan otorisasi
Memerlukan salah satu cakupan OAuth berikut:
https://www.googleapis.com/auth/datastore
https://www.googleapis.com/auth/cloud-platform
Untuk informasi selengkapnya, lihat Ringkasan Autentikasi.