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 Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default EventHubsEndpointBuilderFactory.AdvancedEventHubsEndpointConsumerBuilder
advanced()
default EventHubsEndpointBuilderFactory.EventHubsEndpointConsumerBuilder
amqpRetryOptions(com.azure.core.amqp.AmqpRetryOptions amqpRetryOptions)
Sets the retry policy for EventHubAsyncClient.default EventHubsEndpointBuilderFactory.EventHubsEndpointConsumerBuilder
amqpRetryOptions(String amqpRetryOptions)
Sets the retry policy for EventHubAsyncClient.default EventHubsEndpointBuilderFactory.EventHubsEndpointConsumerBuilder
amqpTransportType(com.azure.core.amqp.AmqpTransportType amqpTransportType)
Sets the transport type by which all the communication with Azure Event Hubs occurs.default EventHubsEndpointBuilderFactory.EventHubsEndpointConsumerBuilder
amqpTransportType(String amqpTransportType)
Sets the transport type by which all the communication with Azure Event Hubs occurs.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.default EventHubsEndpointBuilderFactory.EventHubsEndpointConsumerBuilder
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 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.default EventHubsEndpointBuilderFactory.EventHubsEndpointConsumerBuilder
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 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.default EventHubsEndpointBuilderFactory.EventHubsEndpointConsumerBuilder
checkpointStore(com.azure.messaging.eventhubs.CheckpointStore checkpointStore)
Sets the CheckpointStore the EventProcessorClient will use for storing partition ownership and checkpoint information.default EventHubsEndpointBuilderFactory.EventHubsEndpointConsumerBuilder
checkpointStore(String checkpointStore)
Sets the CheckpointStore the EventProcessorClient will use for storing partition ownership and checkpoint information.default EventHubsEndpointBuilderFactory.EventHubsEndpointConsumerBuilder
connectionString(String connectionString)
Instead of supplying namespace, sharedAccessKey, sharedAccessName ...default EventHubsEndpointBuilderFactory.EventHubsEndpointConsumerBuilder
consumerGroupName(String consumerGroupName)
Sets the name of the consumer group this consumer is associated with.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.default EventHubsEndpointBuilderFactory.EventHubsEndpointConsumerBuilder
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 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.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.default EventHubsEndpointBuilderFactory.EventHubsEndpointConsumerBuilder
sharedAccessKey(String sharedAccessKey)
The generated value for the SharedAccessName.default EventHubsEndpointBuilderFactory.EventHubsEndpointConsumerBuilder
sharedAccessName(String sharedAccessName)
The name you chose for your EventHubs SAS keys.default EventHubsEndpointBuilderFactory.EventHubsEndpointConsumerBuilder
tokenCredential(com.azure.core.credential.TokenCredential tokenCredential)
Still another way of authentication (beside supplying namespace, sharedAccessKey, sharedAccessName or connection string) is through Azure-AD authentication using an implementation instance of TokenCredential.default EventHubsEndpointBuilderFactory.EventHubsEndpointConsumerBuilder
tokenCredential(String tokenCredential)
Still another way of authentication (beside supplying namespace, sharedAccessKey, sharedAccessName or connection string) is through Azure-AD authentication using an implementation instance of TokenCredential.
-
-
-
Method Detail
-
advanced
default EventHubsEndpointBuilderFactory.AdvancedEventHubsEndpointConsumerBuilder advanced()
-
amqpRetryOptions
default EventHubsEndpointBuilderFactory.EventHubsEndpointConsumerBuilder 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
-
amqpRetryOptions
default EventHubsEndpointBuilderFactory.EventHubsEndpointConsumerBuilder amqpRetryOptions(String amqpRetryOptions)
Sets the retry policy for EventHubAsyncClient. If not specified, the default retry options are used. The option will be converted to a <code>com.azure.core.amqp.AmqpRetryOptions</code> type. Group: common- Parameters:
amqpRetryOptions
- the value to set- Returns:
- the dsl builder
-
amqpTransportType
default EventHubsEndpointBuilderFactory.EventHubsEndpointConsumerBuilder 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
-
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 <code>com.azure.core.amqp.AmqpTransportType</code> type. Default: AMQP Group: common- Parameters:
amqpTransportType
- the value to set- Returns:
- the dsl builder
-
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: <code>java.lang.String</code> type. Group: consumer- Parameters:
blobAccessKey
- the value to set- Returns:
- the dsl builder
-
blobAccountName
default EventHubsEndpointBuilderFactory.EventHubsEndpointConsumerBuilder 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 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: <code>java.lang.String</code> type. Group: consumer- Parameters:
blobContainerName
- the value to set- Returns:
- the dsl builder
-
blobStorageSharedKeyCredential
default EventHubsEndpointBuilderFactory.EventHubsEndpointConsumerBuilder 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
-
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 <code>com.azure.storage.common.StorageSharedKeyCredential</code> type. Group: consumer- Parameters:
blobStorageSharedKeyCredential
- the value to set- Returns:
- the dsl builder
-
checkpointStore
default EventHubsEndpointBuilderFactory.EventHubsEndpointConsumerBuilder 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
-
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 <code>com.azure.messaging.eventhubs.CheckpointStore</code> type. Default: BlobCheckpointStore Group: consumer- Parameters:
checkpointStore
- the value to set- Returns:
- the dsl builder
-
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 {code $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 EventHubsEndpointBuilderFactory.EventHubsEndpointConsumerBuilder 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<java.lang.String, com.azure.messaging.eventhubs.models.EventPosition></code> type. Group: consumer- Parameters:
eventPosition
- the value to set- Returns:
- the dsl builder
-
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 <code>java.util.Map<java.lang.String, com.azure.messaging.eventhubs.models.EventPosition></code> type. Group: consumer- Parameters:
eventPosition
- the value to set- Returns:
- the dsl builder
-
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: <code>int</code> type. Default: 500 Group: consumer- Parameters:
prefetchCount
- the value to set- Returns:
- the dsl builder
-
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 <code>int</code> type. Default: 500 Group: consumer- Parameters:
prefetchCount
- the value to set- Returns:
- the dsl builder
-
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: <code>java.lang.String</code> type. Group: security- Parameters:
connectionString
- the value to set- Returns:
- the dsl builder
-
sharedAccessKey
default EventHubsEndpointBuilderFactory.EventHubsEndpointConsumerBuilder 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 EventHubsEndpointBuilderFactory.EventHubsEndpointConsumerBuilder 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
-
tokenCredential
default EventHubsEndpointBuilderFactory.EventHubsEndpointConsumerBuilder tokenCredential(com.azure.core.credential.TokenCredential tokenCredential)
Still another way of authentication (beside supplying namespace, sharedAccessKey, sharedAccessName or connection string) is through Azure-AD authentication using an implementation instance of TokenCredential. The option is a: <code>com.azure.core.credential.TokenCredential</code> type. Group: security- Parameters:
tokenCredential
- the value to set- Returns:
- the dsl builder
-
tokenCredential
default EventHubsEndpointBuilderFactory.EventHubsEndpointConsumerBuilder tokenCredential(String tokenCredential)
Still another way of authentication (beside supplying namespace, sharedAccessKey, sharedAccessName or connection string) is through Azure-AD authentication using an implementation instance of TokenCredential. The option will be converted to a <code>com.azure.core.credential.TokenCredential</code> type. Group: security- Parameters:
tokenCredential
- the value to set- Returns:
- the dsl builder
-
-