| // kafka-connector options: START |
| [[camel-azure-eventhubs-kafka-connector-sink]] |
| = camel-azure-eventhubs-kafka-connector sink configuration |
| |
| When using camel-azure-eventhubs-kafka-connector as sink make sure to use the following Maven dependency to have support for the connector: |
| |
| [source,xml] |
| ---- |
| <dependency> |
| <groupId>org.apache.camel.kafkaconnector</groupId> |
| <artifactId>camel-azure-eventhubs-kafka-connector</artifactId> |
| <version>x.x.x</version> |
| <!-- use the same version as your Camel Kafka connector version --> |
| </dependency> |
| ---- |
| |
| To use this Sink connector in Kafka connect you'll need to set the following connector.class |
| |
| [source,java] |
| ---- |
| connector.class=org.apache.camel.kafkaconnector.azureeventhubs.CamelAzureeventhubsSinkConnector |
| ---- |
| |
| |
| The camel-azure-eventhubs sink connector supports 26 options, which are listed below. |
| |
| |
| |
| [width="100%",cols="2,5,^1,2",options="header"] |
| |=== |
| | Name | Description | Default | Priority |
| | *camel.sink.path.namespace* | EventHubs namespace created in Azure Portal | null | MEDIUM |
| | *camel.sink.path.eventHubName* | EventHubs name under a specific namcespace | null | MEDIUM |
| | *camel.sink.endpoint.amqpRetryOptions* | Sets the retry policy for EventHubAsyncClient. If not specified, the default retry options are used. | null | MEDIUM |
| | *camel.sink.endpoint.amqpTransportType* | Sets the transport type by which all the communication with Azure Event Hubs occurs. Default value is AmqpTransportType#AMQP. One of: [Amqp] [AmqpWebSockets] | "AMQP" | MEDIUM |
| | *camel.sink.endpoint.autoDiscoverClient* | Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking. | true | MEDIUM |
| | *camel.sink.endpoint.lazyStartProducer* | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. | false | MEDIUM |
| | *camel.sink.endpoint.partitionId* | 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. | null | MEDIUM |
| | *camel.sink.endpoint.partitionKey* | Sets a hashing key to be provided for the batch of events, which instructs the Event Hubs service to map this key to a specific partition. The selection of a partition is stable for a given partition hashing key. Should any other batches of events be sent using the same exact partition hashing key, the Event Hubs service will route them all to the same partition. This should be specified only when there is a need to group events by partition, but there is flexibility into which partition they are routed. If ensuring that a batch of events is sent only to a specific partition, it is recommended that the {link #setPartitionId(String) identifier of the position be specified directly} when sending the batch. | null | MEDIUM |
| | *camel.sink.endpoint.producerAsyncClient* | Sets the EventHubProducerAsyncClient.An asynchronous producer responsible for transmitting 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. | null | MEDIUM |
| | *camel.sink.endpoint.basicPropertyBinding* | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | MEDIUM |
| | *camel.sink.endpoint.synchronous* | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | MEDIUM |
| | *camel.sink.endpoint.connectionString* | Instead of supplying namespace, sharedAccessKey, sharedAccessName ... etc, you can just supply the connection string for your eventHub. The connection string for EventHubs already include all the necessary information to connection to your EventHub. To learn on how to generate the connection string, take a look at this documentation: \https://docs.microsoft.com/en-us/azure/event-hubs/event-hubs-get-connection-string | null | MEDIUM |
| | *camel.sink.endpoint.sharedAccessKey* | The generated value for the SharedAccessName | null | MEDIUM |
| | *camel.sink.endpoint.sharedAccessName* | The name you chose for your EventHubs SAS keys | null | MEDIUM |
| | *camel.component.azure-eventhubs.amqpRetryOptions* | Sets the retry policy for EventHubAsyncClient. If not specified, the default retry options are used. | null | MEDIUM |
| | *camel.component.azure-eventhubs.amqpTransportType* | Sets the transport type by which all the communication with Azure Event Hubs occurs. Default value is AmqpTransportType#AMQP. One of: [Amqp] [AmqpWebSockets] | "AMQP" | MEDIUM |
| | *camel.component.azure-eventhubs.autoDiscoverClient* | Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking. | true | MEDIUM |
| | *camel.component.azure-eventhubs.configuration* | The component configurations | null | MEDIUM |
| | *camel.component.azure-eventhubs.lazyStartProducer* | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. | false | MEDIUM |
| | *camel.component.azure-eventhubs.partitionId* | 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. | null | MEDIUM |
| | *camel.component.azure-eventhubs.partitionKey* | Sets a hashing key to be provided for the batch of events, which instructs the Event Hubs service to map this key to a specific partition. The selection of a partition is stable for a given partition hashing key. Should any other batches of events be sent using the same exact partition hashing key, the Event Hubs service will route them all to the same partition. This should be specified only when there is a need to group events by partition, but there is flexibility into which partition they are routed. If ensuring that a batch of events is sent only to a specific partition, it is recommended that the {link #setPartitionId(String) identifier of the position be specified directly} when sending the batch. | null | MEDIUM |
| | *camel.component.azure-eventhubs.producerAsync Client* | Sets the EventHubProducerAsyncClient.An asynchronous producer responsible for transmitting 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. | null | MEDIUM |
| | *camel.component.azure-eventhubs.basicProperty Binding* | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | MEDIUM |
| | *camel.component.azure-eventhubs.connectionString* | Instead of supplying namespace, sharedAccessKey, sharedAccessName ... etc, you can just supply the connection string for your eventHub. The connection string for EventHubs already include all the necessary information to connection to your EventHub. To learn on how to generate the connection string, take a look at this documentation: \https://docs.microsoft.com/en-us/azure/event-hubs/event-hubs-get-connection-string | null | MEDIUM |
| | *camel.component.azure-eventhubs.sharedAccessKey* | The generated value for the SharedAccessName | null | MEDIUM |
| | *camel.component.azure-eventhubs.sharedAccessName* | The name you chose for your EventHubs SAS keys | null | MEDIUM |
| |=== |
| |
| |
| |
| The camel-azure-eventhubs sink connector has no converters out of the box. |
| |
| |
| |
| |
| |
| The camel-azure-eventhubs sink connector has no transforms out of the box. |
| |
| |
| |
| |
| |
| The camel-azure-eventhubs sink connector has no aggregation strategies out of the box. |
| // kafka-connector options: END |
