org.apache.camel.builder.endpoint.dsl

Interface PulsarEndpointBuilderFactory.PulsarEndpointConsumerBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver

All Known Subinterfaces:

PulsarEndpointBuilderFactory.PulsarEndpointBuilder

Enclosing interface:

PulsarEndpointBuilderFactory

public static interface PulsarEndpointBuilderFactory.PulsarEndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder

Builder for endpoint consumers for the Pulsar component.

Method Summary

Modifier and Type	Method and Description
default PulsarEndpointBuilderFactory.PulsarEndpointConsumerBuilder	ackGroupTimeMillis(long ackGroupTimeMillis) Group the consumer acknowledgments for the specified time in milliseconds - defaults to 100.
default PulsarEndpointBuilderFactory.PulsarEndpointConsumerBuilder	ackGroupTimeMillis(String ackGroupTimeMillis) Group the consumer acknowledgments for the specified time in milliseconds - defaults to 100.
default PulsarEndpointBuilderFactory.PulsarEndpointConsumerBuilder	ackTimeoutMillis(long ackTimeoutMillis) Timeout for unacknowledged messages in milliseconds - defaults to 10000.
default PulsarEndpointBuilderFactory.PulsarEndpointConsumerBuilder	ackTimeoutMillis(String ackTimeoutMillis) Timeout for unacknowledged messages in milliseconds - defaults to 10000.
default PulsarEndpointBuilderFactory.AdvancedPulsarEndpointConsumerBuilder	advanced()
default PulsarEndpointBuilderFactory.PulsarEndpointConsumerBuilder	allowManualAcknowledgement(boolean allowManualAcknowledgement) Whether to allow manual message acknowledgements.
default PulsarEndpointBuilderFactory.PulsarEndpointConsumerBuilder	allowManualAcknowledgement(String allowManualAcknowledgement) Whether to allow manual message acknowledgements.
default PulsarEndpointBuilderFactory.PulsarEndpointConsumerBuilder	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 PulsarEndpointBuilderFactory.PulsarEndpointConsumerBuilder	bridgeErrorHandler(String 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 PulsarEndpointBuilderFactory.PulsarEndpointConsumerBuilder	consumerName(String consumerName) Name of the consumer when subscription is EXCLUSIVE.
default PulsarEndpointBuilderFactory.PulsarEndpointConsumerBuilder	consumerNamePrefix(String consumerNamePrefix) Prefix to add to consumer names when a SHARED or FAILOVER subscription is used.
default PulsarEndpointBuilderFactory.PulsarEndpointConsumerBuilder	consumerQueueSize(int consumerQueueSize) Size of the consumer queue - defaults to 10.
default PulsarEndpointBuilderFactory.PulsarEndpointConsumerBuilder	consumerQueueSize(String consumerQueueSize) Size of the consumer queue - defaults to 10.
default PulsarEndpointBuilderFactory.PulsarEndpointConsumerBuilder	numberOfConsumers(int numberOfConsumers) Number of consumers - defaults to 1.
default PulsarEndpointBuilderFactory.PulsarEndpointConsumerBuilder	numberOfConsumers(String numberOfConsumers) Number of consumers - defaults to 1.
default PulsarEndpointBuilderFactory.PulsarEndpointConsumerBuilder	subscriptionInitialPosition(PulsarEndpointBuilderFactory.SubscriptionInitialPosition subscriptionInitialPosition) Control the initial position in the topic of a newly created subscription.
default PulsarEndpointBuilderFactory.PulsarEndpointConsumerBuilder	subscriptionInitialPosition(String subscriptionInitialPosition) Control the initial position in the topic of a newly created subscription.
default PulsarEndpointBuilderFactory.PulsarEndpointConsumerBuilder	subscriptionName(String subscriptionName) Name of the subscription to use.
default PulsarEndpointBuilderFactory.PulsarEndpointConsumerBuilder	subscriptionType(PulsarEndpointBuilderFactory.SubscriptionType subscriptionType) Type of the subscription EXCLUSIVESHAREDFAILOVER, defaults to EXCLUSIVE.
default PulsarEndpointBuilderFactory.PulsarEndpointConsumerBuilder	subscriptionType(String subscriptionType) Type of the subscription EXCLUSIVESHAREDFAILOVER, defaults to EXCLUSIVE.

Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder

doSetProperty, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve

Method Detail

advanced

default PulsarEndpointBuilderFactory.AdvancedPulsarEndpointConsumerBuilder advanced()

ackGroupTimeMillis

default PulsarEndpointBuilderFactory.PulsarEndpointConsumerBuilder 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

ackGroupTimeMillis

default PulsarEndpointBuilderFactory.PulsarEndpointConsumerBuilder ackGroupTimeMillis(String ackGroupTimeMillis)

Group the consumer acknowledgments for the specified time in milliseconds - defaults to 100. The option will be converted to a long type. Default: 100 Group: consumer

ackTimeoutMillis

default PulsarEndpointBuilderFactory.PulsarEndpointConsumerBuilder ackTimeoutMillis(long ackTimeoutMillis)

Timeout for unacknowledged messages in milliseconds - defaults to 10000. The option is a: long type. Default: 10000 Group: consumer

ackTimeoutMillis

default PulsarEndpointBuilderFactory.PulsarEndpointConsumerBuilder ackTimeoutMillis(String ackTimeoutMillis)

Timeout for unacknowledged messages in milliseconds - defaults to 10000. The option will be converted to a long type. Default: 10000 Group: consumer

allowManualAcknowledgement

default PulsarEndpointBuilderFactory.PulsarEndpointConsumerBuilder allowManualAcknowledgement(boolean allowManualAcknowledgement)

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. The option is a: boolean type. Default: false Group: consumer

allowManualAcknowledgement

default PulsarEndpointBuilderFactory.PulsarEndpointConsumerBuilder allowManualAcknowledgement(String allowManualAcknowledgement)

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. The option will be converted to a boolean type. Default: false Group: consumer

bridgeErrorHandler

default PulsarEndpointBuilderFactory.PulsarEndpointConsumerBuilder 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

bridgeErrorHandler

default PulsarEndpointBuilderFactory.PulsarEndpointConsumerBuilder bridgeErrorHandler(String 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 will be converted to a boolean type. Default: false Group: consumer

consumerName

default PulsarEndpointBuilderFactory.PulsarEndpointConsumerBuilder 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 PulsarEndpointBuilderFactory.PulsarEndpointConsumerBuilder 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 PulsarEndpointBuilderFactory.PulsarEndpointConsumerBuilder consumerQueueSize(int consumerQueueSize)

Size of the consumer queue - defaults to 10. The option is a: int type. Default: 10 Group: consumer

consumerQueueSize

default PulsarEndpointBuilderFactory.PulsarEndpointConsumerBuilder consumerQueueSize(String consumerQueueSize)

Size of the consumer queue - defaults to 10. The option will be converted to a int type. Default: 10 Group: consumer

numberOfConsumers

default PulsarEndpointBuilderFactory.PulsarEndpointConsumerBuilder numberOfConsumers(int numberOfConsumers)

Number of consumers - defaults to 1. The option is a: int type. Default: 1 Group: consumer

numberOfConsumers

default PulsarEndpointBuilderFactory.PulsarEndpointConsumerBuilder numberOfConsumers(String numberOfConsumers)

Number of consumers - defaults to 1. The option will be converted to a int type. Default: 1 Group: consumer

subscriptionInitialPosition

default PulsarEndpointBuilderFactory.PulsarEndpointConsumerBuilder subscriptionInitialPosition(PulsarEndpointBuilderFactory.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

subscriptionInitialPosition

default PulsarEndpointBuilderFactory.PulsarEndpointConsumerBuilder subscriptionInitialPosition(String subscriptionInitialPosition)

Control the initial position in the topic of a newly created subscription. Default is latest message. The option will be converted to a org.apache.camel.component.pulsar.utils.consumers.SubscriptionInitialPosition type. Default: LATEST Group: consumer

subscriptionName

default PulsarEndpointBuilderFactory.PulsarEndpointConsumerBuilder subscriptionName(String subscriptionName)

Name of the subscription to use. The option is a: java.lang.String type. Default: subs Group: consumer

subscriptionType

default PulsarEndpointBuilderFactory.PulsarEndpointConsumerBuilder subscriptionType(PulsarEndpointBuilderFactory.SubscriptionType subscriptionType)

Type of the subscription EXCLUSIVESHAREDFAILOVER, defaults to EXCLUSIVE. The option is a: org.apache.camel.component.pulsar.utils.consumers.SubscriptionType type. Default: EXCLUSIVE Group: consumer

subscriptionType

default PulsarEndpointBuilderFactory.PulsarEndpointConsumerBuilder subscriptionType(String subscriptionType)

Type of the subscription EXCLUSIVESHAREDFAILOVER, defaults to EXCLUSIVE. The option will be converted to a org.apache.camel.component.pulsar.utils.consumers.SubscriptionType type. Default: EXCLUSIVE Group: consumer