Interface PulsarComponentBuilderFactory.PulsarComponentBuilder
-
- All Superinterfaces:
ComponentBuilder<org.apache.camel.component.pulsar.PulsarComponent>
- All Known Implementing Classes:
PulsarComponentBuilderFactory.PulsarComponentBuilderImpl
- Enclosing interface:
- PulsarComponentBuilderFactory
public static interface PulsarComponentBuilderFactory.PulsarComponentBuilder extends ComponentBuilder<org.apache.camel.component.pulsar.PulsarComponent>
Builder for the Pulsar component.
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default PulsarComponentBuilderFactory.PulsarComponentBuilder
ackGroupTimeMillis(long ackGroupTimeMillis)
Group the consumer acknowledgments for the specified time in milliseconds - defaults to 100.default PulsarComponentBuilderFactory.PulsarComponentBuilder
ackTimeoutMillis(long ackTimeoutMillis)
Timeout for unacknowledged messages in milliseconds - defaults to 10000.default PulsarComponentBuilderFactory.PulsarComponentBuilder
allowManualAcknowledgement(boolean allowManualAcknowledgement)
Whether to allow manual message acknowledgements.default PulsarComponentBuilderFactory.PulsarComponentBuilder
autoConfiguration(org.apache.camel.component.pulsar.utils.AutoConfiguration autoConfiguration)
The pulsar auto configuration.default PulsarComponentBuilderFactory.PulsarComponentBuilder
autowiredEnabled(boolean autowiredEnabled)
Whether autowiring is enabled.default PulsarComponentBuilderFactory.PulsarComponentBuilder
batcherBuilder(org.apache.pulsar.client.api.BatcherBuilder batcherBuilder)
Control batching method used by the producer.default PulsarComponentBuilderFactory.PulsarComponentBuilder
batchingEnabled(boolean batchingEnabled)
Control whether automatic batching of messages is enabled for the producer.default PulsarComponentBuilderFactory.PulsarComponentBuilder
batchingMaxMessages(int batchingMaxMessages)
The maximum size to batch messages.default PulsarComponentBuilderFactory.PulsarComponentBuilder
batchingMaxPublishDelayMicros(long batchingMaxPublishDelayMicros)
The maximum time period within which the messages sent will be batched if batchingEnabled is true.default PulsarComponentBuilderFactory.PulsarComponentBuilder
blockIfQueueFull(boolean blockIfQueueFull)
Whether to block the producing thread if pending messages queue is full or to throw a ProducerQueueIsFullError.default PulsarComponentBuilderFactory.PulsarComponentBuilder
bridgeErrorHandler(boolean bridgeErrorHandler)
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.default PulsarComponentBuilderFactory.PulsarComponentBuilder
compressionType(org.apache.pulsar.client.api.CompressionType compressionType)
Compression type to use.default PulsarComponentBuilderFactory.PulsarComponentBuilder
configuration(org.apache.camel.component.pulsar.PulsarConfiguration configuration)
Allows to pre-configure the Pulsar component with common options that the endpoints will reuse.default PulsarComponentBuilderFactory.PulsarComponentBuilder
consumerName(String consumerName)
Name of the consumer when subscription is EXCLUSIVE.default PulsarComponentBuilderFactory.PulsarComponentBuilder
consumerNamePrefix(String consumerNamePrefix)
Prefix to add to consumer names when a SHARED or FAILOVER subscription is used.default PulsarComponentBuilderFactory.PulsarComponentBuilder
consumerQueueSize(int consumerQueueSize)
Size of the consumer queue - defaults to 10.default PulsarComponentBuilderFactory.PulsarComponentBuilder
deadLetterTopic(String deadLetterTopic)
Name of the topic where the messages which fail maxRedeliverCount times will be sent.default PulsarComponentBuilderFactory.PulsarComponentBuilder
initialSequenceId(long initialSequenceId)
The first message published will have a sequence Id of initialSequenceId 1.default PulsarComponentBuilderFactory.PulsarComponentBuilder
lazyStartProducer(boolean lazyStartProducer)
Whether the producer should be started lazy (on the first message).default PulsarComponentBuilderFactory.PulsarComponentBuilder
maxPendingMessages(int maxPendingMessages)
Size of the pending massages queue.default PulsarComponentBuilderFactory.PulsarComponentBuilder
maxPendingMessagesAcrossPartitions(int maxPendingMessagesAcrossPartitions)
The maximum number of pending messages for partitioned topics.default PulsarComponentBuilderFactory.PulsarComponentBuilder
maxRedeliverCount(Integer maxRedeliverCount)
Maximum number of times that a message will be redelivered before being sent to the dead letter queue.default PulsarComponentBuilderFactory.PulsarComponentBuilder
messageRouter(org.apache.pulsar.client.api.MessageRouter messageRouter)
Custom Message Router to use.default PulsarComponentBuilderFactory.PulsarComponentBuilder
messageRoutingMode(org.apache.pulsar.client.api.MessageRoutingMode messageRoutingMode)
Message Routing Mode to use.default PulsarComponentBuilderFactory.PulsarComponentBuilder
negativeAckRedeliveryDelayMicros(long negativeAckRedeliveryDelayMicros)
Set the negative acknowledgement delay.default PulsarComponentBuilderFactory.PulsarComponentBuilder
numberOfConsumers(int numberOfConsumers)
Number of consumers - defaults to 1.default PulsarComponentBuilderFactory.PulsarComponentBuilder
producerName(String producerName)
Name of the producer.default PulsarComponentBuilderFactory.PulsarComponentBuilder
pulsarClient(org.apache.pulsar.client.api.PulsarClient pulsarClient)
The pulsar client.default PulsarComponentBuilderFactory.PulsarComponentBuilder
pulsarMessageReceiptFactory(org.apache.camel.component.pulsar.PulsarMessageReceiptFactory pulsarMessageReceiptFactory)
Provide a factory to create an alternate implementation of PulsarMessageReceipt.default PulsarComponentBuilderFactory.PulsarComponentBuilder
readCompacted(boolean readCompacted)
Enable compacted topic reading.default PulsarComponentBuilderFactory.PulsarComponentBuilder
sendTimeoutMs(int sendTimeoutMs)
Send timeout in milliseconds.default PulsarComponentBuilderFactory.PulsarComponentBuilder
subscriptionInitialPosition(org.apache.camel.component.pulsar.utils.consumers.SubscriptionInitialPosition subscriptionInitialPosition)
Control the initial position in the topic of a newly created subscription.default PulsarComponentBuilderFactory.PulsarComponentBuilder
subscriptionName(String subscriptionName)
Name of the subscription to use.default PulsarComponentBuilderFactory.PulsarComponentBuilder
subscriptionTopicsMode(org.apache.pulsar.client.api.RegexSubscriptionMode subscriptionTopicsMode)
Determines to which topics this consumer should be subscribed to - Persistent, Non-Persistent, or both.default PulsarComponentBuilderFactory.PulsarComponentBuilder
subscriptionType(org.apache.camel.component.pulsar.utils.consumers.SubscriptionType subscriptionType)
Type of the subscription EXCLUSIVESHAREDFAILOVERKEY_SHARED, defaults to EXCLUSIVE.default PulsarComponentBuilderFactory.PulsarComponentBuilder
topicsPattern(boolean topicsPattern)
Whether the topic is a pattern (regular expression) that allows the consumer to subscribe to all matching topics in the namespace.-
Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder
build, build, doSetProperty, register
-
-
-
-
Method Detail
-
configuration
default PulsarComponentBuilderFactory.PulsarComponentBuilder configuration(org.apache.camel.component.pulsar.PulsarConfiguration configuration)
Allows to pre-configure the Pulsar component with common options that the endpoints will reuse. The option is a:org.apache.camel.component.pulsar.PulsarConfiguration
type. Group: common
-
ackGroupTimeMillis
default PulsarComponentBuilderFactory.PulsarComponentBuilder ackGroupTimeMillis(long ackGroupTimeMillis)
Group the consumer acknowledgments for the specified time in milliseconds - defaults to 100. The option is a:long
type. Default: 100 Group: consumer
-
ackTimeoutMillis
default PulsarComponentBuilderFactory.PulsarComponentBuilder ackTimeoutMillis(long ackTimeoutMillis)
Timeout for unacknowledged messages in milliseconds - defaults to 10000. The option is a:long
type. Default: 10000 Group: consumer
-
allowManualAcknowledgement
default PulsarComponentBuilderFactory.PulsarComponentBuilder allowManualAcknowledgement(boolean allowManualAcknowledgement)
Whether to allow manual message acknowledgements. If this option is enabled, then messages are not acknowledged automatically after successful route completion. 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. The option is a:boolean
type. Default: false Group: consumer
-
bridgeErrorHandler
default PulsarComponentBuilderFactory.PulsarComponentBuilder bridgeErrorHandler(boolean bridgeErrorHandler)
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. The option is a:boolean
type. Default: false Group: consumer
-
consumerName
default PulsarComponentBuilderFactory.PulsarComponentBuilder consumerName(String consumerName)
Name of the consumer when subscription is EXCLUSIVE. The option is a:java.lang.String
type. Default: sole-consumer Group: consumer
-
consumerNamePrefix
default PulsarComponentBuilderFactory.PulsarComponentBuilder consumerNamePrefix(String consumerNamePrefix)
Prefix to add to consumer names when a SHARED or FAILOVER subscription is used. The option is a:java.lang.String
type. Default: cons Group: consumer
-
consumerQueueSize
default PulsarComponentBuilderFactory.PulsarComponentBuilder consumerQueueSize(int consumerQueueSize)
Size of the consumer queue - defaults to 10. The option is a:int
type. Default: 10 Group: consumer
-
deadLetterTopic
default PulsarComponentBuilderFactory.PulsarComponentBuilder deadLetterTopic(String deadLetterTopic)
Name of the topic where the messages which fail maxRedeliverCount times will be sent. Note: if not set, default topic name will be topicName-subscriptionName-DLQ. The option is a:java.lang.String
type. Group: consumer
-
maxRedeliverCount
default PulsarComponentBuilderFactory.PulsarComponentBuilder maxRedeliverCount(Integer maxRedeliverCount)
Maximum number of times that a message will be redelivered before being sent to the dead letter queue. If this value is not set, no Dead Letter Policy will be created. The option is a:java.lang.Integer
type. Group: consumer
-
negativeAckRedeliveryDelayMicros
default PulsarComponentBuilderFactory.PulsarComponentBuilder negativeAckRedeliveryDelayMicros(long negativeAckRedeliveryDelayMicros)
Set the negative acknowledgement delay. The option is a:long
type. Default: 60000000 Group: consumer
-
numberOfConsumers
default PulsarComponentBuilderFactory.PulsarComponentBuilder numberOfConsumers(int numberOfConsumers)
Number of consumers - defaults to 1. The option is a:int
type. Default: 1 Group: consumer
-
readCompacted
default PulsarComponentBuilderFactory.PulsarComponentBuilder readCompacted(boolean readCompacted)
Enable compacted topic reading. The option is a:boolean
type. Default: false Group: consumer
-
subscriptionInitialPosition
default PulsarComponentBuilderFactory.PulsarComponentBuilder subscriptionInitialPosition(org.apache.camel.component.pulsar.utils.consumers.SubscriptionInitialPosition subscriptionInitialPosition)
Control the initial position in the topic of a newly created subscription. Default is latest message. The option is a:org.apache.camel.component.pulsar.utils.consumers.SubscriptionInitialPosition
type. Default: LATEST Group: consumer
-
subscriptionName
default PulsarComponentBuilderFactory.PulsarComponentBuilder subscriptionName(String subscriptionName)
Name of the subscription to use. The option is a:java.lang.String
type. Default: subs Group: consumer
-
subscriptionTopicsMode
default PulsarComponentBuilderFactory.PulsarComponentBuilder subscriptionTopicsMode(org.apache.pulsar.client.api.RegexSubscriptionMode subscriptionTopicsMode)
Determines to which topics this consumer should be subscribed to - Persistent, Non-Persistent, or both. Only used with pattern subscriptions. The option is a:org.apache.pulsar.client.api.RegexSubscriptionMode
type. Default: PersistentOnly Group: consumer
-
subscriptionType
default PulsarComponentBuilderFactory.PulsarComponentBuilder subscriptionType(org.apache.camel.component.pulsar.utils.consumers.SubscriptionType subscriptionType)
Type of the subscription EXCLUSIVESHAREDFAILOVERKEY_SHARED, defaults to EXCLUSIVE. The option is a:org.apache.camel.component.pulsar.utils.consumers.SubscriptionType
type. Default: EXCLUSIVE Group: consumer
-
topicsPattern
default PulsarComponentBuilderFactory.PulsarComponentBuilder topicsPattern(boolean topicsPattern)
Whether the topic is a pattern (regular expression) that allows the consumer to subscribe to all matching topics in the namespace. The option is a:boolean
type. Default: false Group: consumer
-
pulsarMessageReceiptFactory
default PulsarComponentBuilderFactory.PulsarComponentBuilder pulsarMessageReceiptFactory(org.apache.camel.component.pulsar.PulsarMessageReceiptFactory pulsarMessageReceiptFactory)
Provide a factory to create an alternate implementation of PulsarMessageReceipt. The option is a:org.apache.camel.component.pulsar.PulsarMessageReceiptFactory
type. Group: consumer (advanced)
-
batcherBuilder
default PulsarComponentBuilderFactory.PulsarComponentBuilder batcherBuilder(org.apache.pulsar.client.api.BatcherBuilder batcherBuilder)
Control batching method used by the producer. The option is a:org.apache.pulsar.client.api.BatcherBuilder
type. Default: DEFAULT Group: producer
-
batchingEnabled
default PulsarComponentBuilderFactory.PulsarComponentBuilder batchingEnabled(boolean batchingEnabled)
Control whether automatic batching of messages is enabled for the producer. The option is a:boolean
type. Default: true Group: producer
-
batchingMaxMessages
default PulsarComponentBuilderFactory.PulsarComponentBuilder batchingMaxMessages(int batchingMaxMessages)
The maximum size to batch messages. The option is a:int
type. Default: 1000 Group: producer
-
batchingMaxPublishDelayMicros
default PulsarComponentBuilderFactory.PulsarComponentBuilder batchingMaxPublishDelayMicros(long batchingMaxPublishDelayMicros)
The maximum time period within which the messages sent will be batched if batchingEnabled is true. The option is a:long
type. Default: 1000 Group: producer
-
blockIfQueueFull
default PulsarComponentBuilderFactory.PulsarComponentBuilder blockIfQueueFull(boolean blockIfQueueFull)
Whether to block the producing thread if pending messages queue is full or to throw a ProducerQueueIsFullError. The option is a:boolean
type. Default: false Group: producer
-
compressionType
default PulsarComponentBuilderFactory.PulsarComponentBuilder compressionType(org.apache.pulsar.client.api.CompressionType compressionType)
Compression type to use. The option is a:org.apache.pulsar.client.api.CompressionType
type. Default: NONE Group: producer
-
initialSequenceId
default PulsarComponentBuilderFactory.PulsarComponentBuilder initialSequenceId(long initialSequenceId)
The first message published will have a sequence Id of initialSequenceId 1. The option is a:long
type. Default: -1 Group: producer
-
lazyStartProducer
default PulsarComponentBuilderFactory.PulsarComponentBuilder lazyStartProducer(boolean 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. The option is a:boolean
type. Default: false Group: producer
-
maxPendingMessages
default PulsarComponentBuilderFactory.PulsarComponentBuilder maxPendingMessages(int maxPendingMessages)
Size of the pending massages queue. When the queue is full, by default, any further sends will fail unless blockIfQueueFull=true. The option is a:int
type. Default: 1000 Group: producer
-
maxPendingMessagesAcrossPartitions
default PulsarComponentBuilderFactory.PulsarComponentBuilder maxPendingMessagesAcrossPartitions(int maxPendingMessagesAcrossPartitions)
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. The option is a:int
type. Default: 50000 Group: producer
-
messageRouter
default PulsarComponentBuilderFactory.PulsarComponentBuilder messageRouter(org.apache.pulsar.client.api.MessageRouter messageRouter)
Custom Message Router to use. The option is a:org.apache.pulsar.client.api.MessageRouter
type. Group: producer
-
messageRoutingMode
default PulsarComponentBuilderFactory.PulsarComponentBuilder messageRoutingMode(org.apache.pulsar.client.api.MessageRoutingMode messageRoutingMode)
Message Routing Mode to use. The option is a:org.apache.pulsar.client.api.MessageRoutingMode
type. Default: RoundRobinPartition Group: producer
-
producerName
default PulsarComponentBuilderFactory.PulsarComponentBuilder producerName(String producerName)
Name of the producer. If unset, lets Pulsar select a unique identifier. The option is a:java.lang.String
type. Group: producer
-
sendTimeoutMs
default PulsarComponentBuilderFactory.PulsarComponentBuilder sendTimeoutMs(int sendTimeoutMs)
Send timeout in milliseconds. The option is a:int
type. Default: 30000 Group: producer
-
autoConfiguration
default PulsarComponentBuilderFactory.PulsarComponentBuilder autoConfiguration(org.apache.camel.component.pulsar.utils.AutoConfiguration autoConfiguration)
The pulsar auto configuration. The option is a:org.apache.camel.component.pulsar.utils.AutoConfiguration
type. Group: advanced
-
autowiredEnabled
default PulsarComponentBuilderFactory.PulsarComponentBuilder autowiredEnabled(boolean 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. The option is a:boolean
type. Default: true Group: advanced
-
pulsarClient
default PulsarComponentBuilderFactory.PulsarComponentBuilder pulsarClient(org.apache.pulsar.client.api.PulsarClient pulsarClient)
The pulsar client. The option is a:org.apache.pulsar.client.api.PulsarClient
type. Group: advanced
-
-