Package google.longrunning

Indeks

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.

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/cloud-vision

Untuk mengetahui informasi selengkapnya, lihat Ringkasan Autentikasi.

GetOperationRequest

Pesan permintaan untuk Operations.GetOperation.

Kolom
name

string

Nama resource operasi.

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.