Pub/Sub

Le connecteur Cloud Pub/Sub vous permet d'effectuer des opérations d'insertion, de suppression, de mise à jour et de lecture sur les données Google Cloud Pub/Sub.

Avant de commencer

Avant d'utiliser le connecteur Pub/Sub, effectuez les tâches suivantes :

Dans votre projet Google Cloud :
- Attribuez le rôle IAM roles/connectors.admin à l'utilisateur qui configure le connecteur.
- Attribuez les rôles IAM suivants au compte de service que vous souhaitez utiliser pour le connecteur :
  - roles/pubsub.publisher
  Un compte de service est un compte Google spécial destiné à représenter un utilisateur non humain qui doit s'authentifier et obtenir les autorisations permettant d'accéder aux données des API Google. Si vous ne possédez pas de compte de service, vous devez en créer un. Pour plus d'informations, consultez la section Créer un compte de service.
- Activez les services suivants :
  - secretmanager.googleapis.com (API Secret Manager)
  - connectors.googleapis.com (API Connectors)
  Pour savoir comment activer des services, consultez la page Activer des services.
Si ces services ou autorisations n'ont pas encore été activés pour votre projet, vous êtes invité à les activer lors de la configuration du connecteur.

Configurer le connecteur

Pour configurer le connecteur, vous devez créer une connexion à votre source de données (système backend). Une connexion est spécifique à une source de données. Cela signifie que si vous disposez de nombreuses sources de données, vous devez créer une connexion distincte pour chacune d'elles. Pour créer une connexion, procédez comme suit :

