Déclencheurs Cloud Storage (1re génération)

Remarque : Ce contenu ne s'applique qu'aux fonctions Cloud Run (1re génération) (anciennement Cloud Functions (1re génération).)

Pour obtenir la version de ce document correspondant à Cloud Run Functions, consultez Déclencheurs Cloud Storage.

Dans Cloud Run Functions, un déclencheur Cloud Storage permet d'appeler une fonction en réponse aux modifications de Cloud Storage. Lorsque vous spécifiez un déclencheur Cloud Storage pour une fonction, vous choisissez un type d'événement et spécifiez un bucket Cloud Storage. Votre fonction est appelée chaque fois qu'une modification se produit sur un objet (fichier) dans le bucket spécifié.

Remarque : Pour qu'une fonction Cloud Run soit déclenchée par un événement sur un bucket Cloud Storage, la fonction et le bucket doivent se trouver dans le même projet Google Cloud.

Les types d'événements Cloud Storage suivants sont acceptés :

Événement	Type d'événement	Description
Objet finalisé	google.storage.object.finalize	Se produit lorsqu'un objet est créé, ou lorsqu'un objet existant est écrasé et qu'une nouvelle génération de cet objet est créée.
Objet supprimé	google.storage.object.delete	Se produit lorsqu'un objet est définitivement supprimé.
Objet archivé	google.storage.object.archive	Se produit lorsqu'une version active d'un objet devient une version obsolète. Pour en savoir plus, consultez Gestion des versions d'objets.
Métadonnées d'objet mises à jour	google.storage.object.metadataUpdate	Se produit lorsque les métadonnées d'un objet existant sont modifiées.

Pour qu'une fonction utilise un déclencheur Cloud Storage, elle doit être mise en œuvre en tant que fonction basée sur les événements :

• Si vous utilisez une fonction CloudEvent, les données d'événement Cloud Storage sont transmises à votre fonction au format CloudEvents et la charge utile des données CloudEvent est de type StorageObjectData.

• Si vous utilisez une fonction d'arrière-plan, la charge utile des données d'événement Cloud Storage est transmise directement à votre fonction dans le format StorageObjectData.

Le dépôt Google Events contient des ressources supplémentaires sur l'utilisation des données d'événement.

Déploiement

Vous pouvez spécifier un déclencheur Cloud Storage lorsque vous déployez une fonction. Consultez la page Déployer une fonction Cloud Run pour obtenir des instructions générales sur le déploiement d'une fonction. Consultez la suite de cette page pour obtenir des informations supplémentaires spécifiques à la configuration des déclencheurs Cloud Storage lors du déploiement.

gcloud

Si vous déployez à l'aide de gcloud CLI, vous pouvez utiliser le type d'événement Objet finalisé Cloud Storage avec les options suivantes :

gcloud functions deploy YOUR_FUNCTION_NAME \
--no-gen2 \
--trigger-bucket=YOUR_STORAGE_BUCKET \
[--retry] \
...

• L'option --trigger-bucket spécifie le bucket Cloud Storage que le déclencheur surveillera. Les événements objets finalisés dans ce bucket déclencheront des appels vers votre fonction.
• L'option --retry permet de vérifier si les appels de fonction ayant échoué sont automatiquement relancés. Pour en savoir plus, consultez la section Effectuer de nouvelles tentatives d'exécution des fonctions basées sur des événements.

Pour utiliser des types d'événements autres que le type Objet finalisé, utilisez les options suivantes :

  gcloud functions deploy YOUR_FUNCTION_NAME 

  --no-gen2 

  --trigger-event=EVENT_TYPE 

  --trigger-resource=YOUR_STORAGE_BUCKET 

  ...
  

Anciens événements Cloud Storage

Les anciennes fonctions de Cloud Run Functions (1re génération) utilisent les anciennes notifications de changement d'objet pour les déclencheurs Cloud Storage :

gcloud functions deploy YOUR_FUNCTION_NAME \
--no-gen2 \
--trigger-event=providers/cloud.storage/eventTypes/object.change \
--trigger-resource=YOUR_STORAGE_BUCKET \
...

Ce type d'événement est compatible avec les anciennes fonctions qui utilisent déjà ces événements. Toutefois, nous vous déconseillons d'utiliser ce type d'événement, car il se peut qu'il soit supprimé ultérieurement.

Console

Si vous effectuez un déploiement à l'aide de la console Google Cloud, vous pouvez configurer un déclencheur Cloud Storage dans la section Déclencheur :

1. Dans le champ Type de déclencheur, sélectionnez Cloud Storage.
2. Dans le champ Type d'événement, sélectionnez un type d'événement.
3. Dans le champ Bucket, cliquez sur Parcourir pour sélectionner un bucket Cloud Storage que le déclencheur doit surveiller. Les modifications apportées aux objets de ce bucket déclencheront des appels vers votre fonction.
4. Cochez ou décochez la case Réessayer après échec pour vérifier si les appels de fonction ayant échoué sont automatiquement relancés. Pour en savoir plus, consultez la section Effectuer de nouvelles tentatives d'exécution des fonctions basées sur des événements.

Diffusion d'événements

Les déclencheurs Cloud Storage sont implémentés avec les notifications Pub/Sub pour Cloud Storage. Les événements sont soumis aux garanties de diffusion des notifications Pub/Sub.

Un bucket Cloud Storage peut comporter jusqu'à 10 configurations de notification déclenchant un événement spécifique. Si vous dépassez les limites de notifications du bucket, des déploiements de fonctions supplémentaires échoueront avec un message d'erreur semblable à celui-ci :

Cloud Storage bucket ...: Pub/Sub notification limit reached

Pour en savoir plus, consultez la page Quotas et limites de Cloud Storage.

Étapes suivantes

• Découvrez comment écrire des fonctions basées sur des événements.
• Découvrez comment déployer une fonction Cloud Run.
• Reportez-vous au tutoriel sur la fonction Cloud Storage pour obtenir un exemple d'écriture, de déploiement et d'appel d'une fonction avec un déclencheur Cloud Storage.