Pemicu Cloud Storage
Di Cloud Functions, pemicu Cloud Storage memungkinkan suatu fungsi dipanggil sebagai respons terhadap perubahan dalam Cloud Storage. Saat menentukan pemicu Cloud Storage untuk suatu fungsi, Anda memilih jenis peristiwa dan menentukan bucket Cloud Storage. Fungsi Anda akan dipanggil setiap kali terjadi perubahan pada objek (file) di dalam bucket yang ditentukan.
Jenis peristiwa Cloud Storage berikut ini didukung:
Acara | Jenis peristiwa | Deskripsi |
---|---|---|
Objek diselesaikan |
|
Terjadi saat objek baru dibuat, atau objek yang ada ditimpa dan pembuatan baru objek tersebut dibuat. |
Objek telah dihapus |
|
Terjadi saat objek dihapus secara permanen. |
Objek diarsipkan |
|
Terjadi saat versi aktif sebuah objek menjadi versi lama. Lihat Pembuatan versi objek untuk informasi selengkapnya. |
Metadata objek diperbarui |
|
Dikirim saat terjadi perubahan terhadap metadata objek yang ada. |
Agar fungsi dapat menggunakan pemicu Cloud Storage, pemicu harus diimplementasikan sebagai fungsi yang dipicu peristiwa:
Jika Anda menggunakan Fungsi CloudEvent , data peristiwa Cloud Storage diteruskan ke fungsi Anda dalamFormat CloudEvents dan payload data CloudEvent berjenis
StorageObjectData
.Jika Anda menggunakan fungsi latar belakang, payload data peristiwa Cloud Storage akan diteruskan langsung ke fungsi Anda di
StorageObjectData
.
Repositori Google Events berisi resource tambahan untuk menangani data peristiwa.
Izin
Untuk menggunakan pemicu Cloud Storage di Cloud Functions (generasi ke-2), agen layanan Cloud Storage harus memiliki Penayang Pub/Sub
(roles/pubsub.publisher
) Peran IAM di project Anda. Persyaratan ini tidak berlaku untuk Cloud Functions (generasi ke-1).
Deployment
Anda dapat menentukan pemicu Cloud Storage saat men-deploy fungsi. Lihat Men-deploy Cloud Function untuk mengetahui petunjuk umum cara men-deploy fungsi, dan lihat berikut ini untuk informasi tambahan khusus terkait cara mengonfigurasi pemicu Cloud Storage selama deployment.
gcloud
Jika akan men-deploy menggunakan gcloud CLI, Anda dapat menggunakan jenis peristiwa Object completed Cloud Storage dengan flag berikut:
gcloud functions deploy YOUR_FUNCTION_NAME \ --trigger-bucket=YOUR_STORAGE_BUCKET \ [--retry] \ ...
- Flag
--trigger-bucket
menentukan bucket Cloud Storage yang akan dipantau oleh pemicu. Peristiwa Objek diselesaikan dalam bucket ini akan memicu panggilan ke fungsi Anda. - Flag
--retry
mengontrol apakah panggilan fungsi yang gagal akan dicoba ulang secara otomatis. Lihat Mencoba kembali fungsi berbasis peristiwa untuk mengetahui informasi selengkapnya.
Untuk menggunakan jenis peristiwa selain Object diselesaikan, gunakan tanda berikut:
Untuk Cloud Functions (generasi ke-2):
gcloud functions deploy YOUR_FUNCTION_NAME \ --gen2 \ --trigger-event-filters="type=EVENT_TYPE" \ --trigger-event-filters="bucket=YOUR_STORAGE_BUCKET" \ ...
Saat men-deploy fungsi generasi ke-2, tentukan nama bucket saja tanpa awalan
gs://
; misalnya,--trigger-event-filters="bucket=my-bucket"
.Untuk Cloud Functions (generasi ke-1):
gcloud functions deploy YOUR_FUNCTION_NAME \ --trigger-event=EVENT_TYPE \ --trigger-resource=YOUR_STORAGE_BUCKET \ ...
Peristiwa Cloud Storage lama
Fungsi lama di Cloud Functions (generasi ke-1) menggunakan notifikasi perubahan objek lama untuk pemicu Cloud Storage:
gcloud functions deploy YOUR_FUNCTION_NAME \ --trigger-event=providers/cloud.storage/eventTypes/object.change \ --trigger-resource=YOUR_STORAGE_BUCKET \ ...
Jenis peristiwa ini didukung untuk fungsi lama yang telah menggunakan peristiwa ini. Namun, sebaiknya jangan gunakan jenis peristiwa ini karena mungkin akan dihapus pada masa mendatang.
Konsol
Jika men-deploy menggunakan Google Cloud Console, Anda dapat mengonfigurasi pemicu Cloud Storage di bagian Pemicu.
Untuk Cloud Functions (generasi ke-2):
- Di kolom Jenis pemicu, pilih Cloud Storage.
Di kolom Jenis peristiwa, pilih peristiwa pemicu. Default-nya adalah
google.cloud.storage.object.v1.finalized
.Untuk peristiwa Cloud Storage yang menggunakan Cloud Audit Logs, lihat petunjuk konfigurasi pemicu untuk pemicu Eventarc.
Di kolom Bucket, klik Browse untuk memilih bucket Cloud Storage yang akan dipantau oleh pemicu. Perubahan pada objek dalam bucket ini akan memicu panggilan ke fungsi Anda.
Pilih atau hapus centang pada kotak Coba lagi jika gagal untuk mengontrol apakah Cloud Functions secara otomatis mencoba ulang pemanggilan fungsi yang gagal. Lihat Mencoba kembali fungsi berbasis peristiwa untuk mengetahui informasi selengkapnya.
Klik More options untuk melakukan konfigurasi tambahan pada pemicu Anda:
Di kolom Jenis pemicu, tentukan salah satu Sumber Google, Kustom, atau Pihak ketiga:
Dengan Sumber Google, Anda dapat menentukan pemicu untuk Pub/Sub, Cloud Storage,Firestore, dan penyedia peristiwa Google lainnya.Di panel pemicu Eventarc, gunakan kolom Event provider untuk memilih produk yang menyediakan jenis peristiwa yang Anda inginkan untuk memicu fungsi Anda. Selanjutnya, di kolom Peristiwa, pilih peristiwa yang ingin Anda gunakan sebagai pemicu.
Opsi Kustom memungkinkan Anda membuat dan menggunakan peristiwa dari kode aplikasi. Ikuti petunjuk di panel Eventarc trigger untuk membuat saluran. Saluran adalah resource yang digunakan sebagai pipeline untuk mengirimkan peristiwa kustom dari produser ke konsumen. Peristiwa kustom dipublikasikan ke saluran dan pemicu Eventarc akan berlangganan peristiwa tersebut.
Opsi Pihak ketiga memungkinkan Anda berintegrasi dengan penyedia non-Google yang menawarkan sumber Eventarc. Lihat peristiwa pihak ketiga di Eventarc untuk mengetahui detailnya.
Di kolom Peristiwa, pilih peristiwa pemicu. Default-nya adalah
google.cloud.storage.object.v1.finalized
.Secara opsional, di kolom Service account, pilih akun layanan yang akan digunakan sebagai identitas pemicu Eventarc. Lihat Identitas pemicu untuk mengetahui informasi selengkapnya.
Klik Save trigger.
Untuk Cloud Functions (generasi ke-1):
- Di kolom Jenis pemicu, pilih Cloud Storage.
- Di kolom Jenis peristiwa, pilih jenis peristiwa.
- Di kolom Bucket, klik Browse untuk memilih bucket Cloud Storage yang akan dipantau oleh pemicu. Perubahan pada objek dalam bucket ini akan memicu panggilan ke fungsi Anda.
- Centang atau hapus centang pada kotak Coba lagi saat gagal untuk mengontrol apakah panggilan fungsi yang gagal akan dicoba ulang secara otomatis. Lihat Mencoba kembali fungsi berbasis peristiwa untuk mengetahui informasi selengkapnya.
Pengiriman acara
Pemicu Cloud Storage diimplementasikan dengan notifikasi Pub/Sub untuk Cloud Storage. Peristiwa tunduk pada jaminan pengiriman notifikasi Pub/Sub.
Bucket Cloud Storage dapat memiliki hingga 10 konfigurasi notifikasi yang ditetapkan untuk dipicu untuk peristiwa tertentu. Melebihi batas notifikasi bucket akan menyebabkan deployment fungsi lebih lanjut gagal dengan error seperti berikut:
Cloud Storage bucket ...: Pub/Sub notification limit reached
Lihat Kuota dan batas Cloud Storage untuk mempelajari lebih lanjut.
Langkah berikutnya
- Pelajari cara menulis fungsi berbasis peristiwa.
- Pelajari cara men-deploy Cloud Function.
- Lihat tutorial fungsi Cloud Storage untuk mengetahui contoh penulisan, penerapan, dan pemanggilan fungsi dengan pemicu Cloud Storage.