This is an automated email from the ASF dual-hosted git repository.
jamesnetherton pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/main by this push:
new 28e63e7ccf2 camel-azure-eventhubs: Tidy up documentation
28e63e7ccf2 is described below
commit 28e63e7ccf26aeca3c092b866772f14c572ec026
Author: James Netherton <[email protected]>
AuthorDate: Wed Aug 21 10:13:45 2024 +0100
camel-azure-eventhubs: Tidy up documentation
---
.../camel/catalog/components/azure-eventhubs.json | 36 +++----
.../component/azure/eventhubs/azure-eventhubs.json | 36 +++----
.../src/main/docs/azure-eventhubs-component.adoc | 103 ++++++++----------
.../azure/eventhubs/EventHubsConfiguration.java | 30 +++---
.../dsl/AzureEventhubsComponentBuilderFactory.java | 44 ++++----
.../dsl/EventHubsEndpointBuilderFactory.java | 120 ++++++++++-----------
.../kotlin/components/AzureEventhubsUriDsl.kt | 40 ++++---
7 files changed, 191 insertions(+), 218 deletions(-)
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/azure-eventhubs.json
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/azure-eventhubs.json
index 6e2ed663b4e..59b76d111af 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/azure-eventhubs.json
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/azure-eventhubs.json
@@ -23,8 +23,8 @@
"remote": true
},
"componentProperties": {
- "amqpRetryOptions": { "index": 0, "kind": "property", "displayName": "Amqp
Retry Options", "group": "common", "label": "common", "required": false,
"type": "object", "javaType": "com.azure.core.amqp.AmqpRetryOptions",
"deprecated": false, "autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Sets the retry policy
for EventHubAsyncClient. If not specified, t [...]
- "amqpTransportType": { "index": 1, "kind": "property", "displayName":
"Amqp Transport Type", "group": "common", "label": "common", "required": false,
"type": "object", "javaType": "com.azure.core.amqp.AmqpTransportType", "enum":
[ "Amqp", "AmqpWebSockets" ], "deprecated": false, "autowired": false,
"secret": false, "defaultValue": "AMQP", "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "S [...]
+ "amqpRetryOptions": { "index": 0, "kind": "property", "displayName": "Amqp
Retry Options", "group": "common", "label": "common", "required": false,
"type": "object", "javaType": "com.azure.core.amqp.AmqpRetryOptions",
"deprecated": false, "autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Sets the retry policy
for EventHubProducerAsyncClient. If not spec [...]
+ "amqpTransportType": { "index": 1, "kind": "property", "displayName":
"Amqp Transport Type", "group": "common", "label": "common", "required": false,
"type": "object", "javaType": "com.azure.core.amqp.AmqpTransportType", "enum":
[ "Amqp", "AmqpWebSockets" ], "deprecated": false, "autowired": false,
"secret": false, "defaultValue": "AMQP", "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "S [...]
"configuration": { "index": 2, "kind": "property", "displayName":
"Configuration", "group": "common", "label": "", "required": false, "type":
"object", "javaType":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"deprecated": false, "autowired": false, "secret": false, "description": "The
component configurations" },
"blobAccessKey": { "index": 3, "kind": "property", "displayName": "Blob
Access Key", "group": "consumer", "label": "consumer", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": true, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "In case you chose the
default BlobCheckpointStore, this sets access key for the associate [...]
"blobAccountName": { "index": 4, "kind": "property", "displayName": "Blob
Account Name", "group": "consumer", "label": "consumer", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "In case you chose the
default BlobCheckpointStore, this sets Azure account name to b [...]
@@ -34,19 +34,19 @@
"checkpointBatchSize": { "index": 8, "kind": "property", "displayName":
"Checkpoint Batch Size", "group": "consumer", "label": "consumer", "required":
false, "type": "integer", "javaType": "int", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": 500, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Sets the batch size
between each checkpoint update. Works jointly w [...]
"checkpointBatchTimeout": { "index": 9, "kind": "property", "displayName":
"Checkpoint Batch Timeout", "group": "consumer", "label": "consumer",
"required": false, "type": "integer", "javaType": "int", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": 5000,
"configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Sets the batch timeout
between each checkpoint update. Works [...]
"checkpointStore": { "index": 10, "kind": "property", "displayName":
"Checkpoint Store", "group": "consumer", "label": "consumer", "required":
false, "type": "object", "javaType":
"com.azure.messaging.eventhubs.CheckpointStore", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": "BlobCheckpointStore",
"configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Sets the Checkpo [...]
- "consumerGroupName": { "index": 11, "kind": "property", "displayName":
"Consumer Group Name", "group": "consumer", "label": "consumer", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": "$Default",
"configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Sets the name of the
consumer group this consumer i [...]
- "eventPosition": { "index": 12, "kind": "property", "displayName": "Event
Position", "group": "consumer", "label": "consumer", "required": false, "type":
"object", "javaType": "java.util.Map<java.lang.String,
com.azure.messaging.eventhubs.models.EventPosition>", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Sets the map containi
[...]
+ "consumerGroupName": { "index": 11, "kind": "property", "displayName":
"Consumer Group Name", "group": "consumer", "label": "consumer", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": "$Default",
"configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Sets the name of the
consumer group this consumer i [...]
+ "eventPosition": { "index": 12, "kind": "property", "displayName": "Event
Position", "group": "consumer", "label": "consumer", "required": false, "type":
"object", "javaType": "java.util.Map<java.lang.String,
com.azure.messaging.eventhubs.models.EventPosition>", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Sets the map containi
[...]
"prefetchCount": { "index": 13, "kind": "property", "displayName":
"Prefetch Count", "group": "consumer", "label": "consumer", "required": false,
"type": "integer", "javaType": "int", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": 500, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Sets the count used by
the receiver to control the number of events the Event H [...]
"lazyStartProducer": { "index": 14, "kind": "property", "displayName":
"Lazy Start Producer", "group": "producer", "label": "producer", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": false, "description":
"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 fai [...]
- "partitionId": { "index": 15, "kind": "property", "displayName":
"Partition Id", "group": "producer", "label": "producer", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Sets the identifier of
the Event Hub partition that the events will be sent to. If the ident [...]
- "partitionKey": { "index": 16, "kind": "property", "displayName":
"Partition Key", "group": "producer", "label": "producer", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Sets a hashing key to be
provided for the batch of events, which instructs the Event Hubs [...]
- "producerAsyncClient": { "index": 17, "kind": "property", "displayName":
"Producer Async Client", "group": "producer", "label": "producer", "required":
false, "type": "object", "javaType":
"com.azure.messaging.eventhubs.EventHubProducerAsyncClient", "deprecated":
false, "deprecationNote": "", "autowired": true, "secret": false,
"configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Sets the Eve [...]
+ "partitionId": { "index": 15, "kind": "property", "displayName":
"Partition Id", "group": "producer", "label": "producer", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Sets the identifier of
the Event Hub partition that the EventData events will be sent to. If [...]
+ "partitionKey": { "index": 16, "kind": "property", "displayName":
"Partition Key", "group": "producer", "label": "producer", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Sets a hashing key to be
provided for the batch of events, which instructs the Event Hubs [...]
+ "producerAsyncClient": { "index": 17, "kind": "property", "displayName":
"Producer Async Client", "group": "producer", "label": "producer", "required":
false, "type": "object", "javaType":
"com.azure.messaging.eventhubs.EventHubProducerAsyncClient", "deprecated":
false, "deprecationNote": "", "autowired": true, "secret": false,
"configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Sets the Eve [...]
"autowiredEnabled": { "index": 18, "kind": "property", "displayName":
"Autowired Enabled", "group": "advanced", "label": "advanced", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": true, "description":
"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 [...]
- "connectionString": { "index": 19, "kind": "property", "displayName":
"Connection String", "group": "security", "label": "security", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": true, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Instead of supplying
namespace, sharedAccessKey, sharedAccessName, etc, you can sup [...]
+ "connectionString": { "index": 19, "kind": "property", "displayName":
"Connection String", "group": "security", "label": "security", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": true, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Instead of supplying
namespace, sharedAccessKey, sharedAccessName, etc. you can sup [...]
"credentialType": { "index": 20, "kind": "property", "displayName":
"Credential Type", "group": "security", "label": "security", "required": false,
"type": "object", "javaType":
"org.apache.camel.component.azure.eventhubs.CredentialType", "enum": [
"AZURE_IDENTITY", "CONNECTION_STRING", "TOKEN_CREDENTIAL" ], "deprecated":
false, "autowired": false, "secret": false, "defaultValue":
"CONNECTION_STRING", "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfigur [...]
"sharedAccessKey": { "index": 21, "kind": "property", "displayName":
"Shared Access Key", "group": "security", "label": "security", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": true, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "The generated value for
the SharedAccessName." },
"sharedAccessName": { "index": 22, "kind": "property", "displayName":
"Shared Access Name", "group": "security", "label": "security", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "The name you chose for
your EventHubs SAS keys." },
- "tokenCredential": { "index": 23, "kind": "property", "displayName":
"Token Credential", "group": "security", "label": "security", "required":
false, "type": "object", "javaType":
"com.azure.core.credential.TokenCredential", "deprecated": false, "autowired":
false, "secret": true, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Still another way of
authentication (beside supplying namesp [...]
+ "tokenCredential": { "index": 23, "kind": "property", "displayName":
"Token Credential", "group": "security", "label": "security", "required":
false, "type": "object", "javaType":
"com.azure.core.credential.TokenCredential", "deprecated": false, "autowired":
false, "secret": true, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Provide custom
authentication credentials using an implement [...]
},
"headers": {
"CamelAzureEventHubsPartitionKey": { "index": 0, "kind": "header",
"displayName": "", "group": "common", "label": "", "required": false,
"javaType": "String", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "description": "(producer) Overrides the hashing key to
be provided for the batch of events, which instructs the Event Hubs service to
map this key to a specific partition. (consumer) It sets the partition hashing
key if it was set when originally [...]
@@ -61,8 +61,8 @@
"properties": {
"namespace": { "index": 0, "kind": "path", "displayName": "Namespace",
"group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "EventHubs namespace
created in Azure Portal." },
"eventHubName": { "index": 1, "kind": "path", "displayName": "Event Hub
Name", "group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "EventHubs name under a
specific namespace." },
- "amqpRetryOptions": { "index": 2, "kind": "parameter", "displayName":
"Amqp Retry Options", "group": "common", "label": "common", "required": false,
"type": "object", "javaType": "com.azure.core.amqp.AmqpRetryOptions",
"deprecated": false, "autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Sets the retry policy
for EventHubAsyncClient. If not specified, [...]
- "amqpTransportType": { "index": 3, "kind": "parameter", "displayName":
"Amqp Transport Type", "group": "common", "label": "common", "required": false,
"type": "object", "javaType": "com.azure.core.amqp.AmqpTransportType", "enum":
[ "Amqp", "AmqpWebSockets" ], "deprecated": false, "autowired": false,
"secret": false, "defaultValue": "AMQP", "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": " [...]
+ "amqpRetryOptions": { "index": 2, "kind": "parameter", "displayName":
"Amqp Retry Options", "group": "common", "label": "common", "required": false,
"type": "object", "javaType": "com.azure.core.amqp.AmqpRetryOptions",
"deprecated": false, "autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Sets the retry policy
for EventHubProducerAsyncClient. If not spe [...]
+ "amqpTransportType": { "index": 3, "kind": "parameter", "displayName":
"Amqp Transport Type", "group": "common", "label": "common", "required": false,
"type": "object", "javaType": "com.azure.core.amqp.AmqpTransportType", "enum":
[ "Amqp", "AmqpWebSockets" ], "deprecated": false, "autowired": false,
"secret": false, "defaultValue": "AMQP", "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": " [...]
"blobAccessKey": { "index": 4, "kind": "parameter", "displayName": "Blob
Access Key", "group": "consumer", "label": "consumer", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": true, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "In case you chose the
default BlobCheckpointStore, this sets access key for the associat [...]
"blobAccountName": { "index": 5, "kind": "parameter", "displayName": "Blob
Account Name", "group": "consumer", "label": "consumer", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "In case you chose the
default BlobCheckpointStore, this sets Azure account name to [...]
"blobContainerName": { "index": 6, "kind": "parameter", "displayName":
"Blob Container Name", "group": "consumer", "label": "consumer", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "In case you chose the
default BlobCheckpointStore, this sets the blob container [...]
@@ -70,20 +70,20 @@
"checkpointBatchSize": { "index": 8, "kind": "parameter", "displayName":
"Checkpoint Batch Size", "group": "consumer", "label": "consumer", "required":
false, "type": "integer", "javaType": "int", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": 500, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Sets the batch size
between each checkpoint update. Works jointly [...]
"checkpointBatchTimeout": { "index": 9, "kind": "parameter",
"displayName": "Checkpoint Batch Timeout", "group": "consumer", "label":
"consumer", "required": false, "type": "integer", "javaType": "int",
"deprecated": false, "autowired": false, "secret": false, "defaultValue": 5000,
"configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Sets the batch timeout
between each checkpoint update. Work [...]
"checkpointStore": { "index": 10, "kind": "parameter", "displayName":
"Checkpoint Store", "group": "consumer", "label": "consumer", "required":
false, "type": "object", "javaType":
"com.azure.messaging.eventhubs.CheckpointStore", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": "BlobCheckpointStore",
"configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Sets the Checkp [...]
- "consumerGroupName": { "index": 11, "kind": "parameter", "displayName":
"Consumer Group Name", "group": "consumer", "label": "consumer", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": "$Default",
"configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Sets the name of the
consumer group this consumer [...]
- "eventPosition": { "index": 12, "kind": "parameter", "displayName": "Event
Position", "group": "consumer", "label": "consumer", "required": false, "type":
"object", "javaType": "java.util.Map<java.lang.String,
com.azure.messaging.eventhubs.models.EventPosition>", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Sets the map contain
[...]
+ "consumerGroupName": { "index": 11, "kind": "parameter", "displayName":
"Consumer Group Name", "group": "consumer", "label": "consumer", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": "$Default",
"configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Sets the name of the
consumer group this consumer [...]
+ "eventPosition": { "index": 12, "kind": "parameter", "displayName": "Event
Position", "group": "consumer", "label": "consumer", "required": false, "type":
"object", "javaType": "java.util.Map<java.lang.String,
com.azure.messaging.eventhubs.models.EventPosition>", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Sets the map contain
[...]
"prefetchCount": { "index": 13, "kind": "parameter", "displayName":
"Prefetch Count", "group": "consumer", "label": "consumer", "required": false,
"type": "integer", "javaType": "int", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": 500, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Sets the count used by
the receiver to control the number of events the Event [...]
"bridgeErrorHandler": { "index": 14, "kind": "parameter", "displayName":
"Bridge Error Handler", "group": "consumer (advanced)", "label":
"consumer,advanced", "required": false, "type": "boolean", "javaType":
"boolean", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": false, "description": "Allows for bridging the consumer to the
Camel routing Error Handler, which mean any exceptions (if possible) occurred
while the Camel consumer is trying to pickup incoming [...]
"exceptionHandler": { "index": 15, "kind": "parameter", "displayName":
"Exception Handler", "group": "consumer (advanced)", "label":
"consumer,advanced", "required": false, "type": "object", "javaType":
"org.apache.camel.spi.ExceptionHandler", "optionalPrefix": "consumer.",
"deprecated": false, "autowired": false, "secret": false, "description": "To
let the consumer use a custom ExceptionHandler. Notice if the option
bridgeErrorHandler is enabled then this option is not in use. By de [...]
"exchangePattern": { "index": 16, "kind": "parameter", "displayName":
"Exchange Pattern", "group": "consumer (advanced)", "label":
"consumer,advanced", "required": false, "type": "object", "javaType":
"org.apache.camel.ExchangePattern", "enum": [ "InOnly", "InOut" ],
"deprecated": false, "autowired": false, "secret": false, "description": "Sets
the exchange pattern when the consumer creates an exchange." },
- "partitionId": { "index": 17, "kind": "parameter", "displayName":
"Partition Id", "group": "producer", "label": "producer", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Sets the identifier of
the Event Hub partition that the events will be sent to. If the iden [...]
- "partitionKey": { "index": 18, "kind": "parameter", "displayName":
"Partition Key", "group": "producer", "label": "producer", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Sets a hashing key to be
provided for the batch of events, which instructs the Event Hubs [...]
- "producerAsyncClient": { "index": 19, "kind": "parameter", "displayName":
"Producer Async Client", "group": "producer", "label": "producer", "required":
false, "type": "object", "javaType":
"com.azure.messaging.eventhubs.EventHubProducerAsyncClient", "deprecated":
false, "deprecationNote": "", "autowired": true, "secret": false,
"configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Sets the Ev [...]
+ "partitionId": { "index": 17, "kind": "parameter", "displayName":
"Partition Id", "group": "producer", "label": "producer", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Sets the identifier of
the Event Hub partition that the EventData events will be sent to. I [...]
+ "partitionKey": { "index": 18, "kind": "parameter", "displayName":
"Partition Key", "group": "producer", "label": "producer", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Sets a hashing key to be
provided for the batch of events, which instructs the Event Hubs [...]
+ "producerAsyncClient": { "index": 19, "kind": "parameter", "displayName":
"Producer Async Client", "group": "producer", "label": "producer", "required":
false, "type": "object", "javaType":
"com.azure.messaging.eventhubs.EventHubProducerAsyncClient", "deprecated":
false, "deprecationNote": "", "autowired": true, "secret": false,
"configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Sets the Ev [...]
"lazyStartProducer": { "index": 20, "kind": "parameter", "displayName":
"Lazy Start Producer", "group": "producer (advanced)", "label":
"producer,advanced", "required": false, "type": "boolean", "javaType":
"boolean", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": false, "description": "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 produ [...]
- "connectionString": { "index": 21, "kind": "parameter", "displayName":
"Connection String", "group": "security", "label": "security", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": true, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Instead of supplying
namespace, sharedAccessKey, sharedAccessName, etc, you can su [...]
+ "connectionString": { "index": 21, "kind": "parameter", "displayName":
"Connection String", "group": "security", "label": "security", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": true, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Instead of supplying
namespace, sharedAccessKey, sharedAccessName, etc. you can su [...]
"credentialType": { "index": 22, "kind": "parameter", "displayName":
"Credential Type", "group": "security", "label": "security", "required": false,
"type": "object", "javaType":
"org.apache.camel.component.azure.eventhubs.CredentialType", "enum": [
"AZURE_IDENTITY", "CONNECTION_STRING", "TOKEN_CREDENTIAL" ], "deprecated":
false, "autowired": false, "secret": false, "defaultValue":
"CONNECTION_STRING", "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfigu [...]
"sharedAccessKey": { "index": 23, "kind": "parameter", "displayName":
"Shared Access Key", "group": "security", "label": "security", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": true, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "The generated value for
the SharedAccessName." },
"sharedAccessName": { "index": 24, "kind": "parameter", "displayName":
"Shared Access Name", "group": "security", "label": "security", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "The name you chose for
your EventHubs SAS keys." },
- "tokenCredential": { "index": 25, "kind": "parameter", "displayName":
"Token Credential", "group": "security", "label": "security", "required":
false, "type": "object", "javaType":
"com.azure.core.credential.TokenCredential", "deprecated": false, "autowired":
false, "secret": true, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Still another way of
authentication (beside supplying names [...]
+ "tokenCredential": { "index": 25, "kind": "parameter", "displayName":
"Token Credential", "group": "security", "label": "security", "required":
false, "type": "object", "javaType":
"com.azure.core.credential.TokenCredential", "deprecated": false, "autowired":
false, "secret": true, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Provide custom
authentication credentials using an implemen [...]
}
}
diff --git
a/components/camel-azure/camel-azure-eventhubs/src/generated/resources/META-INF/org/apache/camel/component/azure/eventhubs/azure-eventhubs.json
b/components/camel-azure/camel-azure-eventhubs/src/generated/resources/META-INF/org/apache/camel/component/azure/eventhubs/azure-eventhubs.json
index 6e2ed663b4e..59b76d111af 100644
---
a/components/camel-azure/camel-azure-eventhubs/src/generated/resources/META-INF/org/apache/camel/component/azure/eventhubs/azure-eventhubs.json
+++
b/components/camel-azure/camel-azure-eventhubs/src/generated/resources/META-INF/org/apache/camel/component/azure/eventhubs/azure-eventhubs.json
@@ -23,8 +23,8 @@
"remote": true
},
"componentProperties": {
- "amqpRetryOptions": { "index": 0, "kind": "property", "displayName": "Amqp
Retry Options", "group": "common", "label": "common", "required": false,
"type": "object", "javaType": "com.azure.core.amqp.AmqpRetryOptions",
"deprecated": false, "autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Sets the retry policy
for EventHubAsyncClient. If not specified, t [...]
- "amqpTransportType": { "index": 1, "kind": "property", "displayName":
"Amqp Transport Type", "group": "common", "label": "common", "required": false,
"type": "object", "javaType": "com.azure.core.amqp.AmqpTransportType", "enum":
[ "Amqp", "AmqpWebSockets" ], "deprecated": false, "autowired": false,
"secret": false, "defaultValue": "AMQP", "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "S [...]
+ "amqpRetryOptions": { "index": 0, "kind": "property", "displayName": "Amqp
Retry Options", "group": "common", "label": "common", "required": false,
"type": "object", "javaType": "com.azure.core.amqp.AmqpRetryOptions",
"deprecated": false, "autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Sets the retry policy
for EventHubProducerAsyncClient. If not spec [...]
+ "amqpTransportType": { "index": 1, "kind": "property", "displayName":
"Amqp Transport Type", "group": "common", "label": "common", "required": false,
"type": "object", "javaType": "com.azure.core.amqp.AmqpTransportType", "enum":
[ "Amqp", "AmqpWebSockets" ], "deprecated": false, "autowired": false,
"secret": false, "defaultValue": "AMQP", "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "S [...]
"configuration": { "index": 2, "kind": "property", "displayName":
"Configuration", "group": "common", "label": "", "required": false, "type":
"object", "javaType":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"deprecated": false, "autowired": false, "secret": false, "description": "The
component configurations" },
"blobAccessKey": { "index": 3, "kind": "property", "displayName": "Blob
Access Key", "group": "consumer", "label": "consumer", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": true, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "In case you chose the
default BlobCheckpointStore, this sets access key for the associate [...]
"blobAccountName": { "index": 4, "kind": "property", "displayName": "Blob
Account Name", "group": "consumer", "label": "consumer", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "In case you chose the
default BlobCheckpointStore, this sets Azure account name to b [...]
@@ -34,19 +34,19 @@
"checkpointBatchSize": { "index": 8, "kind": "property", "displayName":
"Checkpoint Batch Size", "group": "consumer", "label": "consumer", "required":
false, "type": "integer", "javaType": "int", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": 500, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Sets the batch size
between each checkpoint update. Works jointly w [...]
"checkpointBatchTimeout": { "index": 9, "kind": "property", "displayName":
"Checkpoint Batch Timeout", "group": "consumer", "label": "consumer",
"required": false, "type": "integer", "javaType": "int", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": 5000,
"configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Sets the batch timeout
between each checkpoint update. Works [...]
"checkpointStore": { "index": 10, "kind": "property", "displayName":
"Checkpoint Store", "group": "consumer", "label": "consumer", "required":
false, "type": "object", "javaType":
"com.azure.messaging.eventhubs.CheckpointStore", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": "BlobCheckpointStore",
"configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Sets the Checkpo [...]
- "consumerGroupName": { "index": 11, "kind": "property", "displayName":
"Consumer Group Name", "group": "consumer", "label": "consumer", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": "$Default",
"configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Sets the name of the
consumer group this consumer i [...]
- "eventPosition": { "index": 12, "kind": "property", "displayName": "Event
Position", "group": "consumer", "label": "consumer", "required": false, "type":
"object", "javaType": "java.util.Map<java.lang.String,
com.azure.messaging.eventhubs.models.EventPosition>", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Sets the map containi
[...]
+ "consumerGroupName": { "index": 11, "kind": "property", "displayName":
"Consumer Group Name", "group": "consumer", "label": "consumer", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": "$Default",
"configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Sets the name of the
consumer group this consumer i [...]
+ "eventPosition": { "index": 12, "kind": "property", "displayName": "Event
Position", "group": "consumer", "label": "consumer", "required": false, "type":
"object", "javaType": "java.util.Map<java.lang.String,
com.azure.messaging.eventhubs.models.EventPosition>", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Sets the map containi
[...]
"prefetchCount": { "index": 13, "kind": "property", "displayName":
"Prefetch Count", "group": "consumer", "label": "consumer", "required": false,
"type": "integer", "javaType": "int", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": 500, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Sets the count used by
the receiver to control the number of events the Event H [...]
"lazyStartProducer": { "index": 14, "kind": "property", "displayName":
"Lazy Start Producer", "group": "producer", "label": "producer", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": false, "description":
"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 fai [...]
- "partitionId": { "index": 15, "kind": "property", "displayName":
"Partition Id", "group": "producer", "label": "producer", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Sets the identifier of
the Event Hub partition that the events will be sent to. If the ident [...]
- "partitionKey": { "index": 16, "kind": "property", "displayName":
"Partition Key", "group": "producer", "label": "producer", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Sets a hashing key to be
provided for the batch of events, which instructs the Event Hubs [...]
- "producerAsyncClient": { "index": 17, "kind": "property", "displayName":
"Producer Async Client", "group": "producer", "label": "producer", "required":
false, "type": "object", "javaType":
"com.azure.messaging.eventhubs.EventHubProducerAsyncClient", "deprecated":
false, "deprecationNote": "", "autowired": true, "secret": false,
"configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Sets the Eve [...]
+ "partitionId": { "index": 15, "kind": "property", "displayName":
"Partition Id", "group": "producer", "label": "producer", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Sets the identifier of
the Event Hub partition that the EventData events will be sent to. If [...]
+ "partitionKey": { "index": 16, "kind": "property", "displayName":
"Partition Key", "group": "producer", "label": "producer", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Sets a hashing key to be
provided for the batch of events, which instructs the Event Hubs [...]
+ "producerAsyncClient": { "index": 17, "kind": "property", "displayName":
"Producer Async Client", "group": "producer", "label": "producer", "required":
false, "type": "object", "javaType":
"com.azure.messaging.eventhubs.EventHubProducerAsyncClient", "deprecated":
false, "deprecationNote": "", "autowired": true, "secret": false,
"configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Sets the Eve [...]
"autowiredEnabled": { "index": 18, "kind": "property", "displayName":
"Autowired Enabled", "group": "advanced", "label": "advanced", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": true, "description":
"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 [...]
- "connectionString": { "index": 19, "kind": "property", "displayName":
"Connection String", "group": "security", "label": "security", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": true, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Instead of supplying
namespace, sharedAccessKey, sharedAccessName, etc, you can sup [...]
+ "connectionString": { "index": 19, "kind": "property", "displayName":
"Connection String", "group": "security", "label": "security", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": true, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Instead of supplying
namespace, sharedAccessKey, sharedAccessName, etc. you can sup [...]
"credentialType": { "index": 20, "kind": "property", "displayName":
"Credential Type", "group": "security", "label": "security", "required": false,
"type": "object", "javaType":
"org.apache.camel.component.azure.eventhubs.CredentialType", "enum": [
"AZURE_IDENTITY", "CONNECTION_STRING", "TOKEN_CREDENTIAL" ], "deprecated":
false, "autowired": false, "secret": false, "defaultValue":
"CONNECTION_STRING", "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfigur [...]
"sharedAccessKey": { "index": 21, "kind": "property", "displayName":
"Shared Access Key", "group": "security", "label": "security", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": true, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "The generated value for
the SharedAccessName." },
"sharedAccessName": { "index": 22, "kind": "property", "displayName":
"Shared Access Name", "group": "security", "label": "security", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "The name you chose for
your EventHubs SAS keys." },
- "tokenCredential": { "index": 23, "kind": "property", "displayName":
"Token Credential", "group": "security", "label": "security", "required":
false, "type": "object", "javaType":
"com.azure.core.credential.TokenCredential", "deprecated": false, "autowired":
false, "secret": true, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Still another way of
authentication (beside supplying namesp [...]
+ "tokenCredential": { "index": 23, "kind": "property", "displayName":
"Token Credential", "group": "security", "label": "security", "required":
false, "type": "object", "javaType":
"com.azure.core.credential.TokenCredential", "deprecated": false, "autowired":
false, "secret": true, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Provide custom
authentication credentials using an implement [...]
},
"headers": {
"CamelAzureEventHubsPartitionKey": { "index": 0, "kind": "header",
"displayName": "", "group": "common", "label": "", "required": false,
"javaType": "String", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "description": "(producer) Overrides the hashing key to
be provided for the batch of events, which instructs the Event Hubs service to
map this key to a specific partition. (consumer) It sets the partition hashing
key if it was set when originally [...]
@@ -61,8 +61,8 @@
"properties": {
"namespace": { "index": 0, "kind": "path", "displayName": "Namespace",
"group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "EventHubs namespace
created in Azure Portal." },
"eventHubName": { "index": 1, "kind": "path", "displayName": "Event Hub
Name", "group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "EventHubs name under a
specific namespace." },
- "amqpRetryOptions": { "index": 2, "kind": "parameter", "displayName":
"Amqp Retry Options", "group": "common", "label": "common", "required": false,
"type": "object", "javaType": "com.azure.core.amqp.AmqpRetryOptions",
"deprecated": false, "autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Sets the retry policy
for EventHubAsyncClient. If not specified, [...]
- "amqpTransportType": { "index": 3, "kind": "parameter", "displayName":
"Amqp Transport Type", "group": "common", "label": "common", "required": false,
"type": "object", "javaType": "com.azure.core.amqp.AmqpTransportType", "enum":
[ "Amqp", "AmqpWebSockets" ], "deprecated": false, "autowired": false,
"secret": false, "defaultValue": "AMQP", "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": " [...]
+ "amqpRetryOptions": { "index": 2, "kind": "parameter", "displayName":
"Amqp Retry Options", "group": "common", "label": "common", "required": false,
"type": "object", "javaType": "com.azure.core.amqp.AmqpRetryOptions",
"deprecated": false, "autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Sets the retry policy
for EventHubProducerAsyncClient. If not spe [...]
+ "amqpTransportType": { "index": 3, "kind": "parameter", "displayName":
"Amqp Transport Type", "group": "common", "label": "common", "required": false,
"type": "object", "javaType": "com.azure.core.amqp.AmqpTransportType", "enum":
[ "Amqp", "AmqpWebSockets" ], "deprecated": false, "autowired": false,
"secret": false, "defaultValue": "AMQP", "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": " [...]
"blobAccessKey": { "index": 4, "kind": "parameter", "displayName": "Blob
Access Key", "group": "consumer", "label": "consumer", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": true, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "In case you chose the
default BlobCheckpointStore, this sets access key for the associat [...]
"blobAccountName": { "index": 5, "kind": "parameter", "displayName": "Blob
Account Name", "group": "consumer", "label": "consumer", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "In case you chose the
default BlobCheckpointStore, this sets Azure account name to [...]
"blobContainerName": { "index": 6, "kind": "parameter", "displayName":
"Blob Container Name", "group": "consumer", "label": "consumer", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "In case you chose the
default BlobCheckpointStore, this sets the blob container [...]
@@ -70,20 +70,20 @@
"checkpointBatchSize": { "index": 8, "kind": "parameter", "displayName":
"Checkpoint Batch Size", "group": "consumer", "label": "consumer", "required":
false, "type": "integer", "javaType": "int", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": 500, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Sets the batch size
between each checkpoint update. Works jointly [...]
"checkpointBatchTimeout": { "index": 9, "kind": "parameter",
"displayName": "Checkpoint Batch Timeout", "group": "consumer", "label":
"consumer", "required": false, "type": "integer", "javaType": "int",
"deprecated": false, "autowired": false, "secret": false, "defaultValue": 5000,
"configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Sets the batch timeout
between each checkpoint update. Work [...]
"checkpointStore": { "index": 10, "kind": "parameter", "displayName":
"Checkpoint Store", "group": "consumer", "label": "consumer", "required":
false, "type": "object", "javaType":
"com.azure.messaging.eventhubs.CheckpointStore", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": "BlobCheckpointStore",
"configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Sets the Checkp [...]
- "consumerGroupName": { "index": 11, "kind": "parameter", "displayName":
"Consumer Group Name", "group": "consumer", "label": "consumer", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": "$Default",
"configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Sets the name of the
consumer group this consumer [...]
- "eventPosition": { "index": 12, "kind": "parameter", "displayName": "Event
Position", "group": "consumer", "label": "consumer", "required": false, "type":
"object", "javaType": "java.util.Map<java.lang.String,
com.azure.messaging.eventhubs.models.EventPosition>", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Sets the map contain
[...]
+ "consumerGroupName": { "index": 11, "kind": "parameter", "displayName":
"Consumer Group Name", "group": "consumer", "label": "consumer", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": "$Default",
"configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Sets the name of the
consumer group this consumer [...]
+ "eventPosition": { "index": 12, "kind": "parameter", "displayName": "Event
Position", "group": "consumer", "label": "consumer", "required": false, "type":
"object", "javaType": "java.util.Map<java.lang.String,
com.azure.messaging.eventhubs.models.EventPosition>", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Sets the map contain
[...]
"prefetchCount": { "index": 13, "kind": "parameter", "displayName":
"Prefetch Count", "group": "consumer", "label": "consumer", "required": false,
"type": "integer", "javaType": "int", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": 500, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Sets the count used by
the receiver to control the number of events the Event [...]
"bridgeErrorHandler": { "index": 14, "kind": "parameter", "displayName":
"Bridge Error Handler", "group": "consumer (advanced)", "label":
"consumer,advanced", "required": false, "type": "boolean", "javaType":
"boolean", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": false, "description": "Allows for bridging the consumer to the
Camel routing Error Handler, which mean any exceptions (if possible) occurred
while the Camel consumer is trying to pickup incoming [...]
"exceptionHandler": { "index": 15, "kind": "parameter", "displayName":
"Exception Handler", "group": "consumer (advanced)", "label":
"consumer,advanced", "required": false, "type": "object", "javaType":
"org.apache.camel.spi.ExceptionHandler", "optionalPrefix": "consumer.",
"deprecated": false, "autowired": false, "secret": false, "description": "To
let the consumer use a custom ExceptionHandler. Notice if the option
bridgeErrorHandler is enabled then this option is not in use. By de [...]
"exchangePattern": { "index": 16, "kind": "parameter", "displayName":
"Exchange Pattern", "group": "consumer (advanced)", "label":
"consumer,advanced", "required": false, "type": "object", "javaType":
"org.apache.camel.ExchangePattern", "enum": [ "InOnly", "InOut" ],
"deprecated": false, "autowired": false, "secret": false, "description": "Sets
the exchange pattern when the consumer creates an exchange." },
- "partitionId": { "index": 17, "kind": "parameter", "displayName":
"Partition Id", "group": "producer", "label": "producer", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Sets the identifier of
the Event Hub partition that the events will be sent to. If the iden [...]
- "partitionKey": { "index": 18, "kind": "parameter", "displayName":
"Partition Key", "group": "producer", "label": "producer", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Sets a hashing key to be
provided for the batch of events, which instructs the Event Hubs [...]
- "producerAsyncClient": { "index": 19, "kind": "parameter", "displayName":
"Producer Async Client", "group": "producer", "label": "producer", "required":
false, "type": "object", "javaType":
"com.azure.messaging.eventhubs.EventHubProducerAsyncClient", "deprecated":
false, "deprecationNote": "", "autowired": true, "secret": false,
"configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Sets the Ev [...]
+ "partitionId": { "index": 17, "kind": "parameter", "displayName":
"Partition Id", "group": "producer", "label": "producer", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Sets the identifier of
the Event Hub partition that the EventData events will be sent to. I [...]
+ "partitionKey": { "index": 18, "kind": "parameter", "displayName":
"Partition Key", "group": "producer", "label": "producer", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Sets a hashing key to be
provided for the batch of events, which instructs the Event Hubs [...]
+ "producerAsyncClient": { "index": 19, "kind": "parameter", "displayName":
"Producer Async Client", "group": "producer", "label": "producer", "required":
false, "type": "object", "javaType":
"com.azure.messaging.eventhubs.EventHubProducerAsyncClient", "deprecated":
false, "deprecationNote": "", "autowired": true, "secret": false,
"configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Sets the Ev [...]
"lazyStartProducer": { "index": 20, "kind": "parameter", "displayName":
"Lazy Start Producer", "group": "producer (advanced)", "label":
"producer,advanced", "required": false, "type": "boolean", "javaType":
"boolean", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": false, "description": "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 produ [...]
- "connectionString": { "index": 21, "kind": "parameter", "displayName":
"Connection String", "group": "security", "label": "security", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": true, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Instead of supplying
namespace, sharedAccessKey, sharedAccessName, etc, you can su [...]
+ "connectionString": { "index": 21, "kind": "parameter", "displayName":
"Connection String", "group": "security", "label": "security", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": true, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Instead of supplying
namespace, sharedAccessKey, sharedAccessName, etc. you can su [...]
"credentialType": { "index": 22, "kind": "parameter", "displayName":
"Credential Type", "group": "security", "label": "security", "required": false,
"type": "object", "javaType":
"org.apache.camel.component.azure.eventhubs.CredentialType", "enum": [
"AZURE_IDENTITY", "CONNECTION_STRING", "TOKEN_CREDENTIAL" ], "deprecated":
false, "autowired": false, "secret": false, "defaultValue":
"CONNECTION_STRING", "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfigu [...]
"sharedAccessKey": { "index": 23, "kind": "parameter", "displayName":
"Shared Access Key", "group": "security", "label": "security", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": true, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "The generated value for
the SharedAccessName." },
"sharedAccessName": { "index": 24, "kind": "parameter", "displayName":
"Shared Access Name", "group": "security", "label": "security", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "The name you chose for
your EventHubs SAS keys." },
- "tokenCredential": { "index": 25, "kind": "parameter", "displayName":
"Token Credential", "group": "security", "label": "security", "required":
false, "type": "object", "javaType":
"com.azure.core.credential.TokenCredential", "deprecated": false, "autowired":
false, "secret": true, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Still another way of
authentication (beside supplying names [...]
+ "tokenCredential": { "index": 25, "kind": "parameter", "displayName":
"Token Credential", "group": "security", "label": "security", "required":
false, "type": "object", "javaType":
"com.azure.core.credential.TokenCredential", "deprecated": false, "autowired":
false, "secret": true, "configurationClass":
"org.apache.camel.component.azure.eventhubs.EventHubsConfiguration",
"configurationField": "configuration", "description": "Provide custom
authentication credentials using an implemen [...]
}
}
diff --git
a/components/camel-azure/camel-azure-eventhubs/src/main/docs/azure-eventhubs-component.adoc
b/components/camel-azure/camel-azure-eventhubs/src/main/docs/azure-eventhubs-component.adoc
index 3a107549a35..e053b0f008d 100644
---
a/components/camel-azure/camel-azure-eventhubs/src/main/docs/azure-eventhubs-component.adoc
+++
b/components/camel-azure/camel-azure-eventhubs/src/main/docs/azure-eventhubs-component.adoc
@@ -15,15 +15,12 @@
*{component-header}*
-The Azure Event Hubs used to integrate
https://azure.microsoft.com/en-us/services/event-hubs/[Azure Event Hubs] using
https://en.wikipedia.org/wiki/Advanced_Message_Queuing_Protocol[AMQP protocol].
+The Azure Event Hubs component provides the capability to produce and consume
events with https://azure.microsoft.com/en-us/services/event-hubs/[Azure Event
Hubs] using the
https://en.wikipedia.org/wiki/Advanced_Message_Queuing_Protocol[AMQP protocol].
Azure EventHubs is a highly scalable publish-subscribe service that can ingest
millions of events per second and stream them to multiple consumers.
-NOTE: Besides AMQP protocol support, Event Hubs as well supports Kafka and
HTTPS protocols. Therefore, you can also use the
xref:components::kafka-component.adoc[Camel Kafka] component to produce and
consume to Azure Event Hubs. You can lean more
https://docs.microsoft.com/en-us/azure/event-hubs/event-hubs-quickstart-kafka-enabled-event-hubs[here].
+*Prerequisites*
-
-Prerequisites
-
-You must have a valid Windows Azure Event Hubs account. More information is
available at
+You must have a valid Microsoft Azure Event Hubs account. More information is
available at the
https://docs.microsoft.com/azure/[Azure Documentation Portal].
Maven users will need to add the following dependency to their `pom.xml`
@@ -46,7 +43,7 @@ for this component:
azure-eventhubs://[namespace/eventHubName][?options]
------------------------------
-In case you supply the `connectionString`, `namespace` and `eventHubName` are
not required as these options already included
+When providing a `connectionString`, the `namespace` and `eventHubName`
options are not required as they are already included
in the `connectionString`
@@ -71,113 +68,101 @@ include::partial$component-endpoint-headers.adoc[]
=== Authentication Information
-You have three different Credential Types: AZURE_IDENTITY, TOKEN_CREDENTIAL
and CONNECTION_STRING. You can also provide a client instance yourself.
-To use this component, you have three options to provide the required Azure
authentication information:
+There are three different Credential Types: `AZURE_IDENTITY`,
`TOKEN_CREDENTIAL` and `CONNECTION_STRING`.
*CONNECTION_STRING*:
-- Provide `sharedAccessName` and `sharedAccessKey` for your Azure Event Hubs
account. The sharedAccessKey can
-be generated through your Event Hubs Azure portal.
-- Provide `connectionString` string, if you provide the connection string, you
don't supply `namespace`, `eventHubName`, `sharedAccessKey` and
`sharedAccessName`
-as these data already included in the `connectionString`, therefore is the
simplest option to get started. Learn more
https://docs.microsoft.com/en-us/azure/event-hubs/event-hubs-get-connection-string[here]
on how to generate the connection string.
+You can either:
+
+- Provide the `connectionString` option. Using this options means that you
don't need to specify additional options `namespace`, `eventHubName`,
`sharedAccessKey` and `sharedAccessName`
+, as this data is already included within the `connectionString`. Learn more
https://docs.microsoft.com/en-us/azure/event-hubs/event-hubs-get-connection-string[here]
on how to generate the connection string.
+
+Or
+
+- Provide `sharedAccessName` and `sharedAccessKey` options for your Azure
Event Hubs account. The `sharedAccessKey` can be generated through the Event
Hubs Azure portal.
+The connection String will then be generated automatically for you by the
azure-eventhubs component.
*TOKEN_CREDENTIAL*:
-- Provide an implementation of `com.azure.core.credential.TokenCredential`
into the Camel's Registry, e.g., using the
`com.azure.identity.DefaultAzureCredentialBuilder().build();` API.
+- Bind an implementation of `com.azure.core.credential.TokenCredential` to the
Camel Registry (see example below).
See the documentation
https://docs.microsoft.com/en-us/azure/active-directory/authentication/overview-authentication[here
about Azure-AD authentication].
*AZURE_IDENTITY*:
-- This will use `com.azure.identity.DefaultAzureCredentialBuilder().build();`
instance. This will follow the Default Azure Credential Chain.
+- This will use an
`com.azure.identity.DefaultAzureCredentialBuilder().build()` instance. This
will follow the Default Azure Credential Chain.
See the documentation
https://docs.microsoft.com/en-us/azure/active-directory/authentication/overview-authentication[here
about Azure-AD authentication].
*Client instance*:
- Provide a
https://docs.microsoft.com/en-us/java/api/com.azure.messaging.eventhubs.eventhubproducerasyncclient?view=azure-java-stable[EventHubProducerAsyncClient]
instance which can be
-provided into `producerAsyncClient`. However, this is *only possible for camel
producer*, for the camel consumer, is not possible to inject the client due to
some design constraint by the `EventProcessorClient`.
+used for the `producerAsyncClient` option. However, this is *only supported
for azure-eventhubs producer*, for the consumer, it is not possible to inject
the client due to some design constraints in the `EventProcessorClient`.
=== Checkpoint Store Information
-A checkpoint store stores and retrieves partition ownership information and
checkpoint details for each partition in a given consumer group of an event hub
instance. Users are not meant to implement a CheckpointStore.
-Users are expected to choose existing implementations of this interface,
instantiate it, and pass it to the component through `checkpointStore` option.
-Users are not expected to use any of the methods on a checkpoint store, these
are used internally by the client.
+A checkpoint store, stores and retrieves partition ownership information and
checkpoint details for each partition in a given consumer group of an event hub
instance. Users are not meant to implement a `CheckpointStore`.
+Users are expected to choose existing implementations of this interface,
instantiate it, and pass it to the component through the `checkpointStore`
option.
-Having said that, if the user does not pass any `CheckpointStore`
implementation, the component will fall back to use
https://docs.microsoft.com/en-us/javascript/api/@azure/eventhubs-checkpointstore-blob/blobcheckpointstore?view=azure-node-latest[`BlobCheckpointStore`]
to store the checkpoint info in the Azure Blob Storage account.
+When no `CheckpointStore` implementation is provided, the azure-eventhubs
component will fall back to use
https://docs.microsoft.com/en-us/javascript/api/@azure/eventhubs-checkpointstore-blob/blobcheckpointstore?view=azure-node-latest[`BlobCheckpointStore`]
to store the checkpoint information in the Azure Blob Storage account.
If you chose to use the default `BlobCheckpointStore`, you will need to supply
the following options:
-- `blobAccountName`: It sets Azure account name to be used for authentication
with azure blob services.
-- `blobAccessKey`: It sets the access key for the associated azure account
name to be used for authentication with azure blob services.
-- `blobContainerName`: It sets the blob container that shall be used by the
BlobCheckpointStore to store the checkpoint offsets.
-
-=== Async Consumer and Producer
-
-This component implements the async Consumer and producer.
-
-This allows camel route to consume and produce events asynchronously without
blocking any threads.
-
-
-== Examples
-
-For example, to consume event from EventHub, use the following snippet:
-
-[source,java]
---------------------------------------------------------------------------------
-from("azure-eventhubs:/camel/camelHub?sharedAccessName=SASaccountName&sharedAccessKey=SASaccessKey&blobAccountName=accountName&blobAccessKey=accessKey&blobContainerName=containerName")
- .to("file://queuedirectory");
---------------------------------------------------------------------------------
+- `blobAccountName`: The Azure account name to be used for authentication with
azure blob services.
+- `blobAccessKey`: The access key for the associated azure account name to be
used for authentication with azure blob services.
+- `blobContainerName`: The name of the blob container that shall be used by
the BlobCheckpointStore to store the checkpoint offsets.
=== Message body type
-The component's producer expects the data in the message body to be in
`byte[]`. This allows the user to utilize Camel TypeConverter to
marshal/unmarshal data with ease.
-The same goes as well for the component's consumer, it will set the encoded
data as `byte[]` in the message body.
+The azure-eventhubs producer expects the data in the message body to be of
type `byte[]`. This allows the simple messages (E.g. `String` based ones) to be
marshalled /unmarshalled with ease.
+The same is true for the azure-eventhubs consumer, it will set the encoded
data as `byte[]` in the message body.
-=== Automatic detection of EventHubProducerAsyncClient client in registry
+=== Automatic detection of EventHubProducerAsyncClient client in the Camel
registry
The component is capable of detecting the presence of an
EventHubProducerAsyncClient bean into the registry.
If it's the only instance of that type, it will be used as the client, and you
won't have to define it as uri parameter, like the example above.
This may be really useful for smarter configuration of the endpoint.
+== Examples
+
=== Consumer Example
-The example below will unmarshal the events that were originally produced in
JSON:
+To consume events:
[source,java]
-----
-from("azure-eventhubs:?connectionString=RAW({{connectionString}})"&blobContainerName=containerTest&eventPosition=#eventPosition"
-
+"&blobAccountName={{blobAccountName}}&blobAccessKey=RAW({{blobAccessKey}})")
-.unmarshal().json(JsonLibrary.Jackson)
-.to(result);
-----
+--------------------------------------------------------------------------------
+from("azure-eventhubs:/camel/camelHub?sharedAccessName=SASaccountName&sharedAccessKey=SASaccessKey&blobAccountName=accountName&blobAccessKey=accessKey&blobContainerName=containerName")
+ .to("file://queuedirectory");
+--------------------------------------------------------------------------------
=== Producer Example
-The example below will send events as String to EventHubs:
+
+To produce events:
[source,java]
----
from("direct:start")
-.process(exchange -> {
+ .process(exchange -> {
exchange.getIn().setHeader(EventHubsConstants.PARTITION_ID,
firstPartition);
exchange.getIn().setBody("test event");
-})
-.to("azure-eventhubs:?connectionString=RAW({{connectionString}})"
+ })
+ .to("azure-eventhubs:?connectionString=RAW({{connectionString}})"
----
-Also, the component supports as well *aggregation* of messages by sending
events as *iterable* of either Exchanges/Messages or normal data (e.g.: list of
Strings). For example:
+The azure-eventhubs producer supports sending sending events as an `Iterable`
(E.g. as a `List`). For example:
[source,java]
----
from("direct:start")
-.process(exchange -> {
+ .process(exchange -> {
final List<String> messages = new LinkedList<>();
messages.add("Test String Message 1");
messages.add("Test String Message 2");
exchange.getIn().setHeader(EventHubsConstants.PARTITION_ID,
firstPartition);
exchange.getIn().setBody(messages);
-})
-.to("azure-eventhubs:?connectionString=RAW({{connectionString}})"
+ })
+ .to("azure-eventhubs:?connectionString=RAW({{connectionString}})"
----
=== Azure-AD Authentication example
+
The example below makes use of the Azure-AD authentication. See
https://docs.microsoft.com/en-us/java/api/overview/azure/identity-readme?view=azure-java-stable#environment-variables[here]
about what environment variables you need to set for this to work:
@@ -189,7 +174,7 @@ public com.azure.core.credential.TokenCredential
myTokenCredential() {
}
from("direct:start")
-.to("azure-eventhubs:namespace/eventHubName?tokenCredential=#myTokenCredential&credentialType=TOKEN_CREDENTIAL)"
+
.to("azure-eventhubs:namespace/eventHubName?tokenCredential=#myTokenCredential&credentialType=TOKEN_CREDENTIAL)"
----
== Important Development Notes
diff --git
a/components/camel-azure/camel-azure-eventhubs/src/main/java/org/apache/camel/component/azure/eventhubs/EventHubsConfiguration.java
b/components/camel-azure/camel-azure-eventhubs/src/main/java/org/apache/camel/component/azure/eventhubs/EventHubsConfiguration.java
index 3b38745f6d7..e761cb4a584 100644
---
a/components/camel-azure/camel-azure-eventhubs/src/main/java/org/apache/camel/component/azure/eventhubs/EventHubsConfiguration.java
+++
b/components/camel-azure/camel-azure-eventhubs/src/main/java/org/apache/camel/component/azure/eventhubs/EventHubsConfiguration.java
@@ -131,9 +131,9 @@ public class EventHubsConfiguration implements Cloneable {
}
/**
- * Instead of supplying namespace, sharedAccessKey, sharedAccessName, etc,
you can supply the connection string for
- * your eventHub. The connection string for EventHubs already includes all
the necessary information to connection
- * to your EventHub. To learn how to generate the connection string, take
a look at this documentation:
+ * Instead of supplying namespace, sharedAccessKey, sharedAccessName, etc.
you can supply the connection string for
+ * your eventHub. The connection string for EventHubs already includes all
the necessary information to connect to
+ * your EventHub. To learn 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
*/
public String getConnectionString() {
@@ -145,8 +145,7 @@ public class EventHubsConfiguration implements Cloneable {
}
/**
- * Still another way of authentication (beside supplying namespace,
sharedAccessKey, sharedAccessName or connection
- * string) is through Azure-AD authentication using an implementation
instance of {@link TokenCredential}.
+ * Provide custom authentication credentials using an implementation of
{@link TokenCredential}.
*/
public TokenCredential getTokenCredential() {
return tokenCredential;
@@ -157,8 +156,7 @@ public class EventHubsConfiguration implements Cloneable {
}
/**
- * Sets the transport type by which all the communication with Azure Event
Hubs occurs. Default value is
- * {@link AmqpTransportType#AMQP}.
+ * Sets the transport type by which all the communication with Azure Event
Hubs occurs.
*/
public AmqpTransportType getAmqpTransportType() {
return amqpTransportType;
@@ -169,7 +167,8 @@ public class EventHubsConfiguration implements Cloneable {
}
/**
- * Sets the retry policy for {@link EventHubAsyncClient}. If not
specified, the default retry options are used.
+ * Sets the retry policy for {@link EventHubProducerAsyncClient}. If not
specified, the default retry options are
+ * used.
*/
public AmqpRetryOptions getAmqpRetryOptions() {
return amqpRetryOptions;
@@ -181,7 +180,7 @@ public class EventHubsConfiguration implements Cloneable {
/**
* 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"}.
+ * group. The name of the consumer group that is created by default is
$Default.
*/
public String getConsumerGroupName() {
return consumerGroupName;
@@ -206,9 +205,9 @@ public class EventHubsConfiguration implements Cloneable {
/**
* Sets the {@link EventHubProducerAsyncClient}.An asynchronous producer
responsible for transmitting
* {@link EventData} to a specific Event Hub, grouped together in batches.
Depending on the
- * {@link CreateBatchOptions 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.
+ * {@link com.azure.messaging.eventhubs.models.CreateBatchOptions} options
specified when creating an
+ * {@link com.azure.messaging.eventhubs.EventDataBatch}, 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.
*/
public EventHubProducerAsyncClient getProducerAsyncClient() {
return producerAsyncClient;
@@ -219,7 +218,7 @@ public class EventHubsConfiguration implements Cloneable {
}
/**
- * Sets the identifier of the Event Hub partition that the {@link
EventData events} will be sent to. If the
+ * Sets the identifier of the Event Hub partition that the {@link
EventData} 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.
*/
@@ -241,8 +240,7 @@ public class EventHubsConfiguration implements Cloneable {
*
* 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.
+ * recommended that the identifier of the position be specified directly
when sending the batch.
*/
public String getPartitionKey() {
return partitionKey;
@@ -324,7 +322,7 @@ public class EventHubsConfiguration implements Cloneable {
* Sets the map containing the event position to use for each partition if
a checkpoint for the partition does not
* exist in {@link CheckpointStore}. This map is keyed off of the
partition id. If there is no checkpoint in
* {@link CheckpointStore} and there is no entry in this map, the
processing of the partition will start from
- * {@link EventPosition#latest() latest} position.
+ * {@link EventPosition#latest()} position.
*/
public Map<String, EventPosition> getEventPosition() {
return eventPosition;
diff --git
a/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/AzureEventhubsComponentBuilderFactory.java
b/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/AzureEventhubsComponentBuilderFactory.java
index 96e3cd763d3..69b6d15214e 100644
---
a/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/AzureEventhubsComponentBuilderFactory.java
+++
b/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/AzureEventhubsComponentBuilderFactory.java
@@ -51,8 +51,8 @@ public interface AzureEventhubsComponentBuilderFactory {
interface AzureEventhubsComponentBuilder extends
ComponentBuilder<EventHubsComponent> {
/**
- * Sets the retry policy for EventHubAsyncClient. If not specified, the
- * default retry options are used.
+ * Sets the retry policy for EventHubProducerAsyncClient. If not
+ * specified, the default retry options are used.
*
* The option is a:
* <code>com.azure.core.amqp.AmqpRetryOptions</code> type.
@@ -70,7 +70,7 @@ public interface AzureEventhubsComponentBuilderFactory {
/**
* Sets the transport type by which all the communication with Azure
- * Event Hubs occurs. Default value is AmqpTransportType#AMQP.
+ * Event Hubs occurs.
*
* The option is a:
* <code>com.azure.core.amqp.AmqpTransportType</code> type.
@@ -261,7 +261,7 @@ public interface AzureEventhubsComponentBuilderFactory {
/**
* 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}.
+ * consumer group that is created by default is $Default.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -281,8 +281,7 @@ public interface AzureEventhubsComponentBuilderFactory {
* 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.
+ * of the partition will start from EventPosition#latest() position.
*
* The option is a: <code>java.util.Map&lt;java.lang.String,
*
com.azure.messaging.eventhubs.models.EventPosition&gt;</code> type.
@@ -342,10 +341,10 @@ public interface AzureEventhubsComponentBuilderFactory {
}
/**
- * 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.
+ * Sets the identifier of the Event Hub partition that the EventData
+ * 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.
*
@@ -369,8 +368,8 @@ public interface AzureEventhubsComponentBuilderFactory {
* 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.
+ * recommended that the identifier of the position be specified
directly
+ * when sending the batch.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -387,10 +386,13 @@ public interface AzureEventhubsComponentBuilderFactory {
/**
* 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.
+ * grouped together in batches. Depending on the
+ * com.azure.messaging.eventhubs.models.CreateBatchOptions options
+ * specified when creating an
+ * com.azure.messaging.eventhubs.EventDataBatch, 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.
@@ -429,10 +431,10 @@ public interface AzureEventhubsComponentBuilderFactory {
/**
* Instead of supplying namespace, sharedAccessKey, sharedAccessName,
- * etc, you can supply the connection string for your eventHub. The
+ * etc. you can supply the connection string for your eventHub. The
* connection string for EventHubs already includes all the necessary
- * information to connection to your EventHub. To learn how to generate
- * the connection string, take a look at this documentation:
+ * information to connect to your EventHub. To learn 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.
@@ -496,9 +498,7 @@ public interface AzureEventhubsComponentBuilderFactory {
}
/**
- * Still another way of authentication (beside supplying namespace,
- * sharedAccessKey, sharedAccessName or connection string) is through
- * Azure-AD authentication using an implementation instance of
+ * Provide custom authentication credentials using an implementation of
* TokenCredential.
*
* The option is a:
diff --git
a/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/EventHubsEndpointBuilderFactory.java
b/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/EventHubsEndpointBuilderFactory.java
index 4be6564390f..903c711415a 100644
---
a/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/EventHubsEndpointBuilderFactory.java
+++
b/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/EventHubsEndpointBuilderFactory.java
@@ -44,8 +44,8 @@ public interface EventHubsEndpointBuilderFactory {
return (AdvancedEventHubsEndpointConsumerBuilder) this;
}
/**
- * Sets the retry policy for EventHubAsyncClient. If not specified, the
- * default retry options are used.
+ * Sets the retry policy for EventHubProducerAsyncClient. If not
+ * specified, the default retry options are used.
*
* The option is a: <code>com.azure.core.amqp.AmqpRetryOptions</code>
* type.
@@ -60,8 +60,8 @@ public interface EventHubsEndpointBuilderFactory {
return this;
}
/**
- * Sets the retry policy for EventHubAsyncClient. If not specified, the
- * default retry options are used.
+ * Sets the retry policy for EventHubProducerAsyncClient. If not
+ * specified, the default retry options are used.
*
* The option will be converted to a
* <code>com.azure.core.amqp.AmqpRetryOptions</code> type.
@@ -77,7 +77,7 @@ public interface EventHubsEndpointBuilderFactory {
}
/**
* Sets the transport type by which all the communication with Azure
- * Event Hubs occurs. Default value is AmqpTransportType#AMQP.
+ * Event Hubs occurs.
*
* The option is a: <code>com.azure.core.amqp.AmqpTransportType</code>
* type.
@@ -94,7 +94,7 @@ public interface EventHubsEndpointBuilderFactory {
}
/**
* Sets the transport type by which all the communication with Azure
- * Event Hubs occurs. Default value is AmqpTransportType#AMQP.
+ * Event Hubs occurs.
*
* The option will be converted to a
* <code>com.azure.core.amqp.AmqpTransportType</code> type.
@@ -301,7 +301,7 @@ public interface EventHubsEndpointBuilderFactory {
/**
* 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}.
+ * consumer group that is created by default is $Default.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -320,8 +320,7 @@ public interface EventHubsEndpointBuilderFactory {
* 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.
+ * of the partition will start from EventPosition#latest() position.
*
* The option is a: <code>java.util.Map<java.lang.String,
* com.azure.messaging.eventhubs.models.EventPosition></code> type.
@@ -340,8 +339,7 @@ public interface EventHubsEndpointBuilderFactory {
* 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.
+ * of the partition will start from EventPosition#latest() position.
*
* The option will be converted to a
* <code>java.util.Map<java.lang.String,
@@ -392,10 +390,10 @@ public interface EventHubsEndpointBuilderFactory {
}
/**
* Instead of supplying namespace, sharedAccessKey, sharedAccessName,
- * etc, you can supply the connection string for your eventHub. The
+ * etc. you can supply the connection string for your eventHub. The
* connection string for EventHubs already includes all the necessary
- * information to connection to your EventHub. To learn how to generate
- * the connection string, take a look at this documentation:
+ * information to connect to your EventHub. To learn 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.
@@ -470,9 +468,7 @@ public interface EventHubsEndpointBuilderFactory {
return this;
}
/**
- * Still another way of authentication (beside supplying namespace,
- * sharedAccessKey, sharedAccessName or connection string) is through
- * Azure-AD authentication using an implementation instance of
+ * Provide custom authentication credentials using an implementation of
* TokenCredential.
*
* The option is a:
@@ -488,9 +484,7 @@ public interface EventHubsEndpointBuilderFactory {
return this;
}
/**
- * Still another way of authentication (beside supplying namespace,
- * sharedAccessKey, sharedAccessName or connection string) is through
- * Azure-AD authentication using an implementation instance of
+ * Provide custom authentication credentials using an implementation of
* TokenCredential.
*
* The option will be converted to a
@@ -646,8 +640,8 @@ public interface EventHubsEndpointBuilderFactory {
}
/**
- * Sets the retry policy for EventHubAsyncClient. If not specified, the
- * default retry options are used.
+ * Sets the retry policy for EventHubProducerAsyncClient. If not
+ * specified, the default retry options are used.
*
* The option is a: <code>com.azure.core.amqp.AmqpRetryOptions</code>
* type.
@@ -662,8 +656,8 @@ public interface EventHubsEndpointBuilderFactory {
return this;
}
/**
- * Sets the retry policy for EventHubAsyncClient. If not specified, the
- * default retry options are used.
+ * Sets the retry policy for EventHubProducerAsyncClient. If not
+ * specified, the default retry options are used.
*
* The option will be converted to a
* <code>com.azure.core.amqp.AmqpRetryOptions</code> type.
@@ -679,7 +673,7 @@ public interface EventHubsEndpointBuilderFactory {
}
/**
* Sets the transport type by which all the communication with Azure
- * Event Hubs occurs. Default value is AmqpTransportType#AMQP.
+ * Event Hubs occurs.
*
* The option is a: <code>com.azure.core.amqp.AmqpTransportType</code>
* type.
@@ -696,7 +690,7 @@ public interface EventHubsEndpointBuilderFactory {
}
/**
* Sets the transport type by which all the communication with Azure
- * Event Hubs occurs. Default value is AmqpTransportType#AMQP.
+ * Event Hubs occurs.
*
* The option will be converted to a
* <code>com.azure.core.amqp.AmqpTransportType</code> type.
@@ -712,10 +706,10 @@ public interface EventHubsEndpointBuilderFactory {
return this;
}
/**
- * 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.
+ * Sets the identifier of the Event Hub partition that the EventData
+ * 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.
*
@@ -738,8 +732,8 @@ public interface EventHubsEndpointBuilderFactory {
* 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.
+ * recommended that the identifier of the position be specified
directly
+ * when sending the batch.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -755,10 +749,13 @@ public interface EventHubsEndpointBuilderFactory {
/**
* 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.
+ * grouped together in batches. Depending on the
+ * com.azure.messaging.eventhubs.models.CreateBatchOptions options
+ * specified when creating an
+ * com.azure.messaging.eventhubs.EventDataBatch, 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.
@@ -775,10 +772,13 @@ public interface EventHubsEndpointBuilderFactory {
/**
* 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.
+ * grouped together in batches. Depending on the
+ * com.azure.messaging.eventhubs.models.CreateBatchOptions options
+ * specified when creating an
+ * com.azure.messaging.eventhubs.EventDataBatch, 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 will be converted to a
*
<code>com.azure.messaging.eventhubs.EventHubProducerAsyncClient</code> type.
@@ -794,10 +794,10 @@ public interface EventHubsEndpointBuilderFactory {
}
/**
* Instead of supplying namespace, sharedAccessKey, sharedAccessName,
- * etc, you can supply the connection string for your eventHub. The
+ * etc. you can supply the connection string for your eventHub. The
* connection string for EventHubs already includes all the necessary
- * information to connection to your EventHub. To learn how to generate
- * the connection string, take a look at this documentation:
+ * information to connect to your EventHub. To learn 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.
@@ -872,9 +872,7 @@ public interface EventHubsEndpointBuilderFactory {
return this;
}
/**
- * Still another way of authentication (beside supplying namespace,
- * sharedAccessKey, sharedAccessName or connection string) is through
- * Azure-AD authentication using an implementation instance of
+ * Provide custom authentication credentials using an implementation of
* TokenCredential.
*
* The option is a:
@@ -890,9 +888,7 @@ public interface EventHubsEndpointBuilderFactory {
return this;
}
/**
- * Still another way of authentication (beside supplying namespace,
- * sharedAccessKey, sharedAccessName or connection string) is through
- * Azure-AD authentication using an implementation instance of
+ * Provide custom authentication credentials using an implementation of
* TokenCredential.
*
* The option will be converted to a
@@ -977,8 +973,8 @@ public interface EventHubsEndpointBuilderFactory {
}
/**
- * Sets the retry policy for EventHubAsyncClient. If not specified, the
- * default retry options are used.
+ * Sets the retry policy for EventHubProducerAsyncClient. If not
+ * specified, the default retry options are used.
*
* The option is a: <code>com.azure.core.amqp.AmqpRetryOptions</code>
* type.
@@ -993,8 +989,8 @@ public interface EventHubsEndpointBuilderFactory {
return this;
}
/**
- * Sets the retry policy for EventHubAsyncClient. If not specified, the
- * default retry options are used.
+ * Sets the retry policy for EventHubProducerAsyncClient. If not
+ * specified, the default retry options are used.
*
* The option will be converted to a
* <code>com.azure.core.amqp.AmqpRetryOptions</code> type.
@@ -1010,7 +1006,7 @@ public interface EventHubsEndpointBuilderFactory {
}
/**
* Sets the transport type by which all the communication with Azure
- * Event Hubs occurs. Default value is AmqpTransportType#AMQP.
+ * Event Hubs occurs.
*
* The option is a: <code>com.azure.core.amqp.AmqpTransportType</code>
* type.
@@ -1027,7 +1023,7 @@ public interface EventHubsEndpointBuilderFactory {
}
/**
* Sets the transport type by which all the communication with Azure
- * Event Hubs occurs. Default value is AmqpTransportType#AMQP.
+ * Event Hubs occurs.
*
* The option will be converted to a
* <code>com.azure.core.amqp.AmqpTransportType</code> type.
@@ -1044,10 +1040,10 @@ public interface EventHubsEndpointBuilderFactory {
}
/**
* Instead of supplying namespace, sharedAccessKey, sharedAccessName,
- * etc, you can supply the connection string for your eventHub. The
+ * etc. you can supply the connection string for your eventHub. The
* connection string for EventHubs already includes all the necessary
- * information to connection to your EventHub. To learn how to generate
- * the connection string, take a look at this documentation:
+ * information to connect to your EventHub. To learn 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.
@@ -1122,9 +1118,7 @@ public interface EventHubsEndpointBuilderFactory {
return this;
}
/**
- * Still another way of authentication (beside supplying namespace,
- * sharedAccessKey, sharedAccessName or connection string) is through
- * Azure-AD authentication using an implementation instance of
+ * Provide custom authentication credentials using an implementation of
* TokenCredential.
*
* The option is a:
@@ -1140,9 +1134,7 @@ public interface EventHubsEndpointBuilderFactory {
return this;
}
/**
- * Still another way of authentication (beside supplying namespace,
- * sharedAccessKey, sharedAccessName or connection string) is through
- * Azure-AD authentication using an implementation instance of
+ * Provide custom authentication credentials using an implementation of
* TokenCredential.
*
* The option will be converted to a
diff --git
a/dsl/camel-kotlin-api/src/generated/kotlin/org/apache/camel/kotlin/components/AzureEventhubsUriDsl.kt
b/dsl/camel-kotlin-api/src/generated/kotlin/org/apache/camel/kotlin/components/AzureEventhubsUriDsl.kt
index 7765f181234..c7be9ab035e 100644
---
a/dsl/camel-kotlin-api/src/generated/kotlin/org/apache/camel/kotlin/components/AzureEventhubsUriDsl.kt
+++
b/dsl/camel-kotlin-api/src/generated/kotlin/org/apache/camel/kotlin/components/AzureEventhubsUriDsl.kt
@@ -62,16 +62,15 @@ public class AzureEventhubsUriDsl(
}
/**
- * Sets the retry policy for EventHubAsyncClient. If not specified, the
default retry options are
- * used.
+ * Sets the retry policy for EventHubProducerAsyncClient. If not specified,
the default retry
+ * options are used.
*/
public fun amqpRetryOptions(amqpRetryOptions: String) {
it.property("amqpRetryOptions", amqpRetryOptions)
}
/**
- * Sets the transport type by which all the communication with Azure Event
Hubs occurs. Default
- * value is AmqpTransportType#AMQP.
+ * Sets the transport type by which all the communication with Azure Event
Hubs occurs.
*/
public fun amqpTransportType(amqpTransportType: String) {
it.property("amqpTransportType", amqpTransportType)
@@ -150,8 +149,7 @@ public class AzureEventhubsUriDsl(
/**
* 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}.
+ * context of this group. The name of the consumer group that is created by
default is $Default.
*/
public fun consumerGroupName(consumerGroupName: String) {
it.property("consumerGroupName", consumerGroupName)
@@ -161,7 +159,7 @@ public class AzureEventhubsUriDsl(
* 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.
+ * partition will start from EventPosition#latest() position.
*/
public fun eventPosition(eventPosition: String) {
it.property("eventPosition", eventPosition)
@@ -232,9 +230,9 @@ public class AzureEventhubsUriDsl(
}
/**
- * 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.
+ * Sets the identifier of the Event Hub partition that the EventData 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.
*/
public fun partitionId(partitionId: String) {
it.property("partitionId", partitionId)
@@ -247,8 +245,8 @@ public class AzureEventhubsUriDsl(
* 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.
+ * to a specific partition, it is recommended that the identifier of the
position be specified
+ * directly when sending the batch.
*/
public fun partitionKey(partitionKey: String) {
it.property("partitionKey", partitionKey)
@@ -256,9 +254,11 @@ public class AzureEventhubsUriDsl(
/**
* 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.
+ * EventData to a specific Event Hub, grouped together in batches. Depending
on the
+ * com.azure.messaging.eventhubs.models.CreateBatchOptions options specified
when creating an
+ * com.azure.messaging.eventhubs.EventDataBatch, 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.
*/
public fun producerAsyncClient(producerAsyncClient: String) {
it.property("producerAsyncClient", producerAsyncClient)
@@ -289,10 +289,10 @@ public class AzureEventhubsUriDsl(
}
/**
- * Instead of supplying namespace, sharedAccessKey, sharedAccessName, etc,
you can supply the
+ * Instead of supplying namespace, sharedAccessKey, sharedAccessName, etc.
you can supply the
* connection string for your eventHub. The connection string for EventHubs
already includes all the
- * necessary information to connection to your EventHub. To learn how to
generate the connection
- * string, take a look at this documentation:
+ * necessary information to connect to your EventHub. To learn 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
*/
public fun connectionString(connectionString: String) {
@@ -321,9 +321,7 @@ public class AzureEventhubsUriDsl(
}
/**
- * Still another way of authentication (beside supplying namespace,
sharedAccessKey,
- * sharedAccessName or connection string) is through Azure-AD authentication
using an implementation
- * instance of TokenCredential.
+ * Provide custom authentication credentials using an implementation of
TokenCredential.
*/
public fun tokenCredential(tokenCredential: String) {
it.property("tokenCredential", tokenCredential)
