Chapter 123. Google Pubsub Component
Available as of Camel version 2.19
The Google Pubsub component provides access to Cloud Pub/Sub Infrastructure via the Google Client Services API.
The current implementation does not use gRPC.
Maven users will need to add the following dependency to their pom.xml for this component:
<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-google-pubsub</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel core version -->
</dependency>123.1. URI Format
The Google Pubsub Component uses the following URI format:
google-pubsub://project-id:destinationName?[options]
Destination Name can be either a topic or a subscription name.
123.2. Options
The Google Pubsub component supports 2 options, which are listed below.
| Name | Description | Default | Type |
|---|---|---|---|
| connectionFactory (common) | Sets the connection factory to use: provides the ability to explicitly manage connection credentials: - the path to the key file - the Service Account Key / Email pair | GooglePubsubConnection Factory | |
| resolveProperty Placeholders (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean |
The Google Pubsub endpoint is configured using URI syntax:
google-pubsub:projectId:destinationName
with the following path and query parameters:
123.2.1. Path Parameters (2 parameters):
| Name | Description | Default | Type |
|---|---|---|---|
| projectId | Required Project Id | String | |
| destinationName | Required Destination Name | String |
123.2.2. Query Parameters (9 parameters):
| Name | Description | Default | Type |
|---|---|---|---|
| ackMode (common) | AUTO = exchange gets ack’ed/nack’ed on completion. NONE = downstream process has to ack/nack explicitly | AUTO | AckMode |
| concurrentConsumers (common) | The number of parallel streams consuming from the subscription | 1 | Integer |
| connectionFactory (common) | ConnectionFactory to obtain connection to PubSub Service. If non provided the default will be used. | GooglePubsubConnection Factory | |
| loggerId (common) | Logger ID to use when a match to the parent route required | String | |
| maxMessagesPerPoll (common) | The max number of messages to receive from the server in a single API call | 1 | Integer |
| bridgeErrorHandler (consumer) | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. | false | boolean |
| exceptionHandler (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. | ExceptionHandler | |
| exchangePattern (consumer) | Sets the exchange pattern when the consumer creates an exchange. | ExchangePattern | |
| synchronous (advanced) | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | boolean |
123.3. Spring Boot Auto-Configuration
The component supports 2 options, which are listed below.
| Name | Description | Default | Type |
|---|---|---|---|
| camel.component.google-pubsub.enabled | Enable google-pubsub component | true | Boolean |
| camel.component.google-pubsub.resolve-property-placeholders | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | Boolean |
123.4. Producer Endpoints
Producer endpoints can accept and deliver to PubSub individual and grouped exchanges alike. Grouped exchanges have Exchange.GROUPED_EXCHANGE property set.
Google PubSub expects the payload to be byte[] array, Producer endpoints will send:
- String body as byte[] encoded as UTF-8
- byte[] body as is
- Everything else will be serialised into byte[] array
A Map set as message header GooglePubsubConstants.ATTRIBUTES will be sent as PubSub attributes. Once exchange has been delivered to PubSub the PubSub Message ID will be assigned to the header GooglePubsubConstants.MESSAGE_ID.
123.5. Consumer Endpoints
Google PubSub will redeliver the message if it has not been acknowledged within the time period set as a configuration option on the subscription.
The component will acknowledge the message once exchange processing has been completed.
If the route throws an exception, the exchange is marked as failed and the component will NACK the message - it will be redelivered immediately.
To ack/nack the message the component uses Acknowledgement ID stored as header GooglePubsubConstants.ACK_ID. If the header is removed or tampered with, the ack will fail and the message will be redelivered again after the ack deadline.
123.6. Message Headers
Headers set by the consumer endpoints:
- GooglePubsubConstants.MESSAGE_ID
- GooglePubsubConstants.ATTRIBUTES
- GooglePubsubConstants.PUBLISH_TIME
- GooglePubsubConstants.ACK_ID
123.7. Message Body
The consumer endpoint returns the content of the message as byte[] - exactly as the underlying system sends it. It is up for the route to convert/unmarshall the contents.
123.8. Authentication Configuration
Google Pubsub component authentication is targeted for use with the GCP Service Accounts. For more information please refer to Google Cloud Platform Auth Guide
Google security credentials can be set explicitly via one of the two options:
- Service Account Email and Service Account Key (PEM format)
- GCP credentials file location
If both are set, the Service Account Email/Key will take precedence.
Or implicitly, where the connection factory falls back on Application Default Credentials.
OBS! The location of the default credentials file is configurable - via GOOGLE_APPLICATION_CREDENTIALS environment variable.
Service Account Email and Service Account Key can be found in the GCP JSON credentials file as client_email and private_key respectively.
123.9. Rollback and Redelivery
The rollback for Google PubSub relies on the idea of the Acknowledgement Deadline - the time period where Google PubSub expects to receive the acknowledgement. If the acknowledgement has not been received, the message is redelivered.
Google provides an API to extend the deadline for a message.
More information in Google PubSub Documentation
So, rollback is effectively a deadline extension API call with zero value - i.e. deadline is reached now and message can be redelivered to the next consumer.
It is possible to delay the message redelivery by setting the acknowledgement deadline explicitly for the rollback by setting the message header GooglePubsubConstants.ACK_DEADLINE to the value in seconds.
