| // kafka-connector options: START |
| [[camel-pulsar-kafka-connector-source]] |
| = camel-pulsar-kafka-connector source configuration |
| |
| When using camel-pulsar-kafka-connector as source make sure to use the following Maven dependency to have support for the connector: |
| |
| [source,xml] |
| ---- |
| <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> |
| ---- |
| |
| |
| The camel-pulsar source connector supports 25 options, which are listed below. |
| |
| |
| |
| [width="100%",cols="2,5,^1,2",options="header"] |
| |=== |
| | Name | Description | Default | Priority |
| | *camel.source.path.persistence* | Whether the topic is persistent or non-persistent One of: [persistent] [non-persistent] | null | ConfigDef.Importance.HIGH |
| | *camel.source.path.tenant* | The tenant | null | ConfigDef.Importance.HIGH |
| | *camel.source.path.namespace* | The namespace | null | ConfigDef.Importance.HIGH |
| | *camel.source.path.topic* | The topic | null | ConfigDef.Importance.HIGH |
| | *camel.source.endpoint.ackGroup TimeMillis* | Group the consumer acknowledgments for the specified time in milliseconds - defaults to 100 | 100L | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.ack TimeoutMillis* | Timeout for unacknowledged messages in milliseconds - defaults to 10000 | 10000L | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.allow ManualAcknowledgement* | Whether to allow manual message acknowledgements. If this option is enabled, then messages are not immediately acknowledged after being consumed. Instead, an instance of PulsarMessageReceipt is stored as a header on the org.apache.camel.Exchange. Messages can then be acknowledged using PulsarMessageReceipt at any time before the ackTimeout occurs. | false | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.bridge ErrorHandler* | 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 | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.consumer Name* | Name of the consumer when subscription is EXCLUSIVE | "sole-consumer" | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.consumer NamePrefix* | Prefix to add to consumer names when a SHARED or FAILOVER subscription is used | "cons" | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.consumer QueueSize* | Size of the consumer queue - defaults to 10 | 10 | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.numberOf Consumers* | Number of consumers - defaults to 1 | 1 | ConfigDef.Importance.MEDIUM |
| | * camel.source.endpoint.subscription InitialPosition* | Control the initial position in the topic of a newly created subscription. Default is latest message. One of: [EARLIEST] [LATEST] | "LATEST" | ConfigDef.Importance.MEDIUM |
| | * camel.source.endpoint.subscription Name* | Name of the subscription to use | "subs" | ConfigDef.Importance.MEDIUM |
| | * camel.source.endpoint.subscription Type* | Type of the subscription EXCLUSIVESHAREDFAILOVER, defaults to EXCLUSIVE One of: [EXCLUSIVE] [SHARED] [FAILOVER] | "EXCLUSIVE" | ConfigDef.Importance.MEDIUM |
| | * camel.source.endpoint.exception Handler* | 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. | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.exchange Pattern* | Sets the exchange pattern when the consumer creates an exchange. One of: [InOnly] [InOut] [InOptionalOut] | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.basic PropertyBinding* | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | ConfigDef.Importance.MEDIUM |
| | * camel.source.endpoint.synchronous* | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | ConfigDef.Importance.MEDIUM |
| | *camel.component.pulsar.allow ManualAcknowledgement* | Whether to allow manual message acknowledgements. If this option is enabled, then messages are not immediately acknowledged after being consumed. Instead, an instance of PulsarMessageReceipt is stored as a header on the org.apache.camel.Exchange. Messages can then be acknowledged using PulsarMessageReceipt at any time before the ackTimeout occurs. | false | ConfigDef.Importance.MEDIUM |
| | *camel.component.pulsar.bridge ErrorHandler* | 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 | ConfigDef.Importance.MEDIUM |
| | *camel.component.pulsar.pulsar MessageReceiptFactory* | Provide a factory to create an alternate implementation of PulsarMessageReceipt. | null | ConfigDef.Importance.MEDIUM |
| | *camel.component.pulsar.auto Configuration* | The pulsar auto configuration | null | ConfigDef.Importance.MEDIUM |
| | *camel.component.pulsar.basic PropertyBinding* | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | ConfigDef.Importance.MEDIUM |
| | *camel.component.pulsar.pulsar Client* | The pulsar client | null | ConfigDef.Importance.MEDIUM |
| |=== |
| // kafka-connector options: END |
