Notifikasi Pub/Sub

Setelah menyelesaikan transfer Storage Transfer Service, Anda mungkin ingin memulai tugas lain, menangani error yang terjadi selama transfer, atau mencatat bahwa transfer telah terjadi. Pub/Sub menyediakan antrean yang disubscribe oleh program Anda untuk menerima pesan saat transfer selesai. Hal ini memungkinkan Anda menggunakan kembali kode dan memprogram langkah berikutnya berdasarkan status transfer.

Untuk mengetahui informasi selengkapnya tentang Pub/Sub, lihat artikel Apa yang dimaksud dengan Cloud Pub/Sub

Prasyarat

Sebelum Anda dapat menggunakan fitur ini, lakukan hal berikut:

1. Aktifkan Pub/Sub API untuk project yang menerima notifikasi Pub/Sub.

   Mengaktifkan API

2. Memiliki topik Pub/Sub yang sudah ada yang ingin Anda kirimi notifikasi.

3. Dapatkan alamat email akun layanan yang terkait dengan project yang berisi bucket Storage Transfer Service Anda.

   1. Berikan peran IAM roles.pubsub.publisher kepada akun layanan untuk topik Pub/Sub yang diinginkan.

Mengonfigurasi setelan notifikasi

Untuk mengonfigurasi setelan notifikasi Pub/Sub Storage Transfer Service, Anda menggunakan Storage Transfer Service transferJobs API, untuk membuat pesan NotificationConfig. Topik akan menerima notifikasi di saluran Pub/Sub yang dikonfigurasi.

Tentukan hal berikut dalam pesan NotificationConfig Anda:

• Topik Pub/Sub yang akan dikirimi notifikasi
• Format pesan, "JSON" atau "NONE"

• Jenis peristiwa yang diinginkan, sesuai dengan TransferOperation.Statuses yang telah selesai:

  • "TRANSFER_OPERATION_SUCCESS"
  • "TRANSFER_OPERATION_FAILED"
  • "TRANSFER_OPERATION_ABORTED"

Berikut adalah contoh pesan NotificationConfig:

{
   ...
   "notificationConfig": {
     "pubsubTopic": "projects/project-id/topics/topic-id",
     "eventTypes": ["TRANSFER_OPERATION_SUCCESS"],
     "payloadFormat": "JSON"
   },
   ...
}

Ganti kode berikut:

• project-id: ID project Google Cloud transfer
• topic-id: Nama topik Pub/Sub

Untuk mengetahui informasi selengkapnya, lihat spesifikasi REST Pub/Sub Storage Transfer Service.

Format notifikasi

Notifikasi yang dikirim ke topik Pub/Sub terdiri dari dua bagian:

• Atribut: Kumpulan key:value pair yang mendeskripsikan peristiwa.
• Payload: String yang berisi metadata objek yang diubah.

Atribut

Atribut adalah key:value pair yang terdapat dalam semua notifikasi yang dikirim oleh Storage Transfer Service ke topik Pub/Sub Anda. Notifikasi selalu berisi serangkaian key-value pair berikut, terlepas dari payload notifikasi:

Lihat PubsubMessage untuk mengetahui informasi selengkapnya tentang format pesan Pub/Sub.

Payload

Payload berisi metadata TransferOperation. Saat membuat konfigurasi notifikasi, Anda menentukan jenis payload yang akan disertakan dalam notifikasi yang dipicu oleh konfigurasi tersebut. Anda dapat menentukan jenis payload berikut: