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 Detail

      • allowManualAcknowledgement

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

        default PulsarEndpointBuilderFactory.PulsarEndpointConsumerBuilder allowManualAcknowledgement​(String 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 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
      • deadLetterTopic

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

        default PulsarEndpointBuilderFactory.PulsarEndpointConsumerBuilder maxRedeliverCount​(String 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 will be converted to a java.lang.Integer type. 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
      • subscriptionTopicsMode

        default PulsarEndpointBuilderFactory.PulsarEndpointConsumerBuilder subscriptionTopicsMode​(String subscriptionTopicsMode)
        Determines to which topics this consumer should be subscribed to - Persistent, Non-Persistent, or both. Only used with pattern subscriptions. The option will be converted to a org.apache.pulsar.client.api.RegexSubscriptionMode type. Default: PersistentOnly Group: consumer
      • subscriptionType

        default PulsarEndpointBuilderFactory.PulsarEndpointConsumerBuilder subscriptionType​(String subscriptionType)
        Type of the subscription EXCLUSIVESHAREDFAILOVERKEY_SHARED, defaults to EXCLUSIVE. The option will be converted to a org.apache.camel.component.pulsar.utils.consumers.SubscriptionType type. Default: EXCLUSIVE Group: consumer
      • topicsPattern

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

        default PulsarEndpointBuilderFactory.PulsarEndpointConsumerBuilder topicsPattern​(String topicsPattern)
        Whether the topic is a pattern (regular expression) that allows the consumer to subscribe to all matching topics in the namespace. The option will be converted to a boolean type. Default: false Group: consumer