Extension Google Cloud Pub/Sub

Vous consultez la documentation d'Apigee Edge.
Accédez à la documentation sur Apigee X. info

Version: 1.2.0

Publiez des messages dans un sujet du service Google Cloud Pub/Sub.

Ce contenu fournit une documentation de référence pour configurer et utiliser cette extension.

Prérequis

Avant d'utiliser cette extension à partir d'un proxy d'API, vous devez:

1. Créez un sujet Cloud Pub/Sub, comme décrit dans le guide de démarrage rapide: Utiliser la console.

2. Une fois que vous avez le sujet, accordez l'autorisation de publier dans votre sujet Cloud Pub/Sub. Par exemple, vous pouvez utiliser le rôle roles/pubsub.publisher pour publier dans des sujets. Pour en savoir plus sur les rôles Cloud Pub/Sub, consultez la page Contrôle des accès.

3. Générez une clé pour le compte de service à l'aide de la console GCP.

4. Utilisez le contenu du fichier JSON de clé généré lorsque vous ajoutez et configurez l'extension à l'aide de la référence de configuration.

À propos de Cloud Pub/Sub

Cloud Pub/Sub fournit une messagerie asynchrone de type plusieurs à plusieurs, qui dissocie les expéditeurs et les destinataires. Cloud Pub/Sub fournit une messagerie durable à faible latence qui aide les développeurs à intégrer rapidement les systèmes hébergés sur Google Cloud Platform et en externe.

Si vous débutez avec Cloud Pub/Sub, consultez les guides de démarrage rapide dans la documentation Cloud Pub/Sub.

Exemples

Les exemples suivants montrent comment configurer la prise en charge des actions d'extension Cloud Pub/Sub à l'aide de la règle ExtensionCallout.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ConnectorCallout async="false" continueOnError="true" enabled="true" name="Publish-Message">
    <DisplayName>Publish Message</DisplayName>
    <Connector>cloud-pub-sub-extension-example</Connector>
    <Action>publish</Action>
    <Input><![CDATA[
      {
          "message" : "My test message."
      }
    ]]></Input>
    <Output>topic.message.id</Output>
</ConnectorCallout>

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AssignMessage async="false" continueOnError="false" enabled="true" name="Get-Topic-Message-ID">
    <DisplayName>Get Topic Message ID</DisplayName>
    <AssignTo type="response" createNew="false"/>
    <Set>
        <Payload contentType="application/json">{topic.message.id}</Payload>
    </Set>
</AssignMessage>

{"messageId":"165918654986954"}

Actions

publier

Publie un message dans le sujet spécifié dans la configuration de cette extension.

<Action>publish</Action>
<Input><![CDATA[{
  "message" : "message-to-publish"
}]]></Input>

<Action>publish</Action>
<Input><![CDATA[
  {
      "message" : "My test message."
  }
]]></Input>

Paramètres de requête

Réponse

JSON contenant l'ID du message tel qu'il a été publié sur le sujet. Exemple :

{"messageId":"165918654986954"}

Documentation de référence sur la configuration

Utilisez les éléments suivants lorsque vous configurez et déployez cette extension pour l'utiliser dans des proxys d'API.

Propriétés d'extension courantes

Les propriétés suivantes sont présentes pour chaque extension.

Propriétés de ce package d'extension