org.apache.camel.builder.component.dsl

Interface AzureEventhubsComponentBuilderFactory.AzureEventhubsComponentBuilder

All Superinterfaces:

ComponentBuilder<org.apache.camel.component.azure.eventhubs.EventHubsComponent>

All Known Implementing Classes:

AzureEventhubsComponentBuilderFactory.AzureEventhubsComponentBuilderImpl

Enclosing interface:

AzureEventhubsComponentBuilderFactory

public static interface AzureEventhubsComponentBuilderFactory.AzureEventhubsComponentBuilder
extends ComponentBuilder<org.apache.camel.component.azure.eventhubs.EventHubsComponent>

Builder for the Azure Event Hubs component.

Method Summary

Modifier and Type	Method and Description
default AzureEventhubsComponentBuilderFactory.AzureEventhubsComponentBuilder	amqpRetryOptions(com.azure.core.amqp.AmqpRetryOptions amqpRetryOptions) Sets the retry policy for EventHubAsyncClient.
default AzureEventhubsComponentBuilderFactory.AzureEventhubsComponentBuilder	amqpTransportType(com.azure.core.amqp.AmqpTransportType amqpTransportType) Sets the transport type by which all the communication with Azure Event Hubs occurs.
default AzureEventhubsComponentBuilderFactory.AzureEventhubsComponentBuilder	autowiredEnabled(boolean autowiredEnabled) Whether autowiring is enabled.
default AzureEventhubsComponentBuilderFactory.AzureEventhubsComponentBuilder	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.
default AzureEventhubsComponentBuilderFactory.AzureEventhubsComponentBuilder	blobAccountName(String blobAccountName) In case you chose the default BlobCheckpointStore, this sets Azure account name to be used for authentication with azure blob services.
default AzureEventhubsComponentBuilderFactory.AzureEventhubsComponentBuilder	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.
default AzureEventhubsComponentBuilderFactory.AzureEventhubsComponentBuilder	blobStorageSharedKeyCredential(com.azure.storage.common.StorageSharedKeyCredential blobStorageSharedKeyCredential) In case you chose the default BlobCheckpointStore, StorageSharedKeyCredential can be injected to create the azure client, this holds the important authentication information.
default AzureEventhubsComponentBuilderFactory.AzureEventhubsComponentBuilder	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 AzureEventhubsComponentBuilderFactory.AzureEventhubsComponentBuilder	checkpointStore(com.azure.messaging.eventhubs.CheckpointStore checkpointStore) Sets the CheckpointStore the EventProcessorClient will use for storing partition ownership and checkpoint information.
default AzureEventhubsComponentBuilderFactory.AzureEventhubsComponentBuilder	configuration(org.apache.camel.component.azure.eventhubs.EventHubsConfiguration configuration) The component configurations.
default AzureEventhubsComponentBuilderFactory.AzureEventhubsComponentBuilder	connectionString(String connectionString) Instead of supplying namespace, sharedAccessKey, sharedAccessName ...
default AzureEventhubsComponentBuilderFactory.AzureEventhubsComponentBuilder	consumerGroupName(String consumerGroupName) Sets the name of the consumer group this consumer is associated with.
default AzureEventhubsComponentBuilderFactory.AzureEventhubsComponentBuilder	eventPosition(Map<String,com.azure.messaging.eventhubs.models.EventPosition> eventPosition) Sets the map containing the event position to use for each partition if a checkpoint for the partition does not exist in CheckpointStore.
default AzureEventhubsComponentBuilderFactory.AzureEventhubsComponentBuilder	lazyStartProducer(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message).
default AzureEventhubsComponentBuilderFactory.AzureEventhubsComponentBuilder	partitionId(String partitionId) Sets the identifier of the Event Hub partition that the events will be sent to.
default AzureEventhubsComponentBuilderFactory.AzureEventhubsComponentBuilder	partitionKey(String partitionKey) Sets a hashing key to be provided for the batch of events, which instructs the Event Hubs service to map this key to a specific partition.
default AzureEventhubsComponentBuilderFactory.AzureEventhubsComponentBuilder	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.
default AzureEventhubsComponentBuilderFactory.AzureEventhubsComponentBuilder	producerAsyncClient(com.azure.messaging.eventhubs.EventHubProducerAsyncClient producerAsyncClient) Sets the EventHubProducerAsyncClient.An asynchronous producer responsible for transmitting EventData to a specific Event Hub, grouped together in batches.
default AzureEventhubsComponentBuilderFactory.AzureEventhubsComponentBuilder	sharedAccessKey(String sharedAccessKey) The generated value for the SharedAccessName.
default AzureEventhubsComponentBuilderFactory.AzureEventhubsComponentBuilder	sharedAccessName(String sharedAccessName) The name you chose for your EventHubs SAS keys.

Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder

