Package google.longrunning

Indeks

• Operations (antar muka)
• CancelOperationRequest (pesan)
• GetOperationRequest (pesan)
• ListOperationsRequest (pesan)
• ListOperationsResponse (pesan)
• Operation (pesan)

Operasi

Mengelola operasi yang berjalan lama dengan layanan API.

Jika metode API biasanya memerlukan waktu lama untuk diselesaikan, metode tersebut dapat didesain untuk menampilkan Operation ke klien, dan klien dapat menggunakan antarmuka ini untuk menerima respons sebenarnya secara asinkron dengan melakukan polling pada resource operasi, atau meneruskan resource operasi ke API lain (seperti Pub/Sub API) untuk menerima respons. Setiap layanan API yang menampilkan operasi yang berjalan lama harus menerapkan antarmuka Operations sehingga developer dapat memiliki pengalaman klien yang konsisten.

CancelOperation

rpc CancelOperation(CancelOperationRequest) returns (Empty) 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. Cakupan otorisasi Memerlukan salah satu cakupan OAuth berikut: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.

GetOperation

rpc GetOperation(GetOperationRequest) returns (Operation) Mengambil status terbaru dari operasi yang berjalan lama. Klien dapat menggunakan metode ini untuk polling hasil operasi pada interval seperti yang direkomendasikan oleh layanan API. Cakupan otorisasi Memerlukan salah satu cakupan OAuth berikut: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite Untuk mengetahui informasi selengkapnya, lihat Authentication Overview. Izin IAM Memerlukan izin IAM berikut pada resource name: discoveryengine.operations.get Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

ListOperations

rpc ListOperations(ListOperationsRequest) returns (ListOperationsResponse) Menampilkan operasi yang cocok dengan filter yang ditentukan dalam permintaan. Jika server tidak mendukung metode ini, UNIMPLEMENTED akan ditampilkan. Cakupan otorisasi Memerlukan salah satu cakupan OAuth berikut: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/discoveryengine.readwrite Untuk mengetahui informasi selengkapnya, lihat Authentication Overview. Izin IAM Memerlukan izin IAM berikut pada resource name: discoveryengine.operations.list Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

CancelOperationRequest

Pesan permintaan untuk Operations.CancelOperation.

Kolom
name	string Nama resource operasi yang akan dibatalkan.

GetOperationRequest

Pesan permintaan untuk Operations.GetOperation.

Kolom
name	string Nama resource operasi.

ListOperationsRequest

Pesan permintaan untuk Operations.ListOperations.

Kolom
name	string Nama resource induk operasi.
filter	string Filter daftar standar.
page_size	int32 Ukuran halaman daftar standar.
page_token	string Token halaman daftar standar.
return_partial_success	bool Jika disetel ke true, operasi yang dapat dijangkau akan ditampilkan seperti biasa, dan operasi yang tidak dapat dijangkau akan ditampilkan di kolom [ListOperationsResponse.unreachable]. Nilai ini hanya dapat berupa true saat membaca di seluruh koleksi, misalnya saat parent disetel ke "projects/example/locations/-". Kolom ini tidak didukung secara default dan akan menghasilkan error UNIMPLEMENTED jika disetel, kecuali jika didokumentasikan secara eksplisit dalam dokumentasi khusus produk atau layanan.

ListOperationsResponse

Pesan respons untuk Operations.ListOperations.

Kolom
operations[]	Operation Daftar operasi yang cocok dengan filter yang ditentukan dalam permintaan.
next_page_token	string Daftar standar token halaman berikutnya.
unreachable[]	string Daftar yang tidak diurutkan. Resource tidak dapat dijangkau. Diisi saat permintaan menetapkan ListOperationsRequest.return_partial_success dan membaca di seluruh koleksi, misalnya saat mencoba mencantumkan semua resource di semua lokasi yang didukung.

Operasi

Resource ini mewakili operasi yang berjalan lama yang merupakan hasil dari panggilan API jaringan.

Kolom
name	string Nama server yang ditetapkan, yang hanya bersifat unik dalam layanan yang sama yang awalnya menampilkannya. Jika Anda menggunakan pemetaan HTTP default, name harus berupa nama resource yang diakhiri dengan operations/{unique_id}.
metadata	Any 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	bool Jika nilainya false, itu berarti operasi masih berlangsung. Jika true, operasi selesai, dan error atau response tersedia.
Kolom union result. Hasil operasi, yang dapat berupa error atau response yang valid. Jika done == false, error atau response tidak ditetapkan. Jika done == true, hanya salah satu dari error atau response yang dapat ditetapkan. Beberapa layanan mungkin tidak memberikan hasil. result hanya dapat berupa salah satu dari berikut:
error	Status Hasil error operasi jika terjadi kegagalan atau pembatalan.
response	Any Respons normal dan berhasil dari operasi. Jika metode asli tidak menampilkan data saat berhasil, seperti Delete, responsnya adalah google.protobuf.Empty. Jika metode asli adalah Get/Create/Update standar, responsnya harus berupa resource. Untuk metode lain, respons harus memiliki jenis XxxResponse, dengan Xxx yang merupakan nama metode asli. Misalnya, jika nama metode asli adalah TakeSnapshot(), jenis respons yang disimpulkan adalah TakeSnapshotResponse.