Method: transferJobs.patch

Memperbarui tugas transfer. Memperbarui spesifikasi transfer tugas tidak memengaruhi operasi transfer yang sudah berjalan.

Catatan: Kolom status tugas dapat diubah menggunakan RPC ini (misalnya, untuk menetapkan status tugas ke DELETED, DISABLED, atau ENABLED).

Permintaan HTTP

PATCH https://storagetransfer.googleapis.com/v1/{jobName=transferJobs/**}

URL menggunakan sintaks gRPC Transcoding.

Parameter jalur

Parameter
jobName

string

Wajib. Nama tugas yang akan diperbarui.

Otorisasi memerlukan izin IAM berikut pada resource jobName yang ditentukan:

  • storagetransfer.jobs.update

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "projectId": string,
  "transferJob": {
    object (TransferJob)
  },
  "updateTransferJobFieldMask": string
}
Kolom
projectId

string

Wajib. ID project Google Cloud yang memiliki tugas.
transferJob

object (TransferJob)

Wajib. Tugas yang akan diperbarui. transferJob diharapkan menentukan satu atau beberapa dari lima kolom: description, transferSpec, notificationConfig, loggingConfig, dan status. UpdateTransferJobRequest yang menentukan kolom lain akan ditolak dengan error INVALID_ARGUMENT. Memperbarui status tugas ke DELETED memerlukan izin storagetransfer.jobs.delete.
updateTransferJobFieldMask

string (FieldMask format)

Mask kolom untuk kolom di transferJob yang akan diperbarui dalam permintaan ini. Kolom di transferJob yang dapat diperbarui adalah: description, transferSpec, notificationConfig, loggingConfig, dan status. Untuk memperbarui transferSpec tugas, spesifikasi transfer lengkap harus diberikan. Spesifikasi yang tidak lengkap dan tidak memiliki kolom wajib diisi akan ditolak dengan error INVALID_ARGUMENT.

Ini adalah daftar dipisahkan koma yang berisi nama-nama kolom yang sepenuhnya memenuhi syarat. Contoh: "user.displayName,photo".

Isi respons

Jika berhasil, isi respons akan berisi instance TransferJob.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

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

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.