Package org.apache.camel.builder.endpoint.dsl

Interface PulsarEndpointBuilderFactory.PulsarEndpointProducerBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver
    All Known Subinterfaces:
    PulsarEndpointBuilderFactory.PulsarEndpointBuilder
    Enclosing interface:
    PulsarEndpointBuilderFactory
    public static interface PulsarEndpointBuilderFactory.PulsarEndpointProducerBuilder
extends org.apache.camel.builder.EndpointProducerBuilder
    Builder for endpoint producers for the Pulsar component.

    • Method Detail

      • authenticationClass

        default PulsarEndpointBuilderFactory.PulsarEndpointProducerBuilder authenticationClass​(String authenticationClass)
        The Authentication FQCN to be used while creating the client from URI. The option is a: <code>java.lang.String</code> type. Group: common
        Parameters:
        authenticationClass - the value to set
        Returns:
        the dsl builder

      • authenticationParams

        default PulsarEndpointBuilderFactory.PulsarEndpointProducerBuilder authenticationParams​(String authenticationParams)
        The Authentication Parameters to be used while creating the client from URI. The option is a: <code>java.lang.String</code> type. Group: common
        Parameters:
        authenticationParams - the value to set
        Returns:
        the dsl builder

      • batcherBuilder

        default PulsarEndpointBuilderFactory.PulsarEndpointProducerBuilder batcherBuilder​(Object batcherBuilder)
        Control batching method used by the producer. The option is a: <code>org.apache.pulsar.client.api.BatcherBuilder</code> type. Default: DEFAULT Group: producer
        Parameters:
        batcherBuilder - the value to set
        Returns:
        the dsl builder

      • batcherBuilder

        default PulsarEndpointBuilderFactory.PulsarEndpointProducerBuilder batcherBuilder​(String batcherBuilder)
        Control batching method used by the producer. The option will be converted to a <code>org.apache.pulsar.client.api.BatcherBuilder</code> type. Default: DEFAULT Group: producer
        Parameters:
        batcherBuilder - the value to set
        Returns:
        the dsl builder

      • batchingEnabled

        default PulsarEndpointBuilderFactory.PulsarEndpointProducerBuilder batchingEnabled​(boolean batchingEnabled)
        Control whether automatic batching of messages is enabled for the producer. The option is a: <code>boolean</code> type. Default: true Group: producer
        Parameters:
        batchingEnabled - the value to set
        Returns:
        the dsl builder

      • batchingEnabled

        default PulsarEndpointBuilderFactory.PulsarEndpointProducerBuilder batchingEnabled​(String batchingEnabled)
        Control whether automatic batching of messages is enabled for the producer. The option will be converted to a <code>boolean</code> type. Default: true Group: producer
        Parameters:
        batchingEnabled - the value to set
        Returns:
        the dsl builder

      • batchingMaxMessages

        default PulsarEndpointBuilderFactory.PulsarEndpointProducerBuilder batchingMaxMessages​(int batchingMaxMessages)
        The maximum size to batch messages. The option is a: <code>int</code> type. Default: 1000 Group: producer
        Parameters:
        batchingMaxMessages - the value to set
        Returns:
        the dsl builder

      • batchingMaxMessages

        default PulsarEndpointBuilderFactory.PulsarEndpointProducerBuilder batchingMaxMessages​(String batchingMaxMessages)
        The maximum size to batch messages. The option will be converted to a <code>int</code> type. Default: 1000 Group: producer
        Parameters:
        batchingMaxMessages - the value to set
        Returns:
        the dsl builder

      • batchingMaxPublishDelayMicros

        default PulsarEndpointBuilderFactory.PulsarEndpointProducerBuilder batchingMaxPublishDelayMicros​(long batchingMaxPublishDelayMicros)
        The maximum time period within which the messages sent will be batched if batchingEnabled is true. The option is a: <code>long</code> type. Default: 1000 Group: producer
        Parameters:
        batchingMaxPublishDelayMicros - the value to set
        Returns:
        the dsl builder

      • batchingMaxPublishDelayMicros

        default PulsarEndpointBuilderFactory.PulsarEndpointProducerBuilder batchingMaxPublishDelayMicros​(String batchingMaxPublishDelayMicros)
        The maximum time period within which the messages sent will be batched if batchingEnabled is true. The option will be converted to a <code>long</code> type. Default: 1000 Group: producer
        Parameters:
        batchingMaxPublishDelayMicros - the value to set
        Returns:
        the dsl builder

      • blockIfQueueFull

        default PulsarEndpointBuilderFactory.PulsarEndpointProducerBuilder blockIfQueueFull​(boolean blockIfQueueFull)
        Whether to block the producing thread if pending messages queue is full or to throw a ProducerQueueIsFullError. The option is a: <code>boolean</code> type. Default: false Group: producer
        Parameters:
        blockIfQueueFull - the value to set
        Returns:
        the dsl builder

      • blockIfQueueFull

        default PulsarEndpointBuilderFactory.PulsarEndpointProducerBuilder blockIfQueueFull​(String blockIfQueueFull)
        Whether to block the producing thread if pending messages queue is full or to throw a ProducerQueueIsFullError. The option will be converted to a <code>boolean</code> type. Default: false Group: producer
        Parameters:
        blockIfQueueFull - the value to set
        Returns:
        the dsl builder

      • compressionType

        default PulsarEndpointBuilderFactory.PulsarEndpointProducerBuilder compressionType​(String compressionType)
        Compression type to use. The option will be converted to a <code>org.apache.pulsar.client.api.CompressionType</code> type. Default: NONE Group: producer
        Parameters:
        compressionType - the value to set
        Returns:
        the dsl builder

      • initialSequenceId

        default PulsarEndpointBuilderFactory.PulsarEndpointProducerBuilder initialSequenceId​(long initialSequenceId)
        The first message published will have a sequence Id of initialSequenceId 1. The option is a: <code>long</code> type. Default: -1 Group: producer
        Parameters:
        initialSequenceId - the value to set
        Returns:
        the dsl builder

      • initialSequenceId

        default PulsarEndpointBuilderFactory.PulsarEndpointProducerBuilder initialSequenceId​(String initialSequenceId)
        The first message published will have a sequence Id of initialSequenceId 1. The option will be converted to a <code>long</code> type. Default: -1 Group: producer
        Parameters:
        initialSequenceId - the value to set
        Returns:
        the dsl builder

      • lazyStartProducer

        default PulsarEndpointBuilderFactory.PulsarEndpointProducerBuilder lazyStartProducer​(boolean lazyStartProducer)
        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. The option is a: <code>boolean</code> type. Default: false Group: producer
        Parameters:
        lazyStartProducer - the value to set
        Returns:
        the dsl builder

      • lazyStartProducer

        default PulsarEndpointBuilderFactory.PulsarEndpointProducerBuilder lazyStartProducer​(String lazyStartProducer)
        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. The option will be converted to a <code>boolean</code> type. Default: false Group: producer
        Parameters:
        lazyStartProducer - the value to set
        Returns:
        the dsl builder

      • maxPendingMessages

        default PulsarEndpointBuilderFactory.PulsarEndpointProducerBuilder maxPendingMessages​(int maxPendingMessages)
        Size of the pending massages queue. When the queue is full, by default, any further sends will fail unless blockIfQueueFull=true. The option is a: <code>int</code> type. Default: 1000 Group: producer
        Parameters:
        maxPendingMessages - the value to set
        Returns:
        the dsl builder

      • maxPendingMessages

        default PulsarEndpointBuilderFactory.PulsarEndpointProducerBuilder maxPendingMessages​(String maxPendingMessages)
        Size of the pending massages queue. When the queue is full, by default, any further sends will fail unless blockIfQueueFull=true. The option will be converted to a <code>int</code> type. Default: 1000 Group: producer
        Parameters:
        maxPendingMessages - the value to set
        Returns:
        the dsl builder

      • maxPendingMessagesAcrossPartitions

        default PulsarEndpointBuilderFactory.PulsarEndpointProducerBuilder maxPendingMessagesAcrossPartitions​(int maxPendingMessagesAcrossPartitions)
        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. The option is a: <code>int</code> type. Default: 50000 Group: producer
        Parameters:
        maxPendingMessagesAcrossPartitions - the value to set
        Returns:
        the dsl builder

      • maxPendingMessagesAcrossPartitions

        default PulsarEndpointBuilderFactory.PulsarEndpointProducerBuilder maxPendingMessagesAcrossPartitions​(String maxPendingMessagesAcrossPartitions)
        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. The option will be converted to a <code>int</code> type. Default: 50000 Group: producer
        Parameters:
        maxPendingMessagesAcrossPartitions - the value to set
        Returns:
        the dsl builder

      • messageRouter

        default PulsarEndpointBuilderFactory.PulsarEndpointProducerBuilder messageRouter​(String messageRouter)
        Custom Message Router to use. The option will be converted to a <code>org.apache.pulsar.client.api.MessageRouter</code> type. Group: producer
        Parameters:
        messageRouter - the value to set
        Returns:
        the dsl builder

      • messageRoutingMode

        default PulsarEndpointBuilderFactory.PulsarEndpointProducerBuilder messageRoutingMode​(String messageRoutingMode)
        Message Routing Mode to use. The option will be converted to a <code>org.apache.pulsar.client.api.MessageRoutingMode</code> type. Default: RoundRobinPartition Group: producer
        Parameters:
        messageRoutingMode - the value to set
        Returns:
        the dsl builder

      • producerName

        default PulsarEndpointBuilderFactory.PulsarEndpointProducerBuilder producerName​(String producerName)
        Name of the producer. If unset, lets Pulsar select a unique identifier. The option is a: <code>java.lang.String</code> type. Group: producer
        Parameters:
        producerName - the value to set
        Returns:
        the dsl builder

      • sendTimeoutMs

        default PulsarEndpointBuilderFactory.PulsarEndpointProducerBuilder sendTimeoutMs​(int sendTimeoutMs)
        Send timeout in milliseconds. The option is a: <code>int</code> type. Default: 30000 Group: producer
        Parameters:
        sendTimeoutMs - the value to set
        Returns:
        the dsl builder