Package org.apache.pulsar.client.impl

Class ConsumerBuilderImpl<T>

  • All Implemented Interfaces:
    java.lang.Cloneable, org.apache.pulsar.client.api.ConsumerBuilder<T>
    public class ConsumerBuilderImpl<T>
extends java.lang.Object
implements org.apache.pulsar.client.api.ConsumerBuilder<T>

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      org.apache.pulsar.client.api.ConsumerBuilder<T> acknowledgmentGroupTime​(long delay, java.util.concurrent.TimeUnit unit)  
      org.apache.pulsar.client.api.ConsumerBuilder<T> ackTimeout​(long ackTimeout, java.util.concurrent.TimeUnit timeUnit)  
      org.apache.pulsar.client.api.ConsumerBuilder<T> ackTimeoutTickTime​(long tickTime, java.util.concurrent.TimeUnit timeUnit)  
      org.apache.pulsar.client.api.ConsumerBuilder<T> autoAckOldestChunkedMessageOnQueueFull​(boolean autoAckOldestChunkedMessageOnQueueFull)  
      org.apache.pulsar.client.api.ConsumerBuilder<T> autoUpdatePartitions​(boolean autoUpdate)  
      org.apache.pulsar.client.api.ConsumerBuilder<T> autoUpdatePartitionsInterval​(int interval, java.util.concurrent.TimeUnit unit)  
      org.apache.pulsar.client.api.ConsumerBuilder<T> batchReceivePolicy​(org.apache.pulsar.client.api.BatchReceivePolicy batchReceivePolicy)  
      org.apache.pulsar.client.api.ConsumerBuilder<T> clone()  
      org.apache.pulsar.client.api.ConsumerBuilder<T> consumerEventListener​(@NonNull org.apache.pulsar.client.api.ConsumerEventListener consumerEventListener)  
      org.apache.pulsar.client.api.ConsumerBuilder<T> consumerName​(java.lang.String consumerName)  
      org.apache.pulsar.client.api.ConsumerBuilder<T> cryptoFailureAction​(@NonNull org.apache.pulsar.client.api.ConsumerCryptoFailureAction action)  
      org.apache.pulsar.client.api.ConsumerBuilder<T> cryptoKeyReader​(@NonNull org.apache.pulsar.client.api.CryptoKeyReader cryptoKeyReader)  
      org.apache.pulsar.client.api.ConsumerBuilder<T> deadLetterPolicy​(org.apache.pulsar.client.api.DeadLetterPolicy deadLetterPolicy)  
      org.apache.pulsar.client.api.ConsumerBuilder<T> defaultCryptoKeyReader​(@NonNull java.util.Map<java.lang.String,​java.lang.String> privateKeys)  
      org.apache.pulsar.client.api.ConsumerBuilder<T> defaultCryptoKeyReader​(java.lang.String privateKey)  
      org.apache.pulsar.client.api.ConsumerBuilder<T> enableBatchIndexAcknowledgment​(boolean batchIndexAcknowledgmentEnabled)  
      org.apache.pulsar.client.api.ConsumerBuilder<T> enableRetry​(boolean retryEnable)  
      org.apache.pulsar.client.api.ConsumerBuilder<T> expireTimeOfIncompleteChunkedMessage​(long duration, java.util.concurrent.TimeUnit unit)  
      org.apache.pulsar.client.api.ConsumerBuilder<T> intercept​(org.apache.pulsar.client.api.ConsumerInterceptor<T>... interceptors)  
      org.apache.pulsar.client.api.ConsumerBuilder<T> isAckReceiptEnabled​(boolean isAckReceiptEnabled)  
      org.apache.pulsar.client.api.ConsumerBuilder<T> keySharedPolicy​(org.apache.pulsar.client.api.KeySharedPolicy keySharedPolicy)  
      org.apache.pulsar.client.api.ConsumerBuilder<T> loadConf​(java.util.Map<java.lang.String,​java.lang.Object> config)  
      org.apache.pulsar.client.api.ConsumerBuilder<T> maxPendingChuckedMessage​(int maxPendingChuckedMessage)  
      org.apache.pulsar.client.api.ConsumerBuilder<T> maxPendingChunkedMessage​(int maxPendingChunkedMessage)  
      org.apache.pulsar.client.api.ConsumerBuilder<T> maxTotalReceiverQueueSizeAcrossPartitions​(int maxTotalReceiverQueueSizeAcrossPartitions)  
      org.apache.pulsar.client.api.ConsumerBuilder<T> messageCrypto​(@NonNull org.apache.pulsar.client.api.MessageCrypto messageCrypto)  
      org.apache.pulsar.client.api.ConsumerBuilder<T> messageListener​(@NonNull org.apache.pulsar.client.api.MessageListener<T> messageListener)  
      org.apache.pulsar.client.api.ConsumerBuilder<T> messagePayloadProcessor​(org.apache.pulsar.client.api.MessagePayloadProcessor payloadProcessor)  
      org.apache.pulsar.client.api.ConsumerBuilder<T> negativeAckRedeliveryDelay​(long redeliveryDelay, java.util.concurrent.TimeUnit timeUnit)  
      org.apache.pulsar.client.api.ConsumerBuilder<T> patternAutoDiscoveryPeriod​(int periodInMinutes)  
      org.apache.pulsar.client.api.ConsumerBuilder<T> patternAutoDiscoveryPeriod​(int interval, java.util.concurrent.TimeUnit unit)  
      org.apache.pulsar.client.api.ConsumerBuilder<T> poolMessages​(boolean poolMessages)  
      org.apache.pulsar.client.api.ConsumerBuilder<T> priorityLevel​(int priorityLevel)  
      org.apache.pulsar.client.api.ConsumerBuilder<T> properties​(@NonNull java.util.Map<java.lang.String,​java.lang.String> properties)  
      org.apache.pulsar.client.api.ConsumerBuilder<T> property​(java.lang.String key, java.lang.String value)  
      org.apache.pulsar.client.api.ConsumerBuilder<T> readCompacted​(boolean readCompacted)  
      org.apache.pulsar.client.api.ConsumerBuilder<T> receiverQueueSize​(int receiverQueueSize)  
      org.apache.pulsar.client.api.ConsumerBuilder<T> replicateSubscriptionState​(boolean replicateSubscriptionState)  
      org.apache.pulsar.client.api.ConsumerBuilder<T> startMessageIdInclusive()  
      org.apache.pulsar.client.api.Consumer<T> subscribe()  
      java.util.concurrent.CompletableFuture<org.apache.pulsar.client.api.Consumer<T>> subscribeAsync()  
      org.apache.pulsar.client.api.ConsumerBuilder<T> subscriptionInitialPosition​(@NonNull org.apache.pulsar.client.api.SubscriptionInitialPosition subscriptionInitialPosition)  
      org.apache.pulsar.client.api.ConsumerBuilder<T> subscriptionMode​(@NonNull org.apache.pulsar.client.api.SubscriptionMode subscriptionMode)  
      org.apache.pulsar.client.api.ConsumerBuilder<T> subscriptionName​(java.lang.String subscriptionName)  
      org.apache.pulsar.client.api.ConsumerBuilder<T> subscriptionTopicsMode​(@NonNull org.apache.pulsar.client.api.RegexSubscriptionMode mode)  
      org.apache.pulsar.client.api.ConsumerBuilder<T> subscriptionType​(@NonNull org.apache.pulsar.client.api.SubscriptionType subscriptionType)  
      org.apache.pulsar.client.api.ConsumerBuilder<T> topic​(java.lang.String... topicNames)  
      org.apache.pulsar.client.api.ConsumerBuilder<T> topics​(java.util.List<java.lang.String> topicNames)  
      org.apache.pulsar.client.api.ConsumerBuilder<T> topicsPattern​(java.lang.String topicsPattern)  
      org.apache.pulsar.client.api.ConsumerBuilder<T> topicsPattern​(java.util.regex.Pattern topicsPattern)  
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

        equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • ConsumerBuilderImpl

        public ConsumerBuilderImpl​(PulsarClientImpl client,
                           org.apache.pulsar.client.api.Schema<T> schema)

    • Method Detail

      • loadConf

        public org.apache.pulsar.client.api.ConsumerBuilder<T> loadConf​(java.util.Map<java.lang.String,​java.lang.Object> config)
        Specified by:
        loadConf in interface org.apache.pulsar.client.api.ConsumerBuilder<T>

      • clone

        public org.apache.pulsar.client.api.ConsumerBuilder<T> clone()
        Specified by:
        clone in interface org.apache.pulsar.client.api.ConsumerBuilder<T>
        Overrides:
        clone in class java.lang.Object

      • subscribe

        public org.apache.pulsar.client.api.Consumer<T> subscribe()
                                                   throws org.apache.pulsar.client.api.PulsarClientException
        Specified by:
        subscribe in interface org.apache.pulsar.client.api.ConsumerBuilder<T>
        Throws:
        org.apache.pulsar.client.api.PulsarClientException

      • subscribeAsync

        public java.util.concurrent.CompletableFuture<org.apache.pulsar.client.api.Consumer<T>> subscribeAsync()
        Specified by:
        subscribeAsync in interface org.apache.pulsar.client.api.ConsumerBuilder<T>

      • topic

        public org.apache.pulsar.client.api.ConsumerBuilder<T> topic​(java.lang.String... topicNames)
        Specified by:
        topic in interface org.apache.pulsar.client.api.ConsumerBuilder<T>

      • topics

        public org.apache.pulsar.client.api.ConsumerBuilder<T> topics​(java.util.List<java.lang.String> topicNames)
        Specified by:
        topics in interface org.apache.pulsar.client.api.ConsumerBuilder<T>

      • topicsPattern

        public org.apache.pulsar.client.api.ConsumerBuilder<T> topicsPattern​(java.util.regex.Pattern topicsPattern)
        Specified by:
        topicsPattern in interface org.apache.pulsar.client.api.ConsumerBuilder<T>

      • topicsPattern

        public org.apache.pulsar.client.api.ConsumerBuilder<T> topicsPattern​(java.lang.String topicsPattern)
        Specified by:
        topicsPattern in interface org.apache.pulsar.client.api.ConsumerBuilder<T>

      • subscriptionName

        public org.apache.pulsar.client.api.ConsumerBuilder<T> subscriptionName​(java.lang.String subscriptionName)
        Specified by:
        subscriptionName in interface org.apache.pulsar.client.api.ConsumerBuilder<T>

      • ackTimeout

        public org.apache.pulsar.client.api.ConsumerBuilder<T> ackTimeout​(long ackTimeout,
                                                                  java.util.concurrent.TimeUnit timeUnit)
        Specified by:
        ackTimeout in interface org.apache.pulsar.client.api.ConsumerBuilder<T>

      • isAckReceiptEnabled

        public org.apache.pulsar.client.api.ConsumerBuilder<T> isAckReceiptEnabled​(boolean isAckReceiptEnabled)
        Specified by:
        isAckReceiptEnabled in interface org.apache.pulsar.client.api.ConsumerBuilder<T>

      • ackTimeoutTickTime

        public org.apache.pulsar.client.api.ConsumerBuilder<T> ackTimeoutTickTime​(long tickTime,
                                                                          java.util.concurrent.TimeUnit timeUnit)
        Specified by:
        ackTimeoutTickTime in interface org.apache.pulsar.client.api.ConsumerBuilder<T>

      • negativeAckRedeliveryDelay

        public org.apache.pulsar.client.api.ConsumerBuilder<T> negativeAckRedeliveryDelay​(long redeliveryDelay,
                                                                                  java.util.concurrent.TimeUnit timeUnit)
        Specified by:
        negativeAckRedeliveryDelay in interface org.apache.pulsar.client.api.ConsumerBuilder<T>

      • subscriptionType

        public org.apache.pulsar.client.api.ConsumerBuilder<T> subscriptionType​(@NonNull
                                                                        @NonNull org.apache.pulsar.client.api.SubscriptionType subscriptionType)
        Specified by:
        subscriptionType in interface org.apache.pulsar.client.api.ConsumerBuilder<T>

      • subscriptionMode

        public org.apache.pulsar.client.api.ConsumerBuilder<T> subscriptionMode​(@NonNull
                                                                        @NonNull org.apache.pulsar.client.api.SubscriptionMode subscriptionMode)
        Specified by:
        subscriptionMode in interface org.apache.pulsar.client.api.ConsumerBuilder<T>

      • messageListener

        public org.apache.pulsar.client.api.ConsumerBuilder<T> messageListener​(@NonNull
                                                                       @NonNull org.apache.pulsar.client.api.MessageListener<T> messageListener)
        Specified by:
        messageListener in interface org.apache.pulsar.client.api.ConsumerBuilder<T>

      • consumerEventListener

        public org.apache.pulsar.client.api.ConsumerBuilder<T> consumerEventListener​(@NonNull
                                                                             @NonNull org.apache.pulsar.client.api.ConsumerEventListener consumerEventListener)
        Specified by:
        consumerEventListener in interface org.apache.pulsar.client.api.ConsumerBuilder<T>

      • cryptoKeyReader

        public org.apache.pulsar.client.api.ConsumerBuilder<T> cryptoKeyReader​(@NonNull
                                                                       @NonNull org.apache.pulsar.client.api.CryptoKeyReader cryptoKeyReader)
        Specified by:
        cryptoKeyReader in interface org.apache.pulsar.client.api.ConsumerBuilder<T>

      • defaultCryptoKeyReader

        public org.apache.pulsar.client.api.ConsumerBuilder<T> defaultCryptoKeyReader​(java.lang.String privateKey)
        Specified by:
        defaultCryptoKeyReader in interface org.apache.pulsar.client.api.ConsumerBuilder<T>

      • defaultCryptoKeyReader

        public org.apache.pulsar.client.api.ConsumerBuilder<T> defaultCryptoKeyReader​(@NonNull
                                                                              @NonNull java.util.Map<java.lang.String,​java.lang.String> privateKeys)
        Specified by:
        defaultCryptoKeyReader in interface org.apache.pulsar.client.api.ConsumerBuilder<T>

      • messageCrypto

        public org.apache.pulsar.client.api.ConsumerBuilder<T> messageCrypto​(@NonNull
                                                                     @NonNull org.apache.pulsar.client.api.MessageCrypto messageCrypto)
        Specified by:
        messageCrypto in interface org.apache.pulsar.client.api.ConsumerBuilder<T>

      • cryptoFailureAction

        public org.apache.pulsar.client.api.ConsumerBuilder<T> cryptoFailureAction​(@NonNull
                                                                           @NonNull org.apache.pulsar.client.api.ConsumerCryptoFailureAction action)
        Specified by:
        cryptoFailureAction in interface org.apache.pulsar.client.api.ConsumerBuilder<T>

      • receiverQueueSize

        public org.apache.pulsar.client.api.ConsumerBuilder<T> receiverQueueSize​(int receiverQueueSize)
        Specified by:
        receiverQueueSize in interface org.apache.pulsar.client.api.ConsumerBuilder<T>

      • acknowledgmentGroupTime

        public org.apache.pulsar.client.api.ConsumerBuilder<T> acknowledgmentGroupTime​(long delay,
                                                                               java.util.concurrent.TimeUnit unit)
        Specified by:
        acknowledgmentGroupTime in interface org.apache.pulsar.client.api.ConsumerBuilder<T>

      • consumerName

        public org.apache.pulsar.client.api.ConsumerBuilder<T> consumerName​(java.lang.String consumerName)
        Specified by:
        consumerName in interface org.apache.pulsar.client.api.ConsumerBuilder<T>

      • priorityLevel

        public org.apache.pulsar.client.api.ConsumerBuilder<T> priorityLevel​(int priorityLevel)
        Specified by:
        priorityLevel in interface org.apache.pulsar.client.api.ConsumerBuilder<T>

      • maxPendingChuckedMessage

        public org.apache.pulsar.client.api.ConsumerBuilder<T> maxPendingChuckedMessage​(int maxPendingChuckedMessage)
        Specified by:
        maxPendingChuckedMessage in interface org.apache.pulsar.client.api.ConsumerBuilder<T>

      • maxPendingChunkedMessage

        public org.apache.pulsar.client.api.ConsumerBuilder<T> maxPendingChunkedMessage​(int maxPendingChunkedMessage)
        Specified by:
        maxPendingChunkedMessage in interface org.apache.pulsar.client.api.ConsumerBuilder<T>

      • autoAckOldestChunkedMessageOnQueueFull

        public org.apache.pulsar.client.api.ConsumerBuilder<T> autoAckOldestChunkedMessageOnQueueFull​(boolean autoAckOldestChunkedMessageOnQueueFull)
        Specified by:
        autoAckOldestChunkedMessageOnQueueFull in interface org.apache.pulsar.client.api.ConsumerBuilder<T>

      • property

        public org.apache.pulsar.client.api.ConsumerBuilder<T> property​(java.lang.String key,
                                                                java.lang.String value)
        Specified by:
        property in interface org.apache.pulsar.client.api.ConsumerBuilder<T>

      • properties

        public org.apache.pulsar.client.api.ConsumerBuilder<T> properties​(@NonNull
                                                                  @NonNull java.util.Map<java.lang.String,​java.lang.String> properties)
        Specified by:
        properties in interface org.apache.pulsar.client.api.ConsumerBuilder<T>

      • maxTotalReceiverQueueSizeAcrossPartitions

        public org.apache.pulsar.client.api.ConsumerBuilder<T> maxTotalReceiverQueueSizeAcrossPartitions​(int maxTotalReceiverQueueSizeAcrossPartitions)
        Specified by:
        maxTotalReceiverQueueSizeAcrossPartitions in interface org.apache.pulsar.client.api.ConsumerBuilder<T>

      • readCompacted

        public org.apache.pulsar.client.api.ConsumerBuilder<T> readCompacted​(boolean readCompacted)
        Specified by:
        readCompacted in interface org.apache.pulsar.client.api.ConsumerBuilder<T>

      • patternAutoDiscoveryPeriod

        public org.apache.pulsar.client.api.ConsumerBuilder<T> patternAutoDiscoveryPeriod​(int periodInMinutes)
        Specified by:
        patternAutoDiscoveryPeriod in interface org.apache.pulsar.client.api.ConsumerBuilder<T>

      • patternAutoDiscoveryPeriod

        public org.apache.pulsar.client.api.ConsumerBuilder<T> patternAutoDiscoveryPeriod​(int interval,
                                                                                  java.util.concurrent.TimeUnit unit)
        Specified by:
        patternAutoDiscoveryPeriod in interface org.apache.pulsar.client.api.ConsumerBuilder<T>

      • subscriptionInitialPosition

        public org.apache.pulsar.client.api.ConsumerBuilder<T> subscriptionInitialPosition​(@NonNull
                                                                                   @NonNull org.apache.pulsar.client.api.SubscriptionInitialPosition subscriptionInitialPosition)
        Specified by:
        subscriptionInitialPosition in interface org.apache.pulsar.client.api.ConsumerBuilder<T>

      • subscriptionTopicsMode

        public org.apache.pulsar.client.api.ConsumerBuilder<T> subscriptionTopicsMode​(@NonNull
                                                                              @NonNull org.apache.pulsar.client.api.RegexSubscriptionMode mode)
        Specified by:
        subscriptionTopicsMode in interface org.apache.pulsar.client.api.ConsumerBuilder<T>

      • replicateSubscriptionState

        public org.apache.pulsar.client.api.ConsumerBuilder<T> replicateSubscriptionState​(boolean replicateSubscriptionState)
        Specified by:
        replicateSubscriptionState in interface org.apache.pulsar.client.api.ConsumerBuilder<T>

      • intercept

        public org.apache.pulsar.client.api.ConsumerBuilder<T> intercept​(org.apache.pulsar.client.api.ConsumerInterceptor<T>... interceptors)
        Specified by:
        intercept in interface org.apache.pulsar.client.api.ConsumerBuilder<T>

      • deadLetterPolicy

        public org.apache.pulsar.client.api.ConsumerBuilder<T> deadLetterPolicy​(org.apache.pulsar.client.api.DeadLetterPolicy deadLetterPolicy)
        Specified by:
        deadLetterPolicy in interface org.apache.pulsar.client.api.ConsumerBuilder<T>

      • autoUpdatePartitions

        public org.apache.pulsar.client.api.ConsumerBuilder<T> autoUpdatePartitions​(boolean autoUpdate)
        Specified by:
        autoUpdatePartitions in interface org.apache.pulsar.client.api.ConsumerBuilder<T>

      • autoUpdatePartitionsInterval

        public org.apache.pulsar.client.api.ConsumerBuilder<T> autoUpdatePartitionsInterval​(int interval,
                                                                                    java.util.concurrent.TimeUnit unit)
        Specified by:
        autoUpdatePartitionsInterval in interface org.apache.pulsar.client.api.ConsumerBuilder<T>

      • startMessageIdInclusive

        public org.apache.pulsar.client.api.ConsumerBuilder<T> startMessageIdInclusive()
        Specified by:
        startMessageIdInclusive in interface org.apache.pulsar.client.api.ConsumerBuilder<T>

      • batchReceivePolicy

        public org.apache.pulsar.client.api.ConsumerBuilder<T> batchReceivePolicy​(org.apache.pulsar.client.api.BatchReceivePolicy batchReceivePolicy)
        Specified by:
        batchReceivePolicy in interface org.apache.pulsar.client.api.ConsumerBuilder<T>

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • keySharedPolicy

        public org.apache.pulsar.client.api.ConsumerBuilder<T> keySharedPolicy​(org.apache.pulsar.client.api.KeySharedPolicy keySharedPolicy)
        Specified by:
        keySharedPolicy in interface org.apache.pulsar.client.api.ConsumerBuilder<T>

      • enableRetry

        public org.apache.pulsar.client.api.ConsumerBuilder<T> enableRetry​(boolean retryEnable)
        Specified by:
        enableRetry in interface org.apache.pulsar.client.api.ConsumerBuilder<T>

      • enableBatchIndexAcknowledgment

        public org.apache.pulsar.client.api.ConsumerBuilder<T> enableBatchIndexAcknowledgment​(boolean batchIndexAcknowledgmentEnabled)
        Specified by:
        enableBatchIndexAcknowledgment in interface org.apache.pulsar.client.api.ConsumerBuilder<T>

      • expireTimeOfIncompleteChunkedMessage

        public org.apache.pulsar.client.api.ConsumerBuilder<T> expireTimeOfIncompleteChunkedMessage​(long duration,
                                                                                            java.util.concurrent.TimeUnit unit)
        Specified by:
        expireTimeOfIncompleteChunkedMessage in interface org.apache.pulsar.client.api.ConsumerBuilder<T>

      • poolMessages

        public org.apache.pulsar.client.api.ConsumerBuilder<T> poolMessages​(boolean poolMessages)
        Specified by:
        poolMessages in interface org.apache.pulsar.client.api.ConsumerBuilder<T>

      • messagePayloadProcessor

        public org.apache.pulsar.client.api.ConsumerBuilder<T> messagePayloadProcessor​(org.apache.pulsar.client.api.MessagePayloadProcessor payloadProcessor)
        Specified by:
        messagePayloadProcessor in interface org.apache.pulsar.client.api.ConsumerBuilder<T>