| {"component":{"kind":"component","name":"pulsar","title":"Pulsar","description":"Send and receive messages from/to Apache Pulsar messaging system.","deprecated":false,"firstVersion":"2.24.0","label":"messaging","javaType":"org.apache.camel.component.pulsar.PulsarComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-pulsar","version":"3.18.1","scheme":"pulsar","extendsScheme":"","syntax":"pulsar:persistence://tenant/namespace/topic","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false},"headers":{"properties":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Map<String, String>","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The properties attached to the message.","constantName":"org.apache.camel.component.pulsar.utils.message.PulsarMessageHeaders#PROPERTIES"},"producer_name":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The producer name who produced the message.","constantName":"org.apache.camel.component.pulsar.utils.message.PulsarMessageHeaders#PRODUCER_NAME"},"sequence_id":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sequence id associated with the message.","constantName":"org.apache.camel.component.pulsar.utils.message.PulsarMessageHeaders#SEQUENCE_ID"},"publish_time":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The publish time of the message.","constantName":"org.apache.camel.component.pulsar.utils.message.PulsarMessageHeaders#PUBLISH_TIME"},"message_id":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"org.apache.pulsar.client.api.MessageId","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The unique message ID associated with the message.","constantName":"org.apache.camel.component.pulsar.utils.message.PulsarMessageHeaders#MESSAGE_ID"},"event_time":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The event time associated with the message.","constantName":"org.apache.camel.component.pulsar.utils.message.PulsarMessageHeaders#EVENT_TIME"},"key":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The key of the message.","constantName":"org.apache.camel.component.pulsar.utils.message.PulsarMessageHeaders#KEY"},"key_bytes":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"byte[]","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The bytes in key.","constantName":"org.apache.camel.component.pulsar.utils.message.PulsarMessageHeaders#KEY_BYTES"},"topic_name":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The topic the message was published to.","constantName":"org.apache.camel.component.pulsar.utils.message.PulsarMessageHeaders#TOPIC_NAME"},"message_receipt":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"org.apache.camel.component.pulsar.PulsarMessageReceipt","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The message receipt.","constantName":"org.apache.camel.component.pulsar.utils.message.PulsarMessageHeaders#MESSAGE_RECEIPT"},"CamelPulsarProducerMessageKey":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The key of the message for routing policy.","constantName":"org.apache.camel.component.pulsar.utils.message.PulsarMessageHeaders#KEY_OUT"},"CamelPulsarProducerMessageProperties":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map<String, String>","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The properties of the message to add.","constantName":"org.apache.camel.component.pulsar.utils.message.PulsarMessageHeaders#PROPERTIES_OUT"},"CamelPulsarProducerMessageEventTime":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The event time of the message message.","constantName":"org.apache.camel.component.pulsar.utils.message.PulsarMessageHeaders#EVENT_TIME_OUT"},"CamelPulsarRedeliveryCount":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The message redelivery count, redelivery count maintain in pulsar broker.","constantName":"org.apache.camel.component.pulsar.utils.message.PulsarMessageHeaders#PULSAR_REDELIVERY_COUNT"}},"properties":{"persistence":{"kind":"path","displayName":"Persistence","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","enum":["persistent","non-persistent"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Whether the topic is persistent or non-persistent"},"tenant":{"kind":"path","displayName":"Tenant","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The tenant"},"namespace":{"kind":"path","displayName":"Namespace","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The namespace"},"topic":{"kind":"path","displayName":"Topic","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The topic"},"authenticationClass":{"kind":"parameter","displayName":"Authentication Class","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"The Authentication FQCN to be used while creating the client from URI"},"authenticationParams":{"kind":"parameter","displayName":"Authentication Params","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"The Authentication Parameters to be used while creating the client from URI"},"serviceUrl":{"kind":"parameter","displayName":"Service Url","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"The Pulsar Service URL to point while creating the client from URI"},"ackGroupTimeMillis":{"kind":"parameter","displayName":"Ack Group Time Millis","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":100,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Group the consumer acknowledgments for the specified time in milliseconds - defaults to 100"},"ackTimeoutMillis":{"kind":"parameter","displayName":"Ack Timeout Millis","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":10000,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Timeout for unacknowledged messages in milliseconds - defaults to 10000"},"allowManualAcknowledgement":{"kind":"parameter","displayName":"Allow Manual Acknowledgement","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"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."},"consumerName":{"kind":"parameter","displayName":"Consumer Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"sole-consumer","configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Name of the consumer when subscription is EXCLUSIVE"},"consumerNamePrefix":{"kind":"parameter","displayName":"Consumer Name Prefix","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"cons","configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Prefix to add to consumer names when a SHARED or FAILOVER subscription is used"},"consumerQueueSize":{"kind":"parameter","displayName":"Consumer Queue Size","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":10,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Size of the consumer queue - defaults to 10"},"deadLetterTopic":{"kind":"parameter","displayName":"Dead Letter Topic","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"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"},"maxRedeliverCount":{"kind":"parameter","displayName":"Max Redeliver Count","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"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"},"messageListener":{"kind":"parameter","displayName":"Message Listener","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Whether to use the messageListener interface, or to receive messages using a separate thread pool"},"negativeAckRedeliveryDelayMicros":{"kind":"parameter","displayName":"Negative Ack Redelivery Delay Micros","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":60000000,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Set the negative acknowledgement delay"},"numberOfConsumers":{"kind":"parameter","displayName":"Number Of Consumers","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Number of consumers - defaults to 1"},"numberOfConsumerThreads":{"kind":"parameter","displayName":"Number Of Consumer Threads","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Number of threads to receive and handle messages when using a separate thread pool"},"readCompacted":{"kind":"parameter","displayName":"Read Compacted","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Enable compacted topic reading."},"subscriptionInitialPosition":{"kind":"parameter","displayName":"Subscription Initial Position","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.camel.component.pulsar.utils.consumers.SubscriptionInitialPosition","enum":["EARLIEST","LATEST"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"LATEST","configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Control the initial position in the topic of a newly created subscription. Default is latest message."},"subscriptionName":{"kind":"parameter","displayName":"Subscription Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"subs","configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Name of the subscription to use"},"subscriptionTopicsMode":{"kind":"parameter","displayName":"Subscription Topics Mode","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.pulsar.client.api.RegexSubscriptionMode","enum":["PersistentOnly","NonPersistentOnly","AllTopics"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"PersistentOnly","configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Determines to which topics this consumer should be subscribed to - Persistent, Non-Persistent, or both. Only used with pattern subscriptions."},"subscriptionType":{"kind":"parameter","displayName":"Subscription Type","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.camel.component.pulsar.utils.consumers.SubscriptionType","enum":["EXCLUSIVE","SHARED","FAILOVER","KEY_SHARED"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"EXCLUSIVE","configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Type of the subscription EXCLUSIVESHAREDFAILOVERKEY_SHARED, defaults to EXCLUSIVE"},"topicsPattern":{"kind":"parameter","displayName":"Topics Pattern","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Whether the topic is a pattern (regular expression) that allows the consumer to subscribe to all matching topics in the namespace"},"bridgeErrorHandler":{"kind":"parameter","displayName":"Bridge Error Handler","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"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."},"exceptionHandler":{"kind":"parameter","displayName":"Exception Handler","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.ExceptionHandler","optionalPrefix":"consumer.","deprecated":false,"autowired":false,"secret":false,"description":"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."},"exchangePattern":{"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut","InOptionalOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"batcherBuilder":{"kind":"parameter","displayName":"Batcher Builder","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.pulsar.client.api.BatcherBuilder","deprecated":false,"autowired":false,"secret":false,"defaultValue":"DEFAULT","configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Control batching method used by the producer."},"batchingEnabled":{"kind":"parameter","displayName":"Batching Enabled","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Control whether automatic batching of messages is enabled for the producer."},"batchingMaxMessages":{"kind":"parameter","displayName":"Batching Max Messages","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"The maximum size to batch messages."},"batchingMaxPublishDelayMicros":{"kind":"parameter","displayName":"Batching Max Publish Delay Micros","group":"producer","label":"producer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"The maximum time period within which the messages sent will be batched if batchingEnabled is true."},"blockIfQueueFull":{"kind":"parameter","displayName":"Block If Queue Full","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Whether to block the producing thread if pending messages queue is full or to throw a ProducerQueueIsFullError"},"compressionType":{"kind":"parameter","displayName":"Compression Type","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.pulsar.client.api.CompressionType","enum":["NONE","LZ4","ZLIB","ZSTD","SNAPPY"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"NONE","configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Compression type to use"},"initialSequenceId":{"kind":"parameter","displayName":"Initial Sequence Id","group":"producer","label":"producer","required":false,"type":"integer","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":-1,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"The first message published will have a sequence Id of initialSequenceId 1."},"maxPendingMessages":{"kind":"parameter","displayName":"Max Pending Messages","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1000,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Size of the pending massages queue. When the queue is full, by default, any further sends will fail unless blockIfQueueFull=true"},"maxPendingMessagesAcrossPartitions":{"kind":"parameter","displayName":"Max Pending Messages Across Partitions","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":50000,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"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."},"messageRouter":{"kind":"parameter","displayName":"Message Router","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.pulsar.client.api.MessageRouter","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Custom Message Router to use"},"messageRoutingMode":{"kind":"parameter","displayName":"Message Routing Mode","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.pulsar.client.api.MessageRoutingMode","enum":["SinglePartition","RoundRobinPartition","CustomPartition"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"RoundRobinPartition","configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Message Routing Mode to use"},"producerName":{"kind":"parameter","displayName":"Producer Name","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Name of the producer. If unset, lets Pulsar select a unique identifier."},"sendTimeoutMs":{"kind":"parameter","displayName":"Send Timeout Ms","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":30000,"configurationClass":"org.apache.camel.component.pulsar.PulsarConfiguration","configurationField":"pulsarConfiguration","description":"Send timeout in milliseconds"},"lazyStartProducer":{"kind":"parameter","displayName":"Lazy Start Producer","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"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."}}} |