Interface EventHubsEndpointBuilderFactory.EventHubsEndpointConsumerBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
    All Known Subinterfaces:
    EventHubsEndpointBuilderFactory.EventHubsEndpointBuilder
    Enclosing interface:
    EventHubsEndpointBuilderFactory

    public static interface EventHubsEndpointBuilderFactory.EventHubsEndpointConsumerBuilder
    extends org.apache.camel.builder.EndpointConsumerBuilder
    Builder for endpoint consumers for the Azure Event Hubs component.
    • Method Detail

      • amqpTransportType

        default EventHubsEndpointBuilderFactory.EventHubsEndpointConsumerBuilder amqpTransportType​(String amqpTransportType)
        Sets the transport type by which all the communication with Azure Event Hubs occurs. Default value is AmqpTransportType#AMQP. The option will be converted to a com.azure.core.amqp.AmqpTransportType type. Default: AMQP Group: common
      • autoDiscoverClient

        default EventHubsEndpointBuilderFactory.EventHubsEndpointConsumerBuilder autoDiscoverClient​(boolean autoDiscoverClient)
        Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking. The option is a: boolean type. Default: true Group: common
      • autoDiscoverClient

        default EventHubsEndpointBuilderFactory.EventHubsEndpointConsumerBuilder autoDiscoverClient​(String autoDiscoverClient)
        Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking. The option will be converted to a boolean type. Default: true Group: common
      • blobAccessKey

        default EventHubsEndpointBuilderFactory.EventHubsEndpointConsumerBuilder blobAccessKey​(String blobAccessKey)
        In case you chose the default BlobCheckpointStore, this sets access key for the associated azure account name to be used for authentication with azure blob services. The option is a: java.lang.String type. Group: consumer
      • blobContainerName

        default EventHubsEndpointBuilderFactory.EventHubsEndpointConsumerBuilder blobContainerName​(String blobContainerName)
        In case you chose the default BlobCheckpointStore, this sets the blob container that shall be used by the BlobCheckpointStore to store the checkpoint offsets. The option is a: java.lang.String type. Group: consumer
      • blobStorageSharedKeyCredential

        default EventHubsEndpointBuilderFactory.EventHubsEndpointConsumerBuilder blobStorageSharedKeyCredential​(Object blobStorageSharedKeyCredential)
        In case you chose the default BlobCheckpointStore, StorageSharedKeyCredential can be injected to create the azure client, this holds the important authentication information. The option is a: com.azure.storage.common.StorageSharedKeyCredential type. Group: consumer
      • blobStorageSharedKeyCredential

        default EventHubsEndpointBuilderFactory.EventHubsEndpointConsumerBuilder blobStorageSharedKeyCredential​(String blobStorageSharedKeyCredential)
        In case you chose the default BlobCheckpointStore, StorageSharedKeyCredential can be injected to create the azure client, this holds the important authentication information. The option will be converted to a com.azure.storage.common.StorageSharedKeyCredential type. Group: consumer
      • bridgeErrorHandler

        default EventHubsEndpointBuilderFactory.EventHubsEndpointConsumerBuilder 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 EventHubsEndpointBuilderFactory.EventHubsEndpointConsumerBuilder 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
      • checkpointStore

        default EventHubsEndpointBuilderFactory.EventHubsEndpointConsumerBuilder checkpointStore​(Object checkpointStore)
        Sets the CheckpointStore the EventProcessorClient will use for storing partition ownership and checkpoint information. Users can, optionally, provide their own implementation of CheckpointStore which will store ownership and checkpoint information. By default it set to use com.azure.messaging.eventhubs.checkpointstore.blob.BlobCheckpointStore which stores all checkpoint offsets into Azure Blob Storage. The option is a: com.azure.messaging.eventhubs.CheckpointStore type. Default: BlobCheckpointStore Group: consumer
      • checkpointStore

        default EventHubsEndpointBuilderFactory.EventHubsEndpointConsumerBuilder checkpointStore​(String checkpointStore)
        Sets the CheckpointStore the EventProcessorClient will use for storing partition ownership and checkpoint information. Users can, optionally, provide their own implementation of CheckpointStore which will store ownership and checkpoint information. By default it set to use com.azure.messaging.eventhubs.checkpointstore.blob.BlobCheckpointStore which stores all checkpoint offsets into Azure Blob Storage. The option will be converted to a com.azure.messaging.eventhubs.CheckpointStore type. Default: BlobCheckpointStore Group: consumer
      • consumerGroupName

        default EventHubsEndpointBuilderFactory.EventHubsEndpointConsumerBuilder consumerGroupName​(String consumerGroupName)
        Sets the name of the consumer group this consumer is associated with. Events are read in the context of this group. The name of the consumer group that is created by default is {link #DEFAULT_CONSUMER_GROUP_NAME $Default}. The option is a: java.lang.String type. Default: $Default Group: consumer
      • eventPosition

        default EventHubsEndpointBuilderFactory.EventHubsEndpointConsumerBuilder eventPosition​(Map<String,​Object> eventPosition)
        Sets the map containing the event position to use for each partition if a checkpoint for the partition does not exist in CheckpointStore. This map is keyed off of the partition id. If there is no checkpoint in CheckpointStore and there is no entry in this map, the processing of the partition will start from {link EventPosition#latest() latest} position. The option is a: java.util.Map<java.lang.String, com.azure.messaging.eventhubs.models.EventPosition> type. Group: consumer
      • eventPosition

        default EventHubsEndpointBuilderFactory.EventHubsEndpointConsumerBuilder eventPosition​(String eventPosition)
        Sets the map containing the event position to use for each partition if a checkpoint for the partition does not exist in CheckpointStore. This map is keyed off of the partition id. If there is no checkpoint in CheckpointStore and there is no entry in this map, the processing of the partition will start from {link EventPosition#latest() latest} position. The option will be converted to a java.util.Map<java.lang.String, com.azure.messaging.eventhubs.models.EventPosition> type. Group: consumer
      • prefetchCount

        default EventHubsEndpointBuilderFactory.EventHubsEndpointConsumerBuilder prefetchCount​(int prefetchCount)
        Sets the count used by the receiver to control the number of events the Event Hub consumer will actively receive and queue locally without regard to whether a receive operation is currently active. The option is a: int type. Default: 500 Group: consumer
      • prefetchCount

        default EventHubsEndpointBuilderFactory.EventHubsEndpointConsumerBuilder prefetchCount​(String prefetchCount)
        Sets the count used by the receiver to control the number of events the Event Hub consumer will actively receive and queue locally without regard to whether a receive operation is currently active. The option will be converted to a int type. Default: 500 Group: consumer
      • connectionString

        default EventHubsEndpointBuilderFactory.EventHubsEndpointConsumerBuilder connectionString​(String connectionString)
        Instead of supplying namespace, sharedAccessKey, sharedAccessName ... etc, you can just supply the connection string for your eventHub. The connection string for EventHubs already include all the necessary information to connection to your EventHub. To learn on how to generate the connection string, take a look at this documentation: https://docs.microsoft.com/en-us/azure/event-hubs/event-hubs-get-connection-string. The option is a: java.lang.String type. Group: security