Package google.longrunning

Indeks

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

Operasi

Mengelola operasi yang berjalan lama dengan layanan API.

Jika biasanya metode API memerlukan waktu lama untuk diselesaikan, metode ini dapat dirancang untuk menampilkan Operation ke klien, dan klien dapat menggunakan antarmuka ini untuk menerima respons nyata secara asinkron dengan melakukan polling resource operasi, atau meneruskan resource operasi ke API lain (seperti Google Cloud 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/jobs https://www.googleapis.com/auth/cloud-platform Untuk mengetahui informasi selengkapnya, lihat Ringkasan Autentikasi.

DeleteOperation

rpc DeleteOperation(DeleteOperationRequest) returns (Empty) Menghapus operasi yang berjalan lama. Metode ini menunjukkan bahwa klien tidak lagi tertarik pada hasil operasi. Metode tersebut tidak membatalkan operasi. Jika server tidak mendukung metode ini, google.rpc.Code.UNIMPLEMENTED akan ditampilkan. Cakupan Otorisasi Memerlukan salah satu cakupan OAuth berikut: https://www.googleapis.com/auth/jobs https://www.googleapis.com/auth/cloud-platform Untuk mengetahui informasi selengkapnya, lihat Ringkasan Autentikasi.

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/jobs https://www.googleapis.com/auth/cloud-platform Untuk mengetahui informasi selengkapnya, lihat Ringkasan Autentikasi.

ListOperations

rpc ListOperations(ListOperationsRequest) returns (ListOperationsResponse) Menampilkan operasi yang sesuai dengan filter yang ditentukan dalam permintaan. Jika server tidak mendukung metode ini, UNIMPLEMENTED akan ditampilkan. CATATAN: binding name memungkinkan layanan API mengganti binding untuk menggunakan skema nama resource yang berbeda, seperti users/*/operations. Untuk mengganti binding, layanan API dapat menambahkan binding seperti "/v1/{name=users/*}/operations" ke konfigurasi layanannya. Untuk kompatibilitas mundur, nama default menyertakan id pengumpulan operasi, namun pengguna yang diganti harus memastikan binding nama adalah resource induk, tanpa id kumpulan operasi. Cakupan Otorisasi Memerlukan salah satu cakupan OAuth berikut: https://www.googleapis.com/auth/jobs https://www.googleapis.com/auth/cloud-platform Untuk mengetahui informasi selengkapnya, lihat Ringkasan Autentikasi.

WaitOperation

rpc WaitOperation(WaitOperationRequest) returns (Operation) Menunggu operasi jangka panjang yang ditentukan hingga operasi tersebut selesai atau mencapai waktu tunggu maksimum yang ditentukan, yang menampilkan status terbaru. Jika operasi sudah selesai, status terbaru segera ditampilkan. Jika waktu tunggu yang ditentukan lebih besar daripada waktu tunggu HTTP/RPC default, waktu tunggu HTTP/RPC akan digunakan. Jika server tidak mendukung metode ini, google.rpc.Code.UNIMPLEMENTED akan ditampilkan. Perhatikan bahwa metode ini atas dasar upaya terbaik. Fungsi ini dapat menampilkan status terbaru sebelum waktu tunggu yang ditentukan (termasuk seketika), yang berarti bahkan respons langsung tidak menjamin bahwa operasi selesai. Cakupan Otorisasi Memerlukan salah satu cakupan OAuth berikut: https://www.googleapis.com/auth/jobs https://www.googleapis.com/auth/cloud-platform Untuk mengetahui informasi selengkapnya, lihat Ringkasan Autentikasi.

CancelOperationRequest

Pesan permintaan untuk Operations.CancelOperation.

Kolom
name	string Nama resource operasi yang akan dibatalkan.

DeleteOperationRequest

Pesan permintaan untuk Operations.DeleteOperation.

Kolom
name	string Nama resource operasi yang akan dihapus.

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.

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.

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 ditetapkan. result hanya dapat berupa salah satu dari berikut:
error	Status Hasil error operasi jika terjadi kegagalan atau pembatalan.
response	Any Respons normal dari operasi jika terjadi keberhasilan. 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 aslinya adalah TakeSnapshot(), jenis respons yang disimpulkan adalah TakeSnapshotResponse.

WaitOperationRequest

Pesan permintaan untuk Operations.WaitOperation.

Kolom
name	string Nama resource operasi untuk ditunggu.
timeout	Duration Durasi maksimum untuk menunggu sebelum waktu habis. Jika dibiarkan kosong, waktu menunggu paling lama adalah yang diizinkan oleh protokol HTTP / RPC yang mendasarinya. Jika batas waktu RPC juga ditentukan, yang lebih singkat akan digunakan.