build, build, doSetProperty, register

Method Detail

amqpRetryOptions

default AzureEventhubsComponentBuilderFactory.AzureEventhubsComponentBuilder amqpRetryOptions(com.azure.core.amqp.AmqpRetryOptions amqpRetryOptions)

Sets the retry policy for EventHubAsyncClient. If not specified, the default retry options are used. The option is a: <code>com.azure.core.amqp.AmqpRetryOptions</code> type. Group: common

Parameters:

amqpRetryOptions - the value to set

Returns:

the dsl builder

amqpTransportType

default AzureEventhubsComponentBuilderFactory.AzureEventhubsComponentBuilder amqpTransportType(com.azure.core.amqp.AmqpTransportType amqpTransportType)

Sets the transport type by which all the communication with Azure Event Hubs occurs. Default value is AmqpTransportType#AMQP. The option is a: <code>com.azure.core.amqp.AmqpTransportType</code> type. Default: AMQP Group: common

Parameters:

amqpTransportType - the value to set

Returns:

the dsl builder

configuration

default AzureEventhubsComponentBuilderFactory.AzureEventhubsComponentBuilder configuration(org.apache.camel.component.azure.eventhubs.EventHubsConfiguration configuration)

The component configurations. The option is a: <code>org.apache.camel.component.azure.eventhubs.EventHubsConfiguration</code> type. Group: common

Parameters:

configuration - the value to set

Returns:

the dsl builder

blobAccessKey

default AzureEventhubsComponentBuilderFactory.AzureEventhubsComponentBuilder 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: <code>java.lang.String</code> type. Group: consumer

Parameters:

blobAccessKey - the value to set

Returns:

the dsl builder

blobAccountName

default AzureEventhubsComponentBuilderFactory.AzureEventhubsComponentBuilder blobAccountName(String blobAccountName)

In case you chose the default BlobCheckpointStore, this sets Azure account name to be used for authentication with azure blob services. The option is a: <code>java.lang.String</code> type. Group: consumer

Parameters:

blobAccountName - the value to set

Returns:

the dsl builder

blobContainerName

default AzureEventhubsComponentBuilderFactory.AzureEventhubsComponentBuilder 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: <code>java.lang.String</code> type. Group: consumer

Parameters:

blobContainerName - the value to set

Returns:

the dsl builder

blobStorageSharedKeyCredential

