camel-google-pubsub-kafka-connector sink configuration

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

When using camel-google-pubsub-kafka-connector as sink make sure to use the following Maven dependency to have support for the connector:

<dependency>
  <groupId>org.apache.camel.kafkaconnector</groupId>
  <artifactId>camel-google-pubsub-kafka-connector</artifactId>
  <version>x.x.x</version>
  <!-- use the same version as your Camel Kafka connector version -->
</dependency>

To use this Sink connector in Kafka connect you’ll need to set the following connector.class

connector.class=org.apache.camel.kafkaconnector.googlepubsub.CamelGooglepubsubSinkConnector

The camel-google-pubsub sink connector supports 19 options, which are listed below.

Name Description Default Required Priority

camel.sink.path.projectId

The Google Cloud PubSub Project Id

null

true

HIGH

camel.sink.path.destinationName

The Destination Name. For the consumer this will be the subscription name, while for the producer this will be the topic name.

null

true

HIGH

camel.sink.endpoint.ackMode

AUTO = exchange gets ack’ed/nack’ed on completion. NONE = downstream process has to ack/nack explicitly One of: [AUTO] [NONE]

"AUTO"

false

MEDIUM

camel.sink.endpoint.concurrentConsumers

The number of parallel streams consuming from the subscription

"1"

false

MEDIUM

camel.sink.endpoint.loggerId

Logger ID to use when a match to the parent route required

null

false

MEDIUM

camel.sink.endpoint.maxMessagesPerPoll

The max number of messages to receive from the server in a single API call

"1"

false

MEDIUM

camel.sink.endpoint.serviceAccountKey

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.

null

true

HIGH

camel.sink.endpoint.synchronousPull

Synchronously pull batches of messages

false

false

MEDIUM

camel.sink.endpoint.lazyStartProducer

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

false

MEDIUM

camel.sink.endpoint.messageOrderingEnabled

Should message ordering be enabled

false

false

MEDIUM

camel.sink.endpoint.pubsubEndpoint

Pub/Sub endpoint to use. Required when using message ordering, and ensures that messages are received in order even when multiple publishers are used

null

false

MEDIUM

camel.sink.endpoint.serializer

A custom GooglePubsubSerializer to use for serializing message payloads in the producer

null

false

MEDIUM

camel.component.google-pubsub.endpoint

Endpoint to use with local Pub/Sub emulator.

null

false

MEDIUM

camel.component.google-pubsub.serviceAccountKey

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.

null

true

HIGH

camel.component.google-pubsub.lazyStartProducer

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

false

MEDIUM

camel.component.google-pubsub.publisherCacheSize

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

null

false

MEDIUM

camel.component.google-pubsub.publisherCache Timeout

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

null

false

MEDIUM

camel.component.google-pubsub.autowiredEnabled

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

false

MEDIUM

camel.component.google-pubsub.publisherTermination Timeout

How many milliseconds should a producer be allowed to terminate.

null

false

MEDIUM

The camel-google-pubsub sink connector has no converters out of the box.

The camel-google-pubsub sink connector has no transforms out of the box.

The camel-google-pubsub sink connector has no aggregation strategies out of the box.

Back to top