Package google.longrunning

Indeks

Operasi

Mengelola operasi yang berjalan lama dengan layanan API.

Jika metode API biasanya memerlukan waktu lama untuk diselesaikan, metode tersebut dapat dirancang untuk menampilkan Operation ke klien, dan klien dapat menggunakan antarmuka ini untuk menerima respons sebenarnya secara asinkron dengan melakukan polling 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)

Membatalkan transfer. Gunakan metode transferOperations.get untuk memeriksa apakah pembatalan berhasil atau apakah operasi selesai meskipun ada permintaan cancel.

Saat Anda membatalkan operasi, transfer yang sedang berjalan akan terganggu. Untuk tugas transfer berulang, instance tugas transfer berikutnya akan tetap berjalan. Misalnya, jika tugas Anda dikonfigurasi untuk berjalan setiap hari pukul 13.00 dan Anda membatalkan operasi hari Senin pukul 13.05, transfer hari Senin akan berhenti. Namun, tugas transfer akan tetap dicoba pada hari Selasa.

Hal ini hanya berlaku untuk operasi yang sedang berjalan. Jika operasi saat ini tidak berjalan, cancel tidak melakukan apa pun.

Saat Anda membatalkan tugas, tugas berikutnya akan menghitung delta file dan dapat memperbaiki status yang tidak konsisten. Misalnya, jika Anda menjalankan tugas setiap hari, dan tugas hari ini menemukan 10 file baru dan mentransfer lima file sebelum Anda membatalkan tugas, operasi transfer besok akan menghitung delta baru dengan lima file yang tidak disalin hari ini ditambah file baru yang ditemukan besok.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

  • https://www.googleapis.com/auth/cloud-platform

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 cakupan OAuth berikut:

  • https://www.googleapis.com/auth/cloud-platform

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.
ListOperations

rpc ListOperations(ListOperationsRequest) returns (ListOperationsResponse)

Mencantumkan operasi transfer. Operasi diurutkan berdasarkan waktu pembuatannya dalam urutan kronologis terbalik.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

  • https://www.googleapis.com/auth/cloud-platform

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.

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

Wajib. Nama jenis yang dicantumkan; harus transferOperations.
filter

string

Wajib. Daftar parameter kueri yang ditentukan sebagai teks JSON dalam bentuk: {"projectId":"my_project_id", "jobNames":["jobid1","jobid2",...], "jobNamePattern": "job_name_pattern", "operationNames":["opid1","opid2",...], "operationNamePattern": "operation_name_pattern", "minCreationTime": "min_creation_time", "maxCreationTime": "max_creation_time", "transferStatuses":["status1","status2",...]}

Karena jobNames, operationNames, dan transferStatuses mendukung beberapa nilai, nilai tersebut harus ditentukan dengan notasi array. projectId adalah satu-satunya argumen yang diperlukan. Jika ditentukan, jobNamePattern dan operationNamePattern harus cocok dengan nama tugas atau operasi lengkap. '*' adalah karakter pengganti yang cocok dengan 0 atau beberapa karakter. minCreationTime dan maxCreationTime harus berupa stempel waktu yang dienkode sebagai string dalam format RFC 3339. Nilai yang valid untuk transferStatuses tidak peka huruf besar/kecil: IN_PROGRESS, PAUSED, SUCCESS, FAILED, dan ABORTED.
page_size

int32

Ukuran halaman daftar. Nilai maksimum yang diizinkan adalah 256.
page_token

string

Token halaman daftar.

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 unik yang ditetapkan server. Format name adalah transferOperations/some/unique/name.
metadata

Any

Merepresentasikan objek operasi transfer. Untuk meminta objek TransferOperation, gunakan transferOperations.get.
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 yang 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 aslinya adalah TakeSnapshot(), jenis respons yang disimpulkan adalah TakeSnapshotResponse.