RabbitMQ

The RabbitMQ connector provides connectivity to RabbitMQ.

Before you begin

Before using the RabbitMQ connector, do the following tasks:

  • In your Google Cloud project:
    • Grant the roles/connectors.admin IAM role to the user configuring the connector.
    • Grant the following IAM roles to the service account that you want to use for the connector:
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      A service account is a special type of Google account intended to represent a non-human user that needs to authenticate and be authorized to access data in Google APIs. If you don't have a service account, you must create a service account. For more information, see Creating a service account.

    • Enable the following services:
      • secretmanager.googleapis.com (Secret Manager API)
      • connectors.googleapis.com (Connectors API)

      To understand how to enable services, see Enabling services.

    If these services or permissions have not been enabled for your project previously, you are prompted to enable them when configuring the connector.

Configure the connector

Configuring the connector requires you to create a connection to your data source (backend system). A connection is specific to a data source. It means that if you have many data sources, you must create a separate connection for each data source. To create a connection, do the following steps:

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

    Go to the Connections page

  2. Click + CREATE NEW to open the Create Connection page.
  3. In the Location section, choose the location for the connection.
    1. Region: Select a location from the drop-down list.

      For the list of all the supported regions, see Locations.

    2. Click NEXT.
  4. In the Connection Details section, complete the following:
    1. Connector: Select RabbitMQ from the drop down list of available Connectors.
    2. Connector version: Select the Connector version from the drop down list of available versions.
    3. 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.
    4. Optionally, enter a Description for the connection instance.
    5. Service Account: Select a service account that has the required roles.
    6. Optionally, configure the Connection node settings (Preview):

      • Minimum number of nodes: Enter the minimum number of connection nodes.
      • Maximum number of nodes: Enter the maximum number of connection nodes.

      A node is a unit (or replica) of a connection that processes transactions. More nodes are required to process more transactions for a connection and conversely, fewer nodes are required to process fewer transactions. To understand how the nodes affect your connector pricing, see Pricing for connection nodes. If you don't enter any values, by default the minimum nodes are set to 2 (for better availability) and the maximum nodes are set to 50.

    7. Default Queue Name: The name of the default queue, may be overridden when executing action.
    8. Virtual Host: The Virtual host for RabbitMQ.
    9. Optionally, click + ADD LABEL to add a label to the Connection in the form of a key/value pair.
    10. Click NEXT.
  5. In the Destinations section, enter details of the remote host (backend system) you want to connect to.
    1. Destination Type: Select a Destination Type.
      • Host address: Specify the hostname or IP address of the destination.

        If you want to establish private connection to your backend, do the following:

      To enter additional destinations, click +ADD DESTINATION.

    2. Click NEXT.
  6. In the Authentication section, enter the authentication details.
    1. Select an Authentication type and enter the relevant details.

      The following authentication types are supported by the RabbitMQ connection:

      • Anonymous
      • Username and password

      2. To understand how to configure these authentication types, see Configure authentication.

    2. Click NEXT.
  7. Review: Review your connection and authentication details.
  8. Click Create.

Configure authentication

Enter the details based on the authentication you want to use.

  • Anonymous

    If you want to use anonymous login, select Not Available.

  • Username and password
    • Username: The RabbitMQ username to use for the connection.
    • Password: Secret Manager Secret containing the password associated with the RabbitMQ username.

Entities, operations, and actions

All the Integration Connectors provide a layer of abstraction for the objects of the connected application. You can access an application's objects only through this abstraction. The abstraction is exposed to you as entities, operations, and actions.

  • Entity: An entity can be thought of as an object, or a collection of properties, in the connected application or service. The definition of an entity differs from a connector to a connector. For example, in a database connector, tables are the entities, in a file server connector, folders are the entities, and in a messaging system connector, queues are the entities.

    However, it is possible that a connector doesn't support or have any entities, in which case the Entities list will be empty. For example, the Pub/Sub connector doesn't have any entity, but only has the publishMessage action.

  • Operation: An operation is the activity that you can perform on an entity. You can perform any of the following operations on an entity:
    • List
    • Get
    • Create
    • Update
    • Delete

    Selecting an entity from the available list, generates a list of operations available for the entity. For a detailed description of the operations, see the Connectors task's entity operations. However, it is possible that a connector doesn't support any entity operations, in which case the Operations list will be empty.

  • Action: An action is a first class function that is made available to the integration through the connector interface. An action lets you make changes to an entity or entities, and vary from connector to connector. However, it is possible that a connector doesn't support any action, in which case the Actions list will be empty.

Actions

The RabbitMQ connection supports the following actions:

  • sendMessage: Sends a message to a queue.
  • requestReply: Sends a message to a queue and also specifies the response queue where the replier should write the response.

sendMessage action

The following tables describe the input and output parameters of the sendMessage action.

Input parameters of the sendMessage action

Parameter name Required Data type Description
message Yes String Message to be sent to the RabbitMQ queue. Currently, the maximum message size supported is 10 MB.
queueName No String Name of the RabbitMQ queue. If you don't specify a queue name, the default queue name specified during creating the connection is used.
messageContentType Yes String Message content type which you can specify either as Text or Bytes. You must set the type to Bytes if you are sending a binary data.

To send a message in a binary format, you must do the following tasks:

  • Encode the binary message as a Base64 string, and then set the message parameter to the encoded value.
  • Set the messageContentType parameter's value to Bytes.
messageType Yes String Message type which you can specify either as Datagram or Reply.

Output parameters of the sendMessage action

Parameter name Data type Description
messageId String ID of the sent message.

requestReply action

The following tables describe the input and output parameters of the requestReply action.

Input parameters of the requestReply action

Parameter name Required Data type Description
message Yes String Message to be sent to the RabbitMQ queue. The maximum message size supported is 10 MB.
queueName No String Name of the RabbitMQ queue. If you don't specify a queue name, the default queue name specified during creating the connection is used.
messageContentType Yes String Message content type which you can specify either as Text or Bytes. You must set the type to Bytes if you are sending a binary data.

To send a message in a binary format, you must do the following tasks:

  • Encode the binary message as a Base64 string, and then set the message parameter to the encoded value.
  • Set the messageContentType parameter's value to Bytes.
replyToQueue Yes String Queue on which the replier should write the response.
replyTimeout Yes String Time (in milliseconds) till which the connector waits for the response in the response queue. The maximum supported value is 180000 milliseconds (3 minutes).

If the response queue receives a message after the timeout period, then that message isn't processed by the connector. However, you can view the timed out message details in your integration's execution logs.

Output parameters of the requestReply action

Parameter name Data type Description
replyMessage String Response message from the replier.

Use the RabbitMQ connection in an integration

After you create the connection, it becomes available in both Apigee Integration and Application Integration. You can use the connection in an integration through the Connectors task.

  • To understand how to create and use the Connectors task in Apigee Integration, see Connectors task.
  • To understand how to create and use the Connectors task in Application Integration, see Connectors task.