PulsarConfiguration (Camel :: Pulsar 3.14.10 API)

java.lang.Object
- org.apache.camel.component.pulsar.PulsarConfiguration

All Implemented Interfaces:: Cloneable

@UriParams
public class PulsarConfiguration
extends Object
implements Cloneable

Constructor Summary

Constructors
Constructor and Description

PulsarConfiguration()

Constructors
Constructor and Description
`PulsarConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PulsarConfiguration`	`copy()` Returns a copy of this configuration
`long`	`getAckGroupTimeMillis()`
`long`	`getAckTimeoutMillis()`
`String`	`getAuthenticationClass()`
`String`	`getAuthenticationParams()`
`org.apache.pulsar.client.api.BatcherBuilder`	`getBatcherBuilder()`
`int`	`getBatchingMaxMessages()`
`long`	`getBatchingMaxPublishDelayMicros()`
`org.apache.pulsar.client.api.CompressionType`	`getCompressionType()`
`String`	`getConsumerName()`
`String`	`getConsumerNamePrefix()`
`int`	`getConsumerQueueSize()`
`String`	`getDeadLetterTopic()`
`long`	`getInitialSequenceId()`
`int`	`getMaxPendingMessages()`
`int`	`getMaxPendingMessagesAcrossPartitions()`
`Integer`	`getMaxRedeliverCount()`
`org.apache.pulsar.client.api.MessageRouter`	`getMessageRouter()` Set a custom Message Router.
`org.apache.pulsar.client.api.MessageRoutingMode`	`getMessageRoutingMode()` Set the message routing mode for the producer.
`long`	`getNegativeAckRedeliveryDelayMicros()`
`int`	`getNumberOfConsumers()`
`int`	`getNumberOfConsumerThreads()`
`String`	`getProducerName()`
`int`	`getSendTimeoutMs()`
`String`	`getServiceUrl()`
`SubscriptionInitialPosition`	`getSubscriptionInitialPosition()`
`String`	`getSubscriptionName()`
`org.apache.pulsar.client.api.RegexSubscriptionMode`	`getSubscriptionTopicsMode()`
`SubscriptionType`	`getSubscriptionType()`
`boolean`	`isAllowManualAcknowledgement()`
`boolean`	`isBatchingEnabled()`
`boolean`	`isBlockIfQueueFull()`
`boolean`	`isMessageListener()`
`boolean`	`isReadCompacted()` Enable compacted topic reading.
`boolean`	`isTopicsPattern()`
`void`	`setAckGroupTimeMillis(long ackGroupTimeMillis)` Group the consumer acknowledgments for the specified time in milliseconds - defaults to 100
`void`	`setAckTimeoutMillis(long ackTimeoutMillis)` Timeout for unacknowledged messages in milliseconds - defaults to 10000
`void`	`setAllowManualAcknowledgement(boolean allowManualAcknowledgement)` Whether to allow manual message acknowledgements.
`void`	`setAuthenticationClass(String authenticationClass)` The Authentication FQCN to be used while creating the client from URI
`void`	`setAuthenticationParams(String authenticationParams)` The Authentication Parameters to be used while creating the client from URI
`void`	`setBatcherBuilder(org.apache.pulsar.client.api.BatcherBuilder batcherBuilder)` Control batching method of the Pulsar producer.
`void`	`setBatchingEnabled(boolean batchingEnabled)` Control whether automatic batching of messages is enabled for the producer.
`void`	`setBatchingMaxMessages(int batchingMaxMessages)` Set the maximum number of messages permitted in a batch.
`void`	`setBatchingMaxPublishDelayMicros(long batchingMaxPublishDelayMicros)` Set the time period within which the messages sent will be batched if batch messages are enabled.
`void`	`setBlockIfQueueFull(boolean blockIfQueueFull)` Set whether the send and asyncSend operations should block when the outgoing message queue is full.
`void`	`setCompressionType(org.apache.pulsar.client.api.CompressionType compressionType)` Set the compression type for the producer.
`void`	`setCompressionType(String compressionType)` Set the compression type for the producer.
`void`	`setConsumerName(String consumerName)` Name of the consumer when subscription is EXCLUSIVE
`void`	`setConsumerNamePrefix(String consumerNamePrefix)` Prefix to add to consumer names when a SHARED or FAILOVER subscription is used
`void`	`setConsumerQueueSize(int consumerQueueSize)` Size of the consumer queue - defaults to 10
`void`	`setDeadLetterTopic(String deadLetterTopic)`
`void`	`setInitialSequenceId(long initialSequenceId)` Set the baseline for the sequence ids for messages published by the producer.
`void`	`setMaxPendingMessages(int maxPendingMessages)` Set the max size of the queue holding the messages pending to receive an acknowledgment from the broker.
`void`	`setMaxPendingMessagesAcrossPartitions(int maxPendingMessagesAcrossPartitions)` Set the number of max pending messages across all the partitions.
`void`	`setMaxRedeliverCount(Integer maxRedeliverCount)`
`void`	`setMessageListener(boolean messageListener)`
`void`	`setMessageRouter(org.apache.pulsar.client.api.MessageRouter messageRouter)`
`void`	`setMessageRoutingMode(org.apache.pulsar.client.api.MessageRoutingMode messageRoutingMode)`
`void`	`setNegativeAckRedeliveryDelayMicros(long negativeAckRedeliveryDelayMicros)` Set the negative acknowledgement delay
`void`	`setNumberOfConsumers(int numberOfConsumers)` Number of consumers - defaults to 1
`void`	`setNumberOfConsumerThreads(int numberOfConsumerThreads)` Number of consumers threads - defaults to 1
`void`	`setProducerName(String producerName)` Name of the producer.
`void`	`setReadCompacted(boolean readCompacted)`
`void`	`setSendTimeoutMs(int sendTimeoutMs)` Send timeout in milliseconds.
`void`	`setServiceUrl(String serviceUrl)` The Pulsar Service URL to point while creating the client from URI
`void`	`setSubscriptionInitialPosition(SubscriptionInitialPosition subscriptionInitialPosition)` Control the initial position in the topic of a newly created subscription.
`void`	`setSubscriptionName(String subscriptionName)` Name of the subscription to use
`void`	`setSubscriptionTopicsMode(org.apache.pulsar.client.api.RegexSubscriptionMode subscriptionTopicsMode)` Determines to which topics this consumer should be subscribed to - Persistent, Non-Persistent, or both.
`void`	`setSubscriptionType(SubscriptionType subscriptionType)` Type of the subscription [EXCLUSIVE\|SHARED\|FAILOVER\|KEY_SHARED], defaults to EXCLUSIVE
`void`	`setTopicsPattern(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 class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PulsarConfiguration
```
public PulsarConfiguration()
```
- Method Detail
  - copy
```
public PulsarConfiguration copy()
```
    Returns a copy of this configuration
  - isTopicsPattern
```
public boolean isTopicsPattern()
```
  - setTopicsPattern
```
public void setTopicsPattern(boolean topicsPattern)
```
    Whether the topic is a pattern (regular expression) that allows the consumer to subscribe to all matching topics in the namespace
  - getSubscriptionTopicsMode
```
public org.apache.pulsar.client.api.RegexSubscriptionMode getSubscriptionTopicsMode()
```
  - setSubscriptionTopicsMode
```
public void setSubscriptionTopicsMode(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.
  - getSubscriptionName
```
public String getSubscriptionName()
```
  - setSubscriptionName
```
public void setSubscriptionName(String subscriptionName)
```
    Name of the subscription to use
  - getSubscriptionType
```
public SubscriptionType getSubscriptionType()
```
  - setSubscriptionType
```
public void setSubscriptionType(SubscriptionType subscriptionType)
```
    Type of the subscription [EXCLUSIVE|SHARED|FAILOVER|KEY_SHARED], defaults to EXCLUSIVE
  - getNumberOfConsumers
```
public int getNumberOfConsumers()
```
  - setNumberOfConsumers
```
public void setNumberOfConsumers(int numberOfConsumers)
```
    Number of consumers - defaults to 1
  - getConsumerQueueSize
```
public int getConsumerQueueSize()
```
  - setConsumerQueueSize
```
public void setConsumerQueueSize(int consumerQueueSize)
```
    Size of the consumer queue - defaults to 10
  - getConsumerName
```
public String getConsumerName()
```
  - setConsumerName
```
public void setConsumerName(String consumerName)
```
    Name of the consumer when subscription is EXCLUSIVE
  - getProducerName
```
public String getProducerName()
```
  - setProducerName
```
public void setProducerName(String producerName)
```
    Name of the producer. If unset, lets Pulsar select a unique identifier.
  - getConsumerNamePrefix
```
public String getConsumerNamePrefix()
```
  - setConsumerNamePrefix
```
public void setConsumerNamePrefix(String consumerNamePrefix)
```
    Prefix to add to consumer names when a SHARED or FAILOVER subscription is used
  - isAllowManualAcknowledgement
```
public boolean isAllowManualAcknowledgement()
```
  - setAllowManualAcknowledgement
```
public void setAllowManualAcknowledgement(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 Exchange. Messages can then be acknowledged using PulsarMessageReceipt at any time before the ackTimeout occurs.
  - getAckTimeoutMillis
```
public long getAckTimeoutMillis()
```
  - setAckTimeoutMillis
```
public void setAckTimeoutMillis(long ackTimeoutMillis)
```
    Timeout for unacknowledged messages in milliseconds - defaults to 10000
  - getAckGroupTimeMillis
```
public long getAckGroupTimeMillis()
```
  - setAckGroupTimeMillis
```
public void setAckGroupTimeMillis(long ackGroupTimeMillis)
```
    Group the consumer acknowledgments for the specified time in milliseconds - defaults to 100
  - setSendTimeoutMs
```
public void setSendTimeoutMs(int sendTimeoutMs)
```
    Send timeout in milliseconds. Defaults to 30,000ms (30 seconds)
  - getSendTimeoutMs
```
public int getSendTimeoutMs()
```
  - setBlockIfQueueFull
```
public void setBlockIfQueueFull(boolean blockIfQueueFull)
```
    Set whether the send and asyncSend operations should block when the outgoing message queue is full. If set to false, send operations will immediately fail with ProducerQueueIsFullError when there is no space left in the pending queue. Default is false.
  - isBlockIfQueueFull
```
public boolean isBlockIfQueueFull()
```
  - setMaxPendingMessages
```
public void setMaxPendingMessages(int maxPendingMessages)
```
    Set the max size of the queue holding the messages pending to receive an acknowledgment from the broker. Default is 1000.
  - getMaxPendingMessages
```
public int getMaxPendingMessages()
```
  - setMaxPendingMessagesAcrossPartitions
```
public void setMaxPendingMessagesAcrossPartitions(int maxPendingMessagesAcrossPartitions)
```
    Set the number of max pending messages across all the partitions. Default is 50000.
  - getMaxPendingMessagesAcrossPartitions
```
public int getMaxPendingMessagesAcrossPartitions()
```
  - setBatchingMaxPublishDelayMicros
```
public void setBatchingMaxPublishDelayMicros(long batchingMaxPublishDelayMicros)
```
    Set the time period within which the messages sent will be batched if batch messages are enabled. If set to a non zero value, messages will be queued until either:
    - this time interval expires
    - the max number of messages in a batch is reached
    Default is 1ms.
  - getBatchingMaxPublishDelayMicros
```
public long getBatchingMaxPublishDelayMicros()
```
  - setBatchingMaxMessages
```
public void setBatchingMaxMessages(int batchingMaxMessages)
```
    Set the maximum number of messages permitted in a batch. Default 1,000.
  - getBatchingMaxMessages
```
public int getBatchingMaxMessages()
```
  - setBatchingEnabled
```
public void setBatchingEnabled(boolean batchingEnabled)
```
    Control whether automatic batching of messages is enabled for the producer. Default is true.
  - isBatchingEnabled
```
public boolean isBatchingEnabled()
```
  - setBatcherBuilder
```
public void setBatcherBuilder(org.apache.pulsar.client.api.BatcherBuilder batcherBuilder)
```
    Control batching method of the Pulsar producer. KEY_BASED batches based on the Pulsar message key. DEFAULT batches all messages together regardless of key; this may cause only a single consumer to work when consuming using a KEY_SHARED subscription. Default is DEFAULT.
  - getBatcherBuilder
```
public org.apache.pulsar.client.api.BatcherBuilder getBatcherBuilder()
```
  - setSubscriptionInitialPosition
```
public void setSubscriptionInitialPosition(SubscriptionInitialPosition subscriptionInitialPosition)
```
    Control the initial position in the topic of a newly created subscription. Default is latest message.
  - getSubscriptionInitialPosition
```
public SubscriptionInitialPosition getSubscriptionInitialPosition()
```
  - isReadCompacted
```
public boolean isReadCompacted()
```
    Enable compacted topic reading.
  - setReadCompacted
```
public void setReadCompacted(boolean readCompacted)
```
  - setInitialSequenceId
```
public void setInitialSequenceId(long initialSequenceId)
```
    Set the baseline for the sequence ids for messages published by the producer. First message will be using (initialSequenceId 1) as its sequence id and subsequent messages will be assigned incremental sequence ids, if not otherwise specified.
  - getInitialSequenceId
```
public long getInitialSequenceId()
```
  - setCompressionType
```
public void setCompressionType(String compressionType)
```
    Set the compression type for the producer.
  - setCompressionType
```
public void setCompressionType(org.apache.pulsar.client.api.CompressionType compressionType)
```
    Set the compression type for the producer.
  - getCompressionType
```
public org.apache.pulsar.client.api.CompressionType getCompressionType()
```
  - getMessageRoutingMode
```
public org.apache.pulsar.client.api.MessageRoutingMode getMessageRoutingMode()
```
    Set the message routing mode for the producer.
  - setMessageRoutingMode
```
public void setMessageRoutingMode(org.apache.pulsar.client.api.MessageRoutingMode messageRoutingMode)
```
  - getMessageRouter
```
public org.apache.pulsar.client.api.MessageRouter getMessageRouter()
```
    Set a custom Message Router.
  - setMessageRouter
```
public void setMessageRouter(org.apache.pulsar.client.api.MessageRouter messageRouter)
```
  - getNegativeAckRedeliveryDelayMicros
```
public long getNegativeAckRedeliveryDelayMicros()
```
  - setNegativeAckRedeliveryDelayMicros
```
public void setNegativeAckRedeliveryDelayMicros(long negativeAckRedeliveryDelayMicros)
```
    Set the negative acknowledgement delay
  - getMaxRedeliverCount
```
public Integer getMaxRedeliverCount()
```
  - setMaxRedeliverCount
```
public void setMaxRedeliverCount(Integer maxRedeliverCount)
```
  - getDeadLetterTopic
```
public String getDeadLetterTopic()
```
  - setDeadLetterTopic
```
public void setDeadLetterTopic(String deadLetterTopic)
```
  - isMessageListener
```
public boolean isMessageListener()
```
  - setMessageListener
```
public void setMessageListener(boolean messageListener)
```
  - getNumberOfConsumerThreads
```
public int getNumberOfConsumerThreads()
```
  - setNumberOfConsumerThreads
```
public void setNumberOfConsumerThreads(int numberOfConsumerThreads)
```
    Number of consumers threads - defaults to 1
  - getServiceUrl
```
public String getServiceUrl()
```
  - setServiceUrl
```
public void setServiceUrl(String serviceUrl)
```
    The Pulsar Service URL to point while creating the client from URI
  - getAuthenticationClass
```
public String getAuthenticationClass()
```
  - setAuthenticationClass
```
public void setAuthenticationClass(String authenticationClass)
```
    The Authentication FQCN to be used while creating the client from URI
  - getAuthenticationParams
```
public String getAuthenticationParams()
```
  - setAuthenticationParams
```
public void setAuthenticationParams(String authenticationParams)
```
    The Authentication Parameters to be used while creating the client from URI

Class PulsarConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PulsarConfiguration

Method Detail

copy

isTopicsPattern

setTopicsPattern

getSubscriptionTopicsMode

setSubscriptionTopicsMode

getSubscriptionName

setSubscriptionName

getSubscriptionType

setSubscriptionType

getNumberOfConsumers

setNumberOfConsumers

getConsumerQueueSize

setConsumerQueueSize

getConsumerName

setConsumerName

getProducerName

setProducerName

getConsumerNamePrefix

setConsumerNamePrefix

isAllowManualAcknowledgement

setAllowManualAcknowledgement

getAckTimeoutMillis

setAckTimeoutMillis

getAckGroupTimeMillis

setAckGroupTimeMillis

setSendTimeoutMs

getSendTimeoutMs

setBlockIfQueueFull

isBlockIfQueueFull

setMaxPendingMessages

getMaxPendingMessages

setMaxPendingMessagesAcrossPartitions

getMaxPendingMessagesAcrossPartitions

setBatchingMaxPublishDelayMicros

getBatchingMaxPublishDelayMicros

setBatchingMaxMessages

getBatchingMaxMessages

setBatchingEnabled

isBatchingEnabled

setBatcherBuilder

getBatcherBuilder

setSubscriptionInitialPosition

getSubscriptionInitialPosition

isReadCompacted

setReadCompacted

setInitialSequenceId

getInitialSequenceId

setCompressionType

setCompressionType

getCompressionType

getMessageRoutingMode

setMessageRoutingMode

getMessageRouter

setMessageRouter

getNegativeAckRedeliveryDelayMicros

setNegativeAckRedeliveryDelayMicros

getMaxRedeliverCount

setMaxRedeliverCount

getDeadLetterTopic

setDeadLetterTopic

isMessageListener

setMessageListener

getNumberOfConsumerThreads

setNumberOfConsumerThreads

getServiceUrl

setServiceUrl

getAuthenticationClass

setAuthenticationClass

getAuthenticationParams

setAuthenticationParams