camel-pulsar-kafka-connector sink configuration
Connector Description: Send and receive messages from/to Apache Pulsar messaging system.
When using camel-pulsar-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-pulsar-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.pulsar.CamelPulsarSinkConnectorThe camel-pulsar sink connector supports 36 options, which are listed below.
| Name | Description | Default | Required | Priority |
|---|---|---|---|---|
camel.sink.path.persistence |
Whether the topic is persistent or non-persistent One of: [persistent] [non-persistent] |
null |
true |
HIGH |
camel.sink.path.tenant |
The tenant |
null |
true |
HIGH |
camel.sink.path.namespace |
The namespace |
null |
true |
HIGH |
camel.sink.path.topic |
The topic |
null |
true |
HIGH |
camel.sink.endpoint.batcherBuilder |
Control batching method used by the producer. |
"DEFAULT" |
false |
MEDIUM |
camel.sink.endpoint.batchingEnabled |
Control whether automatic batching of messages is enabled for the producer. |
true |
false |
MEDIUM |
camel.sink.endpoint.batchingMaxMessages |
The maximum size to batch messages. |
1000 |
false |
MEDIUM |
camel.sink.endpoint.batchingMaxPublishDelayMicros |
The maximum time period within which the messages sent will be batched if batchingEnabled is true. |
1000L |
false |
MEDIUM |
camel.sink.endpoint.blockIfQueueFull |
Whether to block the producing thread if pending messages queue is full or to throw a ProducerQueueIsFullError |
false |
false |
MEDIUM |
camel.sink.endpoint.compressionType |
Compression type to use One of: [NONE] [LZ4] [ZLIB] [ZSTD] [SNAPPY] |
"NONE" |
false |
MEDIUM |
camel.sink.endpoint.initialSequenceId |
The first message published will have a sequence Id of initialSequenceId 1. |
-1L |
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.maxPendingMessages |
Size of the pending massages queue. When the queue is full, by default, any further sends will fail unless blockIfQueueFull=true |
1000 |
false |
MEDIUM |
camel.sink.endpoint.maxPendingMessagesAcross Partitions |
The maximum number of pending messages for partitioned topics. The maxPendingMessages value will be reduced if (number of partitions maxPendingMessages) exceeds this value. Partitioned topics have a pending message queue for each partition. |
50000 |
false |
MEDIUM |
camel.sink.endpoint.messageRouter |
Custom Message Router to use |
null |
false |
MEDIUM |
camel.sink.endpoint.messageRoutingMode |
Message Routing Mode to use One of: [SinglePartition] [RoundRobinPartition] [CustomPartition] |
"RoundRobinPartition" |
false |
MEDIUM |
camel.sink.endpoint.producerName |
Name of the producer. If unset, lets Pulsar select a unique identifier. |
null |
false |
MEDIUM |
camel.sink.endpoint.sendTimeoutMs |
Send timeout in milliseconds |
30000 |
false |
MEDIUM |
camel.component.pulsar.configuration |
Allows to pre-configure the Pulsar component with common options that the endpoints will reuse. |
null |
false |
MEDIUM |
camel.component.pulsar.batcherBuilder |
Control batching method used by the producer. |
"DEFAULT" |
false |
MEDIUM |
camel.component.pulsar.batchingEnabled |
Control whether automatic batching of messages is enabled for the producer. |
true |
false |
MEDIUM |
camel.component.pulsar.batchingMaxMessages |
The maximum size to batch messages. |
1000 |
false |
MEDIUM |
camel.component.pulsar.batchingMaxPublishDelay Micros |
The maximum time period within which the messages sent will be batched if batchingEnabled is true. |
1000L |
false |
MEDIUM |
camel.component.pulsar.blockIfQueueFull |
Whether to block the producing thread if pending messages queue is full or to throw a ProducerQueueIsFullError |
false |
false |
MEDIUM |
camel.component.pulsar.compressionType |
Compression type to use One of: [NONE] [LZ4] [ZLIB] [ZSTD] [SNAPPY] |
"NONE" |
false |
MEDIUM |
camel.component.pulsar.initialSequenceId |
The first message published will have a sequence Id of initialSequenceId 1. |
-1L |
false |
MEDIUM |
camel.component.pulsar.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.pulsar.maxPendingMessages |
Size of the pending massages queue. When the queue is full, by default, any further sends will fail unless blockIfQueueFull=true |
1000 |
false |
MEDIUM |
camel.component.pulsar.maxPendingMessagesAcross Partitions |
The maximum number of pending messages for partitioned topics. The maxPendingMessages value will be reduced if (number of partitions maxPendingMessages) exceeds this value. Partitioned topics have a pending message queue for each partition. |
50000 |
false |
MEDIUM |
camel.component.pulsar.messageRouter |
Custom Message Router to use |
null |
false |
MEDIUM |
camel.component.pulsar.messageRoutingMode |
Message Routing Mode to use One of: [SinglePartition] [RoundRobinPartition] [CustomPartition] |
"RoundRobinPartition" |
false |
MEDIUM |
camel.component.pulsar.producerName |
Name of the producer. If unset, lets Pulsar select a unique identifier. |
null |
false |
MEDIUM |
camel.component.pulsar.sendTimeoutMs |
Send timeout in milliseconds |
30000 |
false |
MEDIUM |
camel.component.pulsar.autoConfiguration |
The pulsar auto configuration |
null |
false |
MEDIUM |
camel.component.pulsar.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.pulsar.pulsarClient |
The pulsar client |
null |
false |
MEDIUM |
The camel-pulsar sink connector has no converters out of the box.
The camel-pulsar sink connector has no transforms out of the box.
The camel-pulsar sink connector has no aggregation strategies out of the box.