default AzureEventhubsComponentBuilderFactory.AzureEventhubsComponentBuilder blobStorageSharedKeyCredential(com.azure.storage.common.StorageSharedKeyCredential 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: <code>com.azure.storage.common.StorageSharedKeyCredential</code> type. Group: consumer

Parameters:

blobStorageSharedKeyCredential - the value to set

Returns:

the dsl builder

bridgeErrorHandler

default AzureEventhubsComponentBuilderFactory.AzureEventhubsComponentBuilder 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: <code>boolean</code> type. Default: false Group: consumer

Parameters:

bridgeErrorHandler - the value to set

Returns:

the dsl builder

checkpointStore

default AzureEventhubsComponentBuilderFactory.AzureEventhubsComponentBuilder checkpointStore(com.azure.messaging.eventhubs.CheckpointStore 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: <code>com.azure.messaging.eventhubs.CheckpointStore</code> type. Default: BlobCheckpointStore Group: consumer

Parameters:

checkpointStore - the value to set

Returns:

the dsl builder

consumerGroupName

default AzureEventhubsComponentBuilderFactory.AzureEventhubsComponentBuilder 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: <code>java.lang.String</code> type. Default: $Default Group: consumer

Parameters:

consumerGroupName - the value to set

Returns:

the dsl builder

eventPosition

default AzureEventhubsComponentBuilderFactory.AzureEventhubsComponentBuilder eventPosition(Map<String,com.azure.messaging.eventhubs.models.EventPosition> 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: <code>java.util.Map&lt;java.lang.String, com.azure.messaging.eventhubs.models.EventPosition&gt;</code> type. Group: consumer

Parameters:

eventPosition - the value to set

Returns:

the dsl builder

prefetchCount

default AzureEventhubsComponentBuilderFactory.AzureEventhubsComponentBuilder 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: <code>int</code> type. Default: 500 Group: consumer

Parameters:

prefetchCount - the value to set

Returns:

the dsl builder

lazyStartProducer

default AzureEventhubsComponentBuilderFactory.AzureEventhubsComponentBuilder 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

partitionId

default AzureEventhubsComponentBuilderFactory.AzureEventhubsComponentBuilder partitionId(String partitionId)

Sets the identifier of the Event Hub partition that the events will be sent to. If the identifier is not specified, the Event Hubs service will be responsible for routing events that are sent to an available partition. The option is a: <code>java.lang.String</code> type. Group: producer

Parameters:

partitionId - the value to set

Returns:

the dsl builder

partitionKey

default AzureEventhubsComponentBuilderFactory.AzureEventhubsComponentBuilder partitionKey(String partitionKey)

Sets a hashing key to be provided for the batch of events, which instructs the Event Hubs service to map this key to a specific partition. The selection of a partition is stable for a given partition hashing key. Should any other batches of events be sent using the same exact partition hashing key, the Event Hubs service will route them all to the same partition. This should be specified only when there is a need to group events by partition, but there is flexibility into which partition they are routed. If ensuring that a batch of events is sent only to a specific partition, it is recommended that the {link #setPartitionId(String) identifier of the position be specified directly} when sending the batch. The option is a: <code>java.lang.String</code> type. Group: producer

Parameters:

partitionKey - the value to set

Returns:

the dsl builder

producerAsyncClient

default AzureEventhubsComponentBuilderFactory.AzureEventhubsComponentBuilder producerAsyncClient(com.azure.messaging.eventhubs.EventHubProducerAsyncClient producerAsyncClient)

Sets the EventHubProducerAsyncClient.An asynchronous producer responsible for transmitting EventData to a specific Event Hub, grouped together in batches. Depending on the options specified when creating an {linkEventDataBatch}, the events may be automatically routed to an available partition or specific to a partition. Use by this component to produce the data in camel producer. The option is a: <code>com.azure.messaging.eventhubs.EventHubProducerAsyncClient</code> type. Group: producer

Parameters:

producerAsyncClient - the value to set

Returns:

the dsl builder

autowiredEnabled

default AzureEventhubsComponentBuilderFactory.AzureEventhubsComponentBuilder autowiredEnabled(boolean autowiredEnabled)

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. The option is a: <code>boolean</code> type. Default: true Group: advanced

Parameters:

autowiredEnabled - the value to set

Returns:

the dsl builder

connectionString

default AzureEventhubsComponentBuilderFactory.AzureEventhubsComponentBuilder 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: <code>java.lang.String</code> type. Group: security

Parameters:

connectionString - the value to set

Returns:

the dsl builder

sharedAccessKey

default AzureEventhubsComponentBuilderFactory.AzureEventhubsComponentBuilder sharedAccessKey(String sharedAccessKey)

The generated value for the SharedAccessName. The option is a: <code>java.lang.String</code> type. Group: security

Parameters:

sharedAccessKey - the value to set

Returns:

the dsl builder

sharedAccessName

default AzureEventhubsComponentBuilderFactory.AzureEventhubsComponentBuilder sharedAccessName(String sharedAccessName)

The name you chose for your EventHubs SAS keys. The option is a: <code>java.lang.String</code> type. Group: security

Parameters:

sharedAccessName - the value to set

Returns:

the dsl builder