Google Pubsub

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

What’s inside

Google Pubsub component, URI syntax: google-pubsub:projectId:destinationName

Please refer to the above links for usage and configuration details.

Maven coordinates

<dependency>
    <groupId>org.apache.camel.springboot</groupId>
    <artifactId>camel-google-pubsub-starter</artifactId>
</dependency>

Spring Boot Auto-Configuration

The starter supports 12 options, which are listed below.

Name	Description	Default	Type
camel.component.google-pubsub.authenticate	Use Credentials when interacting with PubSub service (no authentication is required when using emulator).	true	Boolean
camel.component.google-pubsub.autowired-enabled	Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.	true	Boolean
camel.component.google-pubsub.bridge-error-handler	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.	false	Boolean
camel.component.google-pubsub.enabled	Whether to enable auto configuration of the google-pubsub component. This is enabled by default.		Boolean
camel.component.google-pubsub.endpoint	Endpoint to use with local Pub/Sub emulator.		String
camel.component.google-pubsub.header-filter-strategy	To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. The option is a org.apache.camel.spi.HeaderFilterStrategy type.		HeaderFilterStrategy
camel.component.google-pubsub.lazy-start-producer	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.	false	Boolean
camel.component.google-pubsub.publisher-cache-size	Maximum number of producers to cache. This could be increased if you have producers for lots of different topics.		Integer
camel.component.google-pubsub.publisher-cache-timeout	How many milliseconds should each producer stay alive in the cache.		Integer
camel.component.google-pubsub.publisher-termination-timeout	How many milliseconds should a producer be allowed to terminate.		Integer
camel.component.google-pubsub.service-account-key	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.		String
camel.component.google-pubsub.synchronous-pull-retryable-codes	Comma-separated list of additional retryable error codes for synchronous pull. By default the PubSub client library retries ABORTED, UNAVAILABLE, UNKNOWN		String

Name

Description

Default

Type

camel.component.google-pubsub.authenticate

Use Credentials when interacting with PubSub service (no authentication is required when using emulator).

true

Boolean

camel.component.google-pubsub.autowired-enabled

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.

true

Boolean

camel.component.google-pubsub.bridge-error-handler

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.

false

Boolean

camel.component.google-pubsub.enabled

Whether to enable auto configuration of the google-pubsub component. This is enabled by default.

Boolean

camel.component.google-pubsub.endpoint

Endpoint to use with local Pub/Sub emulator.

String

camel.component.google-pubsub.header-filter-strategy

To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. The option is a org.apache.camel.spi.HeaderFilterStrategy type.

HeaderFilterStrategy

camel.component.google-pubsub.lazy-start-producer

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.

false

Boolean

camel.component.google-pubsub.publisher-cache-size

Maximum number of producers to cache. This could be increased if you have producers for lots of different topics.

Integer

camel.component.google-pubsub.publisher-cache-timeout

How many milliseconds should each producer stay alive in the cache.

Integer

camel.component.google-pubsub.publisher-termination-timeout

How many milliseconds should a producer be allowed to terminate.

Integer

camel.component.google-pubsub.service-account-key

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.

String

camel.component.google-pubsub.synchronous-pull-retryable-codes

Comma-separated list of additional retryable error codes for synchronous pull. By default the PubSub client library retries ABORTED, UNAVAILABLE, UNKNOWN

String