2 Home
gitea_admin edited this page 2026-03-11 14:38:24 +00:00

Google Pubsub

Send and receive messages to/from Google Cloud Platform PubSub Service.

Metadata

Property Value
Scheme google-pubsub
Support Level Stable
Labels cloud,messaging
Version 4.10.2

Maven Dependency

<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-google-pubsub</artifactId>
    <version>4.10.2</version>
</dependency>

Endpoint Properties

Name Type Required Default Description
projectId string The Google Cloud PubSub Project Id
destinationName string The Destination Name. For the consumer this will be the subscription name, while for the producer this will be the topic name.
authenticate boolean true Use Credentials when interacting with PubSub service (no authentication is required when using emulator).
loggerId string Logger ID to use when a match to the parent route required
serviceAccountKey string The Service account key that can be used as credentials for the PubSub publisher/subscriber. It can be loaded by default from classpath, but you can prefix with classpath:, file:, or http: to load the resource from different systems.
ackMode object AUTO AUTO = exchange gets ack'ed/nack'ed on completion. NONE = downstream process has to ack/nack explicitly
concurrentConsumers integer 1 The number of parallel streams consuming from the subscription
maxAckExtensionPeriod integer 3600 Set the maximum period a message ack deadline will be extended. Value in seconds
maxMessagesPerPoll integer 1 The max number of messages to receive from the server in a single API call
synchronousPull boolean false Synchronously pull batches of messages
bridgeErrorHandler boolean false Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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.
exceptionHandler object 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.
exchangePattern object Sets the exchange pattern when the consumer creates an exchange.
lazyStartProducer boolean false Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.
messageOrderingEnabled boolean false Should message ordering be enabled
pubsubEndpoint string Pub/Sub endpoint to use. Required when using message ordering, and ensures that messages are received in order even when multiple publishers are used
retry object A custom RetrySettings to control how the publisher handles retry-able failures
serializer object A custom GooglePubsubSerializer to use for serializing message payloads in the producer