Déclencheur Cloud Pub/Sub

Le déclencheur Cloud Pub/Sub vous permet d'exécuter votre intégration en fonction des événements de votre middleware Pub/Sub.

Ce déclencheur vous permet d'exécuter une intégration dès qu'un éditeur écrit un message dans le sujet de votre choix. Lorsque ce déclencheur s'exécute, il écrit également le message publié dans la variable de sortie CloudPubSubMessage. Selon vos besoins, vous pouvez utiliser cette variable dans vos déclencheurs ou vos tâches en aval.

Avant de commencer

Assurez-vous d'effectuer les tâches suivantes dans votre projet Google Cloud avant de configurer le déclencheur Cloud Pub/Sub.

  • Attribuez les rôles IAM suivants à votre compte de service par défaut (service-PROJECT_NUMBER@gcp-sa-apigee.iam.gserviceaccount.com) :
  • Vérifiez que vous disposez d'un sujet Cloud Pub/Sub. Pour créer un sujet Pub/Sub :
    1. Accédez à la page "Sujets Pub/Sub" dans Cloud Console.

      Accéder à la page "Sujets Pub/Sub"

    2. Cliquez sur Create a topic (Créer un sujet).
    3. Dans le champ ID du sujet, indiquez un nom de sujet unique.
    4. Cliquez sur Enregistrer.

Pour en savoir plus sur la gestion des accès à l'aide des rôles IAM, consultez la page Contrôle des accès.

Pour plus d'informations sur l'attribution de rôles aux comptes principaux, consultez la page Accorder, modifier et révoquer les accès.

Ajouter un déclencheur Cloud Pub/Sub

Pour ajouter un déclencheur Cloud Pub/Sub à une intégration nouvelle ou existante, procédez comme suit :
  1. Dans l'interface utilisateur Apigee, sélectionnez votre organisation Apigee.
  2. Cliquez sur Développer > Intégrations.
  3. Sélectionnez une intégration existante ou créez-en une en cliquant sur Créer une intégration.

    Si vous créez une intégration :

    1. Saisissez un nom et une description dans la boîte de dialogue Créer une intégration.
    2. Dans la liste des régions compatibles, sélectionnez une région pour l'intégration.
    3. Cliquez sur Créer.

    La page de conception d'intégration s'affiche.

  4. Dans la barre de navigation de la page de conception d'intégration, cliquez sur +Ajouter une tâche ou un déclencheur > Déclencheurs pour afficher la liste des déclencheurs disponibles.
  5. Cliquez sur l'élément de déclencheur Cloud Pub/Sub et placez-le au niveau du concepteur.

Configurer un déclencheur Cloud Pub/Sub

Cliquez sur l'élément Déclencheur Cloud Pub/Sub dans l'éditeur d'intégrations pour afficher le volet de configuration du déclencheur, puis effectuez les tâches suivantes :

Spécifiez le sujet que le déclencheur doit écouter dans le champ Sujet Pub/Sub au format suivant :

projects/PROJECT_ID/topics/TOPIC_ID

Pour afficher tous les sujets disponibles dans votre projet Google Cloud, consultez la colonne Nom du sujet dans la section Sujets.

Remplacez les éléments suivants :

  • PROJECT_ID : le projet Google Cloud dans lequel votre sujet a été créé.
  • TOPIC_ID : l'ID de votre sujet Pub/Sub.

Sortie du déclencheur

Pour chaque événement, le déclencheur Cloud Pub/Sub génère une variable de sortie CloudPubSubMessage que vous pouvez utiliser dans vos tâches en aval. La variable est au format JSON et possède la structure PubsubMessage.

Remarques

  • La taille maximale d'un message Pub/Sub est de 10 Mo. Pour comprendre toutes les limitations de Pub/Sub, consultez la page Quotas et limites de Pub/Sub.
  • Il est possible que Pub/Sub écrive le même message plusieurs fois dans un sujet. Pour comprendre ce comportement de Pub/Sub, consultez la section Distribution de type "au moins une fois". Par conséquent, vous devez concevoir votre intégration de manière à ce qu'elle soit idempotente afin qu'un message ne puisse pas être écrit plusieurs fois dans un sujet.
  • Si vous annulez la publication d'une intégration, l'abonnement Pub/Sub n'est pas supprimé pour éviter toute perte de messages. Toutefois, si vous supprimez la version publiée ou toutes les versions d'une intégration, l'abonnement Pub/Sub est également supprimé.