Configure a Cloud Pub/Sub connection

You're viewing Apigee X documentation.
View Apigee Edge documentation.

The Cloud Pub/Sub Connector type lets you publish messages to a topic in Cloud Pub/Sub. The Cloud Pub/Sub connection can be configured to publish messages using task outputs in Apigee Integration.

This page provides a reference for configuring a Cloud Pub/Sub connection and using the Cloud Pub/Sub connection with Apigee Integration.

About Cloud Pub/Sub

Cloud Pub/Sub provides many-to-many, asynchronous messaging that decouples senders and receivers. Cloud Pub/Sub delivers low-latency, durable messaging that helps developers quickly integrate systems hosted on Google Cloud and external platforms.

If you are new to Cloud Pub/Sub, try one of the Cloud Pub/Sub Quickstarts.

Before you begin

Before creating a Cloud Pub/Sub connection to use in your integration, do the following:

Enable required services

Connectors requires that you enable the following Google services:

Name Title
apigee.googleapis.com Apigee API
secretmanager.googleapis.com Secret Manager API
connectors.googleapis.com Connector Platform API

If these services have not been enabled for your project previously, you will be prompted to enable them before using the Connectors UI.

Create a Cloud Pub/Sub connection

To configure a Connection:

  1. In the Cloud console, go to Apigee > Connectors page and select or create a Google Cloud project.

    Go to the Connections page

  2. Click + CREATE NEW to open the Create Connection page.
  3. Configure the connection:
    1. In the Create Connection section, complete the following:
      • Connector: Select the Connector type from the drop down list of available Connector types. For this example, select gcp > pubsub.
      • Connector version: Select the Connector version from the drop down list of available versions.
      • In the Connection Name field, enter a name for the Connection instance.

        Connection names must meet the following criteria:

        • Connection names can use letters, numbers, or hyphens.
        • Letters must be lower-case.
        • Connection names must begin with a letter and end with a letter or number.
        • Connection names cannot exceed 63 characters.
      • Optionally, add a Description of the connection instance.
      • Project ID: Enter the of the Google Cloud project where the Cloud Pub/Sub instance resides.
      • Topic ID: Enter the name of the Cloud Pub/Sub topic where the message should be published.
      • Optionally, click + ADD LABEL to add a label to the Connection in the form of a key/value pair.
      • Click NEXT.
    2. Location: Choose the location for the connection.
      • Select a location where Apigee is available from the Region drop-down list.

        Supported regions for Connectors include:

        • us-central1
        • us-east1
        • us-west1
        • europe-west1
        • asia-east1
      • Click NEXT.
    3. Authentication: Provide authentication credentials for your connection instance, if required. The Cloud Pub/Sub connection does not require authentication configuration.
    4. Click NEXT.
    5. Review: Review your connections's configuration details. In this section, the Connection details and Authentication details of the new connection are displayed for your review.
  4. Click Create.

Create a Connectors task with a Cloud Pub/Sub connection

To configure the Connectors task in Apigee Integration to use the Cloud Pub/Sub connection:

  1. Go to the Apigee UI and sign in.
  2. Select your organization using the drop-down menu in the upper left corner of the UI.
  3. Click Develop > Integrations.
  4. Search for or select the integration to edit from the Integrations list and click to open the integration designer.
  5. Click +Add a task/trigger > Tasks to view the list of available tasks.
  6. Drag the Connectors task element to the integration designer.
  7. Click the Connectors task element on the designer to view the Connectors task configuration pane.
  8. Optionally, click the to edit the task name. This enables you to change the task name from the generic Connectors to a meaningful name for your integration.
  9. On the Configuration tab in the Configuration section, click the Configure task button to open the Configure connector task pane.
    1. In the Connection column, choose the Cloud Pub/Sub connection you created in a previous step from the list of available connections.
    2. Once a connection is chosen, the Type column appears. For this example, select Actions and then publishMessage from the list of available actions.
      • An Entity can be thought of as an object, or a collection of properties, in the connected application or service, that can be exposed to an integration through the Connector interface. The Cloud Pub/Sub connection does not expose any entities.
      • An Action is a first class function that is made available to the integration through the Connector interface. Functions are defined in the connected application or service and define a change or series of changes that can be made to an entity or entities. The Cloud Pub/Sub connection has one available Action
    3. Click Done to complete the connection configuration and close the pane.
  10. The Connectors task configuration pane for a Cloud Pub/Sub connection also displays Task Input variables and Task Output variable automatically generated by the Entity and Operation or Action selected in the previous step for use in the connection. These variables are accessible as inputs to the current task or outputs to subsequent tasks or conditionals configured in the current integration.

    To configure the Task Input or Task Output:

    1. Click on the Connector input payload or Connector output payload variable pill to open the Configure Variable pane.
    2. Configure the JSON payload or default value as desired.
    3. Select the Use as an input to integration checkbox or the Use as an output to integration, as desired.
    4. Click Save.
  11. You can configure various retry strategies to handle errors in a task. The retry strategies allow you to specify how to rerun the task in case of an error. For more information, see Error handling strategies.