Déclencheurs Cloud Storage

Dans Cloud 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é.

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

Event	Type d'événement	Description
Objet finalisé	2e génération : `google.cloud.storage.object.v1.finalized` (via Eventarc) 1re génération : `google.storage.object.finalize`	Se produit lorsqu'un objet est créé ou qu'un objet existant est remplacé et qu'une nouvelle génération de cet objet est créée.
Objet supprimé	2e génération : `google.cloud.storage.object.v1.deleted` (via Eventarc) 1re génération : `google.storage.object.delete`	Se produit lorsqu'un objet est définitivement supprimé.
Objet archivé	2e génération : `google.cloud.storage.object.v1.archived` (via Eventarc) 1re génération : `google.storage.object.archive`	Se produit lorsqu'une version active d'un objet devient une version archivée. Pour en savoir plus, consultez la page Gestion des versions des objets.
Métadonnées d'objet mises à jour	2e génération : `google.cloud.storage.object.v1.metadataUpdated` (via Eventarc) 1re génération : `google.storage.object.metadataUpdate`	Se produit lorsque les métadonnées d'un objet existant changent.

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.

Autorisations

Pour utiliser des déclencheurs Cloud Storage dans Cloud Functions (2e génération), l'Agent de service Cloud Storage doit disposer du rôle IAM Éditeur Pub/Sub (roles/pubsub.publisher) sur votre projet. Cette exigence ne s'applique pas à Cloud Functions (1re génération).

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 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 \
--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 :

Pour Cloud Functions (2nd gen), procédez comme suit :
```
gcloud functions deploy YOUR_FUNCTION_NAME \
--gen2 \
--trigger-event-filters="type=EVENT_TYPE" \
--trigger-event-filters="bucket=YOUR_STORAGE_BUCKET" \
...
```
Remarque : Pour en savoir plus sur l'option --trigger-event-filters, consultez la section Déclencheurs Eventarc.

Pour Cloud Functions (1st gen), procédez comme suit :

gcloud functions deploy YOUR_FUNCTION_NAME \
--trigger-event=EVENT_TYPE \
--trigger-resource=YOUR_STORAGE_BUCKET \
...

Anciens événements Cloud Storage

Les anciennes fonctions de Cloud Functions (1st gen) utilisent les anciennes notifications de changement d'objet pour les déclencheurs Cloud Storage :

gcloud functions deploy YOUR_FUNCTION_NAME \
--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 pourrait être 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.

Pour Cloud Functions (2nd gen), procédez comme suit :
1. Pour ajouter un déclencheur d'événement, cliquez sur Ajouter un déclencheur.
2. Sélectionnez Déclencheur Cloud Storage.
  
  Le volet Déclencheur Eventarc s'ouvre. Le volet est prérempli avec Cloud Storage comme fournisseur d'événements et google.cloud.storage.object.v1.finalized comme événement déclencheur.
  
  Vous pouvez utiliser le champ Événement pour sélectionner un autre événement. Pour un événement Cloud Storage qui utilise Cloud Audit Logs, reportez-vous aux instructions de configuration du déclencheur pour un déclencheur Eventarc.
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. Dans le champ Compte de service, vous pouvez si vous le souhaitez sélectionner un compte de service à utiliser comme identité du déclencheur Eventarc. Pour en savoir plus, consultez la section Identité du déclencheur.
5. 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.
6. Cliquez sur Enregistrer le déclencheur.
Pour Cloud Functions (1st gen), procédez comme suit :
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 mis en œuvre avec des 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.
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.