org.apache.camel.builder.endpoint.dsl

Interface EventHubsEndpointBuilderFactory.EventHubsEndpointProducerBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver

All Known Subinterfaces:

EventHubsEndpointBuilderFactory.EventHubsEndpointBuilder

Enclosing interface:

EventHubsEndpointBuilderFactory

public static interface EventHubsEndpointBuilderFactory.EventHubsEndpointProducerBuilder
extends org.apache.camel.builder.EndpointProducerBuilder

Builder for endpoint producers for the Azure Event Hubs component.

Method Summary

Modifier and Type	Method and Description
default EventHubsEndpointBuilderFactory.AdvancedEventHubsEndpointProducerBuilder	advanced()
default EventHubsEndpointBuilderFactory.EventHubsEndpointProducerBuilder	amqpRetryOptions(Object amqpRetryOptions) Sets the retry policy for EventHubAsyncClient.
default EventHubsEndpointBuilderFactory.EventHubsEndpointProducerBuilder	amqpRetryOptions(String amqpRetryOptions) Sets the retry policy for EventHubAsyncClient.
default EventHubsEndpointBuilderFactory.EventHubsEndpointProducerBuilder	amqpTransportType(EventHubsEndpointBuilderFactory.AmqpTransportType amqpTransportType) Sets the transport type by which all the communication with Azure Event Hubs occurs.
default EventHubsEndpointBuilderFactory.EventHubsEndpointProducerBuilder	amqpTransportType(String amqpTransportType) Sets the transport type by which all the communication with Azure Event Hubs occurs.
default EventHubsEndpointBuilderFactory.EventHubsEndpointProducerBuilder	connectionString(String connectionString) Instead of supplying namespace, sharedAccessKey, sharedAccessName ...
default EventHubsEndpointBuilderFactory.EventHubsEndpointProducerBuilder	lazyStartProducer(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message).
default EventHubsEndpointBuilderFactory.EventHubsEndpointProducerBuilder	lazyStartProducer(String lazyStartProducer) Whether the producer should be started lazy (on the first message).
default EventHubsEndpointBuilderFactory.EventHubsEndpointProducerBuilder	partitionId(String partitionId) Sets the identifier of the Event Hub partition that the events will be sent to.
default EventHubsEndpointBuilderFactory.EventHubsEndpointProducerBuilder	partitionKey(String partitionKey) Sets a hashing key to be provided for the batch of events, which instructs the Event Hubs service to map this key to a specific partition.
default EventHubsEndpointBuilderFactory.EventHubsEndpointProducerBuilder	producerAsyncClient(Object producerAsyncClient) Sets the EventHubProducerAsyncClient.An asynchronous producer responsible for transmitting EventData to a specific Event Hub, grouped together in batches.
default EventHubsEndpointBuilderFactory.EventHubsEndpointProducerBuilder	producerAsyncClient(String producerAsyncClient) Sets the EventHubProducerAsyncClient.An asynchronous producer responsible for transmitting EventData to a specific Event Hub, grouped together in batches.
default EventHubsEndpointBuilderFactory.EventHubsEndpointProducerBuilder	sharedAccessKey(String sharedAccessKey) The generated value for the SharedAccessName.
default EventHubsEndpointBuilderFactory.EventHubsEndpointProducerBuilder	sharedAccessName(String sharedAccessName) The name you chose for your EventHubs SAS keys.

Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Method Detail

advanced

default EventHubsEndpointBuilderFactory.AdvancedEventHubsEndpointProducerBuilder advanced()

amqpRetryOptions

default EventHubsEndpointBuilderFactory.EventHubsEndpointProducerBuilder amqpRetryOptions(Object amqpRetryOptions)

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

Parameters:

amqpRetryOptions - the value to set

Returns:

the dsl builder

amqpRetryOptions

default EventHubsEndpointBuilderFactory.EventHubsEndpointProducerBuilder amqpRetryOptions(String amqpRetryOptions)

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

Parameters:

amqpRetryOptions - the value to set

Returns:

the dsl builder

amqpTransportType

default EventHubsEndpointBuilderFactory.EventHubsEndpointProducerBuilder amqpTransportType(EventHubsEndpointBuilderFactory.AmqpTransportType amqpTransportType)

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

Parameters:

amqpTransportType - the value to set

Returns:

the dsl builder

amqpTransportType

default EventHubsEndpointBuilderFactory.EventHubsEndpointProducerBuilder amqpTransportType(String amqpTransportType)

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

Parameters:

amqpTransportType - the value to set

Returns:

the dsl builder

lazyStartProducer

default EventHubsEndpointBuilderFactory.EventHubsEndpointProducerBuilder lazyStartProducer(boolean lazyStartProducer)

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option is a: <code>boolean</code> type. Default: false Group: producer

Parameters:

lazyStartProducer - the value to set

Returns:

the dsl builder

lazyStartProducer

default EventHubsEndpointBuilderFactory.EventHubsEndpointProducerBuilder lazyStartProducer(String lazyStartProducer)

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option will be converted to a <code>boolean</code> type. Default: false Group: producer

Parameters:

lazyStartProducer - the value to set

Returns:

the dsl builder

partitionId

default EventHubsEndpointBuilderFactory.EventHubsEndpointProducerBuilder partitionId(String partitionId)

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

Parameters:

partitionId - the value to set

Returns:

the dsl builder

partitionKey

default EventHubsEndpointBuilderFactory.EventHubsEndpointProducerBuilder partitionKey(String partitionKey)

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

Parameters:

partitionKey - the value to set

Returns:

the dsl builder

producerAsyncClient

default EventHubsEndpointBuilderFactory.EventHubsEndpointProducerBuilder producerAsyncClient(Object producerAsyncClient)

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

Parameters:

producerAsyncClient - the value to set

Returns:

the dsl builder

producerAsyncClient

default EventHubsEndpointBuilderFactory.EventHubsEndpointProducerBuilder producerAsyncClient(String producerAsyncClient)

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

Parameters:

producerAsyncClient - the value to set

Returns:

the dsl builder

connectionString

default EventHubsEndpointBuilderFactory.EventHubsEndpointProducerBuilder connectionString(String connectionString)

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

Parameters:

connectionString - the value to set

Returns:

the dsl builder

sharedAccessKey

default EventHubsEndpointBuilderFactory.EventHubsEndpointProducerBuilder sharedAccessKey(String sharedAccessKey)

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

Parameters:

sharedAccessKey - the value to set

Returns:

the dsl builder

sharedAccessName

default EventHubsEndpointBuilderFactory.EventHubsEndpointProducerBuilder sharedAccessName(String sharedAccessName)

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

Parameters:

sharedAccessName - the value to set

Returns:

the dsl builder