Dans la console Cloud, accédez à la page Integration Connectors > Connections (Connecteurs d'intégration > Connexions), puis sélectionnez ou créez un projet Google Cloud.
Accéder à la page "Connexions"
Cliquez sur + CRÉER pour ouvrir la page Créer une connexion.
Dans la section Emplacement, choisissez l'emplacement de la connexion.
1. Région : sélectionnez un emplacement dans la liste déroulante.
  Pour obtenir la liste de toutes les régions disponibles, consultez la page Emplacements.
2. Cliquez sur NEXT (Suivant).
Dans la section Informations de connexion, procédez comme suit :
1. Connecteur : sélectionnez Pub/Sub dans la liste déroulante des connecteurs disponibles.
2. Version du connecteur : sélectionnez la version du connecteur dans la liste déroulante des versions disponibles.
3. Dans le champ Nom de connexion, saisissez un nom pour l'instance de connexion.
  Les noms de connexion doivent répondre aux critères suivants :
  - Les noms de connexion peuvent contenir des lettres, des chiffres ou des traits d'union.
  - Les lettres doivent être en minuscules.
  - Les noms de connexion doivent commencer par une lettre et se terminer par une lettre ou un chiffre.
  - Les noms de connexion ne peuvent pas dépasser 63 caractères.
4. Saisissez éventuellement une Description pour l'instance de connexion.
5. Compte de service : sélectionnez un compte de service disposant des rôles requis.
6. Vous pouvez également configurer les paramètres du nœud de connexion :
  - Nombre minimal de nœuds : saisissez le nombre minimal de nœuds de connexion.
  - Nombre maximal de nœuds : saisissez le nombre maximal de nœuds de connexion.
  Un nœud est une unité (ou instance répliquée) de connexion qui traite des transactions. Un plus grand nombre de nœuds est nécessaire afin de traiter plus de transactions pour une connexion. À l'inverse, moins de nœuds sont nécessaires pour traiter moins de transactions. Pour comprendre l'impact des nœuds sur la tarification de votre connecteur, consultez la section Tarifs des nœuds de connexion. Si vous ne saisissez aucune valeur, le nombre minimal de nœuds est défini par défaut sur 2 (pour une meilleure disponibilité) et le nombre maximal sur 50.
7. ID du projet : ID de projet Google Cloud où réside l'instance Pub/Sub.
8. ID du sujet: vous pouvez éventuellement saisir le nom du sujet Pub/Sub dans lequel le message doit être publié.
  Si vous ne spécifiez pas de nom de sujet ici, vous pouvez spécifier le sujet au moment de l'exécution en configurant le paramètre topic dans l'action PublishMessage.
9. Vous pouvez également cliquer sur + AJOUTER UN LIBELLÉ pour ajouter un libellé à la connexion sous la forme d'une paire clé/valeur.
10. Cliquez sur NEXT (Suivant).
Dans la section Authentification, saisissez les informations d'authentification.
1. La connexion Pub/Sub ne nécessite aucune authentification.
2. Cliquez sur NEXT (Suivant).
Vérifiez vos informations de connexion et d'authentification.
Cliquez sur Créer.

Entités, opérations et actions

Tous les connecteurs Integration Connectors fournissent une couche d'abstraction pour les objets de l'application connectée. Vous ne pouvez accéder aux objets d'une application que via cette abstraction. L'abstraction vous est présentée en tant qu'entités, opérations et actions.

Entité : une entité peut être considérée comme un objet ou un ensemble de propriétés dans l'application ou le service connecté. La définition d'une entité diffère d'un connecteur à l'autre. Par exemple, dans un connecteur de base de données, les tables sont les entités, dans un connecteur de serveur de fichiers, les dossiers sont les entités et, dans un connecteur de système de messagerie, les files d'attente sont les entités.
Toutefois, il est possible qu'un connecteur ne soit pas compatible ou ne possède aucune entité. Dans ce cas, la liste Entities est vide.
Opération : une opération est l'activité que vous pouvez effectuer sur une entité. Vous pouvez effectuer l'une des opérations suivantes sur une entité :
- Liste
- Obtenir
- Créer
- Mettre à jour
- Supprimer
La sélection d'une entité dans la liste disponible génère une liste d'opérations disponibles pour l'entité. Pour obtenir une description détaillée des opérations, consultez les opérations d'entité de la tâche de connecteur. Toutefois, si un connecteur n'est compatible avec aucune des opérations d'entité, celles-ci ne sont pas répertoriées dans la liste Operations.
Action : une action est une fonction de première classe mise à la disposition de l'intégration via l'interface du connecteur. Une action vous permet de modifier une ou plusieurs entités, et varie d'un connecteur à l'autre. Toutefois, il est possible qu'un connecteur ne prenne en charge aucune action, auquel cas la liste Actions est vide.

Limites du système

Le connecteur Pub/Sub peut traiter un maximum de 27 transactions par seconde et par nœud, et limite les transactions au-delà de cette limite. Par défaut, Integration Connectors alloue deux nœuds par connexion (pour une meilleure disponibilité).

Pour en savoir plus sur les limites applicables à Integration Connectors, consultez la section Limites.

Remarque:Le nombre de nœuds Integration Connectors évolue automatiquement de manière dynamique en fonction de votre utilisation. Toutefois, si vous souhaitez réserver de la capacité pour de grands volumes sans attendre l'autoscaling, vous pouvez ajuster la valeur minimale du nœud pour une connexion. Un plus grand nombre de nœuds est nécessaire afin de traiter davantage de transactions pour une connexion. À l'inverse, moins de nœuds sont nécessaires si une connexion traite moins de transactions. Pour configurer les valeurs du nœud, procédez comme suit :

Si vous utilisez le paiement à l'usage, configurez les valeurs minimale et maximale de nœud sur la page de modification de la connexion.
Si vous avez souscrit un abonnement, contactez l'assistance.

Le nombre maximal de transactions qu'un nœud peut gérer dépend de plusieurs facteurs. Par conséquent, avant d'ajuster le nombre minimal de nœuds pour améliorer le débit, il est recommandé de vérifier si vos systèmes backend sont configurés de manière optimale pour gérer le trafic requis.

Actions

Cette section décrit les actions compatibles avec le connecteur Pub/Sub.

Action PublishMessage

Cette action publie un message dans un sujet Pub/Sub. Le tableau suivant décrit les paramètres d'entrée de l'action PublishMessage.

Nom du paramètre	Requis	Type de données	Description
sujet	Non	Chaîne	Nom du sujet dans lequel vous souhaitez publier le message.
message	Oui	Chaîne	Message que vous souhaitez publier. Le message doit être un fichier JSON concaténé, et la taille de message maximale acceptée est de 10 Mo.
attributes (attributs)	Non	Chaîne	Métadonnées personnalisées (sous forme de chaînes JSON concaténées) sous forme de paires clé/valeur.

Remarque : Les résultats de toutes les opérations et actions d'entité seront disponibles sous forme de réponse JSON dans le paramètre de réponse connectorOutputPayload de la tâche de connecteur après avoir exécuté votre intégration.

Validation du schéma pour les messages

Lorsque vous créez un sujet dans Pub/Sub, vous pouvez choisir de lui attribuer un schéma nouveau ou existant. Pour en savoir plus, consultez la page Créer et gérer des schémas dans Pub/Sub. Si vous avez attribué un schéma à un sujet, vos messages publiés sont automatiquement validés par rapport au schéma. Si un message ne confirme pas dans le schéma, il n'est pas publié.

Examples

Les exemples de cette section décrivent les opérations suivantes :

Publier un message dans un thème

Le tableau suivant fournit une liste d'exemples de scénarios et la configuration correspondante dans la tâche de connecteur :

Tâche Configuration

Publier un message dans un thème

Tâche	Configuration
Publier un message dans un thème	Dans la boîte de dialogue `Configure connector task`, cliquez sur `Actions`. Sélectionnez l'action `PublishMessage`, puis cliquez sur OK. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur `connectorInputPayload`, puis saisissez une valeur semblable à la suivante dans le champ `Default Value` : {"message" : "This is a test message.", "topic":"mytopic", "attributes":"{\"key1\":\"value1\"}"} Cliquez sur Enregistrer. Cet exemple publie le `message` spécifié dans le sujet `mytopic`. L'exécution de cet exemple renvoie une réponse semblable à celle-ci dans la variable de sortie `connectorOutputPayload` de la tâche de connecteur: {"messageIds": [ "7865292560686229"]}

Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
Sélectionnez l'action PublishMessage, puis cliquez sur OK.
Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :
```
{"message" : "This is a test message.",
"topic":"mytopic",
"attributes":"{\"key1\":\"value1\"}"}
```
Cliquez sur Enregistrer.

Cet exemple publie le message spécifié dans le sujet mytopic.

L'exécution de cet exemple renvoie une réponse semblable à celle-ci dans la variable de sortie connectorOutputPayload de la tâche de connecteur:


{"messageIds": [
"7865292560686229"]}

Utiliser Terraform pour créer des connexions

Vous pouvez utiliser la ressource Terraform pour créer une connexion.

Pour savoir comment appliquer ou supprimer une configuration Terraform, consultez la page Commandes Terraform de base.

Pour voir un exemple de modèle Terraform pour créer des connexions, consultez cet exemple de modèle.

Lorsque vous créez cette connexion à l'aide de Terraform, vous devez définir les variables suivantes dans votre fichier de configuration Terraform:

Nom du paramètre	Type de données	Requis	Description
project_id	STRING	Vrai	ID du projet Google Cloud où réside l'instance Pub/Sub.
topic_id	STRING	Faux	Nom du sujet Pub/Sub dans lequel le message doit être publié.

Utiliser la connexion Pub/Sub dans une intégration

Une fois la connexion créée, elle devient disponible dans Apigee Integration et Application Integration. Vous pouvez utiliser la connexion dans une intégration via la tâche "Connecteurs".

Pour découvrir comment créer et utiliser la tâche "Connecteurs" dans Apigee Integration, consultez la page Tâche Connecteurs.
Pour découvrir comment créer et utiliser la tâche "Connecteurs" dans Application Integration, consultez la section Tâche Connecteurs.

Obtenir de l'aide auprès de la communauté Google Cloud

Vous pouvez publier vos questions et discuter de ce connecteur sur les forums Cloud de la communauté Google Cloud.

Étapes suivantes

Découvrez comment suspendre et réactiver une connexion.
Découvrez comment surveiller l'utilisation des connecteurs.
Découvrez comment afficher les journaux d'un connecteur.