Déclencheurs Google Cloud Storage
Cloud Functions utilise des fonctions basées sur des événements pour gérer les événements de votre infrastructure Cloud. Par exemple, Cloud Functions peut répondre à des notifications de modification provenant de Google Cloud Storage. Ces notifications peuvent être configurées de manière à se déclencher en réponse à divers événements à l’intérieur d’un bucket : création, suppression et archivage d'objets, ainsi que mises à jour de métadonnées.
Types d'événement
Les événements Cloud Storage utilisés par Cloud Functions sont basés sur les notifications Cloud Pub/Sub pour Google Cloud Storage, et sont fournis au format API JSON Cloud Storage.
Les fonctions déclenchées par Storage acceptent quatre types de déclencheurs. Ces valeurs de type de déclencheur sont utilisées lors du déploiement de la fonction pour spécifier les événements Cloud Storage qui déclencheront vos fonctions :
google.storage.object.finalize
(par défaut)
Exemple de code de fonction
L'exemple de fonction suivant enregistre les données pertinentes lorsqu'un événement se produit.
Vous spécifiez le type de déclencheur lorsque vous déployez la fonction. Par exemple, l'exemple de déploiement ci-dessous utilise la fonction pour consigner chaque occurrence d'une création d'objet en spécifiant le type de déclencheur google.storage.object.finalize
.
Pour accéder à un tutoriel complet sur l'exécution de ce code, consultez le tutoriel Cloud Storage :
Node.js
Python
Go
Java
C#
Ruby
PHP
Spécifier le type de déclencheur lors du déploiement
La commande gcloud
suivante déploie la fonction avec un déclencheur object.finalize
.
Node.js
gcloud functions deploy helloGCS \ --runtime nodejs16 \Vous pouvez attribuer les valeurs suivantes à l'option
--trigger-resource YOUR_TRIGGER_BUCKET_NAME \
--trigger-event google.storage.object.finalize
--runtime
, afin de spécifier votre version préférée de Node.js : nodejs16
(recommandé)nodejs14
nodejs12
nodejs10
Python
gcloud functions deploy hello_gcs \ --runtime python39 \Vous pouvez attribuer les valeurs suivantes à l'option
--trigger-resource YOUR_TRIGGER_BUCKET_NAME \
--trigger-event google.storage.object.finalize
--runtime
, afin de spécifier votre version préférée de Python :python310
(version bêta)python39
(recommandé)python38
python37
Go
gcloud functions deploy HelloGCS \ --runtime go116 \Vous pouvez attribuer les valeurs suivantes à l'option
--trigger-resource YOUR_TRIGGER_BUCKET_NAME \
--trigger-event google.storage.object.finalize
--runtime
, afin de spécifier votre version préférée de Go : go116
(recommandé)go113
go111
Java
gcloud functions deploy java-gcs-function \ --entry-point functions.HelloGcs \ --runtime java11 \ --memory 512MB \Vous pouvez attribuer les valeurs suivantes à l'option
--trigger-resource YOUR_TRIGGER_BUCKET_NAME \
--trigger-event google.storage.object.finalize
--runtime
, afin de spécifier votre version préférée de Java :java17
(version bêta)java11
(recommandé)
C#
gcloud functions deploy csharp-gcs-function \ --entry-point HelloGcs.Function \ --runtime dotnet3 \
--trigger-resource YOUR_TRIGGER_BUCKET_NAME \
--trigger-event google.storage.object.finalize
Ruby
gcloud functions deploy hello_gcs --runtime ruby30 \Vous pouvez attribuer les valeurs suivantes à l'option
--trigger-resource YOUR_TRIGGER_BUCKET_NAME \
--trigger-event google.storage.object.finalize
--runtime
, afin de spécifier votre version préférée de Ruby : ruby30
(recommandé)ruby27
ruby26
PHP
gcloud functions deploy helloGCS --runtime php74 \Vous pouvez attribuer les valeurs suivantes à l'option
--trigger-resource YOUR_TRIGGER_BUCKET_NAME \
--trigger-event google.storage.object.finalize
--runtime
, afin de spécifier votre version préférée de PHP :php81
(version bêta)php74
(recommandé)
où YOUR_TRIGGER_BUCKET_NAME
est le nom du bucket Cloud Storage que la fonction surveillera.
Finalisation de l'objet
Valeur du type de déclencheur : google.storage.object.finalize
Cet événement est envoyé lorsqu'un nouvel objet est créé dans le bucket (ou qu'un objet existant est remplacé et qu'une nouvelle génération de cet objet est créée).
Suppression de l'objet
Valeur du type de déclencheur : google.storage.object.delete
Cet événement est envoyé lorsqu'un objet est définitivement supprimé. En fonction du paramètre de gestion des versions d'objet des buckets, cela signifie :
pour les buckets avec gestion des versions, que celui-ci n'est envoyé que lorsqu'une version est définitivement supprimée (mais pas lorsqu'un objet est archivé) ;
pour les buckets sans gestion de versions, que celui-ci est envoyé lorsqu'un objet est supprimé ou écrasé.
Archivage de l'objet
Valeur du type de déclencheur : google.storage.object.archive
Cet événement est envoyé lorsqu'une version en ligne d'un objet est archivée ou supprimée.
Cet événement est uniquement envoyé pour les buckets avec gestion des versions.
Mise à jour des métadonnées de l'objet
Valeur du type de déclencheur : google.storage.object.metadataUpdate
Cet événement est envoyé lorsque les métadonnées d'un objet existant changent.
Structure de l'événement
Les données d'événements de stockage sont envoyées au format object
Cloud Storage.
Mécanisme de diffusion d'événements
Les événements sont envoyés via des notifications Pub/Sub issues de Cloud Storage. Les événements sont soumis aux garanties de diffusion de Pub/Sub.
Limites des notifications
Un bucket peut comporter jusqu'à 10 configurations de notification déclenchant un événement spécifique. Configurer trop de notifications sur le même bucket peut vous faire dépasser la limite de notifications et empêcher la création d'une fonction, comme indiqué par l'erreur suivante :
Cloud Storage bucket ...: Pub/Sub notification limit reached
Si vous atteignez la limite, vous ne pourrez pas créer de fonction tant que vous n'aurez pas entrepris d'actions correctives, telles que la suppression de notifications.
Découvrez les quotas et les limites de requêtes pour Cloud Storage.
Autorisations
Vous devez disposer des autorisations suffisantes sur le projet qui recevra les notifications. Cela implique d'effectuer les opérations suivantes :
Obtenir l'adresse e-mail de l'agent de service associé au projet contenant votre bucket Cloud Storage.
Utiliser l'adresse e-mail obtenue à l'étape précédente pour octroyer à l'agent de service le rôle IAM
pubsub.publisher
pour le sujet Pub/Sub concerné.
Apprenez-en plus sur la configuration des notifications Pub/Sub pour Cloud Storage.
Anciens déclencheurs Cloud Storage
La commande gcloud
ci-dessous déploie une fonction déclenchée par la réception d'anciennes notifications de changement d'objet sur un bucket spécifique. Généralement, les notifications Cloud Pub/Sub sont plus faciles à utiliser, plus flexibles et plus puissantes que les notifications de modification d'objet.
Cependant, ces anciennes notifications sont acceptées dans les anciennes fonctions qui utilisent déjà ces événements.
gcloud functions deploy YOUR_FUNCTION_NAME \ --trigger-resource YOUR_TRIGGER_BUCKET_NAME \ --trigger-event providers/cloud.storage/eventTypes/object.change \ FLAGS...
Argument | Description |
---|---|
--trigger-resource NAME |
Nom du bucket Cloud Storage dont la fonction surveille les changements. |
--trigger-event NAME |
Nom du type d'événement que la fonction souhaite recevoir. Dans ce cas, il s'agit de l'ancien événement object.change . |
FLAGS... |
Options supplémentaires à spécifier lors du déploiement, telles que --runtime . Pour accéder aux informations complètes, consultez la documentation sur gcloud functions deploy .
|
Étapes suivantes
Reportez-vous au tutoriel sur Cloud Storage pour obtenir un exemple de mise en œuvre d'une fonction basée sur des événements déclenchée par Cloud Storage.