Interface ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder
-
- All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder
,org.apache.camel.EndpointConsumerResolver
- All Known Subinterfaces:
ServiceBusEndpointBuilderFactory.ServiceBusEndpointBuilder
- Enclosing interface:
- ServiceBusEndpointBuilderFactory
public static interface ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder extends org.apache.camel.builder.EndpointConsumerBuilder
Builder for endpoint consumers for the Azure ServiceBus component.
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default ServiceBusEndpointBuilderFactory.AdvancedServiceBusEndpointConsumerBuilder
advanced()
default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder
amqpRetryOptions(com.azure.core.amqp.AmqpRetryOptions amqpRetryOptions)
Sets the retry options for Service Bus clients.default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder
amqpRetryOptions(String amqpRetryOptions)
Sets the retry options for Service Bus clients.default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder
amqpTransportType(com.azure.core.amqp.AmqpTransportType amqpTransportType)
Sets the transport type by which all the communication with Azure Service Bus occurs.default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder
amqpTransportType(String amqpTransportType)
Sets the transport type by which all the communication with Azure Service Bus occurs.default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder
clientOptions(com.azure.core.util.ClientOptions clientOptions)
Sets the ClientOptions to be sent from the client built from this builder, enabling customization of certain properties, as well as support the addition of custom header information.default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder
clientOptions(String clientOptions)
Sets the ClientOptions to be sent from the client built from this builder, enabling customization of certain properties, as well as support the addition of custom header information.default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder
connectionString(String connectionString)
Sets the connection string for a Service Bus namespace or a specific Service Bus resource.default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder
consumerOperation(String consumerOperation)
Sets the desired operation to be used in the consumer.default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder
consumerOperation(org.apache.camel.component.azure.servicebus.ServiceBusConsumerOperationDefinition consumerOperation)
Sets the desired operation to be used in the consumer.default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder
disableAutoComplete(boolean disableAutoComplete)
Disables auto-complete and auto-abandon of received messages.default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder
disableAutoComplete(String disableAutoComplete)
Disables auto-complete and auto-abandon of received messages.default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder
fullyQualifiedNamespace(String fullyQualifiedNamespace)
Fully Qualified Namespace of the service bus.default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder
maxAutoLockRenewDuration(String maxAutoLockRenewDuration)
Sets the amount of time to continue auto-renewing the lock.default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder
maxAutoLockRenewDuration(Duration maxAutoLockRenewDuration)
Sets the amount of time to continue auto-renewing the lock.default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder
peekNumMaxMessages(Integer peekNumMaxMessages)
Set the max number of messages to be peeked during the peek operation.default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder
peekNumMaxMessages(String peekNumMaxMessages)
Set the max number of messages to be peeked during the peek operation.default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder
prefetchCount(int prefetchCount)
Sets the prefetch count of the receiver.default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder
prefetchCount(String prefetchCount)
Sets the prefetch count of the receiver.default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder
proxyOptions(com.azure.core.amqp.ProxyOptions proxyOptions)
Sets the proxy configuration to use for ServiceBusSenderAsyncClient.default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder
proxyOptions(String proxyOptions)
Sets the proxy configuration to use for ServiceBusSenderAsyncClient.default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder
receiverAsyncClient(com.azure.messaging.servicebus.ServiceBusReceiverAsyncClient receiverAsyncClient)
Sets the receiverAsyncClient in order to consume messages by the consumer.default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder
receiverAsyncClient(String receiverAsyncClient)
Sets the receiverAsyncClient in order to consume messages by the consumer.default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder
serviceBusReceiveMode(com.azure.messaging.servicebus.models.ServiceBusReceiveMode serviceBusReceiveMode)
Sets the receive mode for the receiver.default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder
serviceBusReceiveMode(String serviceBusReceiveMode)
Sets the receive mode for the receiver.default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder
serviceBusType(String serviceBusType)
The service bus type of connection to execute.default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder
serviceBusType(org.apache.camel.component.azure.servicebus.ServiceBusType serviceBusType)
The service bus type of connection to execute.default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder
subQueue(com.azure.messaging.servicebus.models.SubQueue subQueue)
Sets the type of the SubQueue to connect to.default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder
subQueue(String subQueue)
Sets the type of the SubQueue to connect to.default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder
subscriptionName(String subscriptionName)
Sets the name of the subscription in the topic to listen to.default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder
tokenCredential(com.azure.core.credential.TokenCredential tokenCredential)
A TokenCredential for Azure AD authentication, implemented in com.azure.identity.default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder
tokenCredential(String tokenCredential)
A TokenCredential for Azure AD authentication, implemented in com.azure.identity.
-
-
-
Method Detail
-
advanced
default ServiceBusEndpointBuilderFactory.AdvancedServiceBusEndpointConsumerBuilder advanced()
-
amqpRetryOptions
default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder amqpRetryOptions(com.azure.core.amqp.AmqpRetryOptions amqpRetryOptions)
Sets the retry options for Service Bus clients. 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 ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder amqpRetryOptions(String amqpRetryOptions)
Sets the retry options for Service Bus clients. 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 ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder amqpTransportType(com.azure.core.amqp.AmqpTransportType amqpTransportType)
Sets the transport type by which all the communication with Azure Service Bus 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 ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder amqpTransportType(String amqpTransportType)
Sets the transport type by which all the communication with Azure Service Bus 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
-
clientOptions
default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder clientOptions(com.azure.core.util.ClientOptions clientOptions)
Sets the ClientOptions to be sent from the client built from this builder, enabling customization of certain properties, as well as support the addition of custom header information. Refer to the ClientOptions documentation for more information. The option is a: <code>com.azure.core.util.ClientOptions</code> type. Group: common- Parameters:
clientOptions
- the value to set- Returns:
- the dsl builder
-
clientOptions
default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder clientOptions(String clientOptions)
Sets the ClientOptions to be sent from the client built from this builder, enabling customization of certain properties, as well as support the addition of custom header information. Refer to the ClientOptions documentation for more information. The option will be converted to a <code>com.azure.core.util.ClientOptions</code> type. Group: common- Parameters:
clientOptions
- the value to set- Returns:
- the dsl builder
-
proxyOptions
default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder proxyOptions(com.azure.core.amqp.ProxyOptions proxyOptions)
Sets the proxy configuration to use for ServiceBusSenderAsyncClient. When a proxy is configured, AmqpTransportType#AMQP_WEB_SOCKETS must be used for the transport type. The option is a: <code>com.azure.core.amqp.ProxyOptions</code> type. Group: common- Parameters:
proxyOptions
- the value to set- Returns:
- the dsl builder
-
proxyOptions
default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder proxyOptions(String proxyOptions)
Sets the proxy configuration to use for ServiceBusSenderAsyncClient. When a proxy is configured, AmqpTransportType#AMQP_WEB_SOCKETS must be used for the transport type. The option will be converted to a <code>com.azure.core.amqp.ProxyOptions</code> type. Group: common- Parameters:
proxyOptions
- the value to set- Returns:
- the dsl builder
-
serviceBusType
default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder serviceBusType(org.apache.camel.component.azure.servicebus.ServiceBusType serviceBusType)
The service bus type of connection to execute. Queue is for typical queue option and topic for subscription based model. The option is a: <code>org.apache.camel.component.azure.servicebus.ServiceBusType</code> type. Required: true Default: queue Group: common- Parameters:
serviceBusType
- the value to set- Returns:
- the dsl builder
-
serviceBusType
default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder serviceBusType(String serviceBusType)
The service bus type of connection to execute. Queue is for typical queue option and topic for subscription based model. The option will be converted to a <code>org.apache.camel.component.azure.servicebus.ServiceBusType</code> type. Required: true Default: queue Group: common- Parameters:
serviceBusType
- the value to set- Returns:
- the dsl builder
-
consumerOperation
default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder consumerOperation(org.apache.camel.component.azure.servicebus.ServiceBusConsumerOperationDefinition consumerOperation)
Sets the desired operation to be used in the consumer. The option is a: <code>org.apache.camel.component.azure.servicebus.ServiceBusConsumerOperationDefinition</code> type. Default: receiveMessages Group: consumer- Parameters:
consumerOperation
- the value to set- Returns:
- the dsl builder
-
consumerOperation
default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder consumerOperation(String consumerOperation)
Sets the desired operation to be used in the consumer. The option will be converted to a <code>org.apache.camel.component.azure.servicebus.ServiceBusConsumerOperationDefinition</code> type. Default: receiveMessages Group: consumer- Parameters:
consumerOperation
- the value to set- Returns:
- the dsl builder
-
disableAutoComplete
default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder disableAutoComplete(boolean disableAutoComplete)
Disables auto-complete and auto-abandon of received messages. By default, a successfully processed message is {link ServiceBusReceiverAsyncClient#complete(ServiceBusReceivedMessage) completed}. If an error happens when the message is processed, it is {link ServiceBusReceiverAsyncClient#abandon(ServiceBusReceivedMessage) abandoned}. The option is a: <code>boolean</code> type. Default: false Group: consumer- Parameters:
disableAutoComplete
- the value to set- Returns:
- the dsl builder
-
disableAutoComplete
default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder disableAutoComplete(String disableAutoComplete)
Disables auto-complete and auto-abandon of received messages. By default, a successfully processed message is {link ServiceBusReceiverAsyncClient#complete(ServiceBusReceivedMessage) completed}. If an error happens when the message is processed, it is {link ServiceBusReceiverAsyncClient#abandon(ServiceBusReceivedMessage) abandoned}. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer- Parameters:
disableAutoComplete
- the value to set- Returns:
- the dsl builder
-
maxAutoLockRenewDuration
default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder maxAutoLockRenewDuration(Duration maxAutoLockRenewDuration)
Sets the amount of time to continue auto-renewing the lock. Setting Duration#ZERO or null disables auto-renewal. For {link ServiceBusReceiveMode#RECEIVE_AND_DELETE RECEIVE_AND_DELETE} mode, auto-renewal is disabled. The option is a: <code>java.time.Duration</code> type. Default: 5m Group: consumer- Parameters:
maxAutoLockRenewDuration
- the value to set- Returns:
- the dsl builder
-
maxAutoLockRenewDuration
default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder maxAutoLockRenewDuration(String maxAutoLockRenewDuration)
Sets the amount of time to continue auto-renewing the lock. Setting Duration#ZERO or null disables auto-renewal. For {link ServiceBusReceiveMode#RECEIVE_AND_DELETE RECEIVE_AND_DELETE} mode, auto-renewal is disabled. The option will be converted to a <code>java.time.Duration</code> type. Default: 5m Group: consumer- Parameters:
maxAutoLockRenewDuration
- the value to set- Returns:
- the dsl builder
-
peekNumMaxMessages
default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder peekNumMaxMessages(Integer peekNumMaxMessages)
Set the max number of messages to be peeked during the peek operation. The option is a: <code>java.lang.Integer</code> type. Group: consumer- Parameters:
peekNumMaxMessages
- the value to set- Returns:
- the dsl builder
-
peekNumMaxMessages
default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder peekNumMaxMessages(String peekNumMaxMessages)
Set the max number of messages to be peeked during the peek operation. The option will be converted to a <code>java.lang.Integer</code> type. Group: consumer- Parameters:
peekNumMaxMessages
- the value to set- Returns:
- the dsl builder
-
prefetchCount
default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder prefetchCount(int prefetchCount)
Sets the prefetch count of the receiver. For both {link ServiceBusReceiveMode#PEEK_LOCK PEEK_LOCK} and {link ServiceBusReceiveMode#RECEIVE_AND_DELETE RECEIVE_AND_DELETE} modes the default value is 1. Prefetch speeds up the message flow by aiming to have a message readily available for local retrieval when and before the application asks for one using ServiceBusReceiverAsyncClient#receiveMessages(). Setting a non-zero value will prefetch that number of messages. Setting the value to zero turns prefetch off. The option is a: <code>int</code> type. Group: consumer- Parameters:
prefetchCount
- the value to set- Returns:
- the dsl builder
-
prefetchCount
default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder prefetchCount(String prefetchCount)
Sets the prefetch count of the receiver. For both {link ServiceBusReceiveMode#PEEK_LOCK PEEK_LOCK} and {link ServiceBusReceiveMode#RECEIVE_AND_DELETE RECEIVE_AND_DELETE} modes the default value is 1. Prefetch speeds up the message flow by aiming to have a message readily available for local retrieval when and before the application asks for one using ServiceBusReceiverAsyncClient#receiveMessages(). Setting a non-zero value will prefetch that number of messages. Setting the value to zero turns prefetch off. The option will be converted to a <code>int</code> type. Group: consumer- Parameters:
prefetchCount
- the value to set- Returns:
- the dsl builder
-
receiverAsyncClient
default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder receiverAsyncClient(com.azure.messaging.servicebus.ServiceBusReceiverAsyncClient receiverAsyncClient)
Sets the receiverAsyncClient in order to consume messages by the consumer. The option is a: <code>com.azure.messaging.servicebus.ServiceBusReceiverAsyncClient</code> type. Group: consumer- Parameters:
receiverAsyncClient
- the value to set- Returns:
- the dsl builder
-
receiverAsyncClient
default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder receiverAsyncClient(String receiverAsyncClient)
Sets the receiverAsyncClient in order to consume messages by the consumer. The option will be converted to a <code>com.azure.messaging.servicebus.ServiceBusReceiverAsyncClient</code> type. Group: consumer- Parameters:
receiverAsyncClient
- the value to set- Returns:
- the dsl builder
-
serviceBusReceiveMode
default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder serviceBusReceiveMode(com.azure.messaging.servicebus.models.ServiceBusReceiveMode serviceBusReceiveMode)
Sets the receive mode for the receiver. The option is a: <code>com.azure.messaging.servicebus.models.ServiceBusReceiveMode</code> type. Default: PEEK_LOCK Group: consumer- Parameters:
serviceBusReceiveMode
- the value to set- Returns:
- the dsl builder
-
serviceBusReceiveMode
default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder serviceBusReceiveMode(String serviceBusReceiveMode)
Sets the receive mode for the receiver. The option will be converted to a <code>com.azure.messaging.servicebus.models.ServiceBusReceiveMode</code> type. Default: PEEK_LOCK Group: consumer- Parameters:
serviceBusReceiveMode
- the value to set- Returns:
- the dsl builder
-
subQueue
default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder subQueue(com.azure.messaging.servicebus.models.SubQueue subQueue)
Sets the type of the SubQueue to connect to. The option is a: <code>com.azure.messaging.servicebus.models.SubQueue</code> type. Group: consumer- Parameters:
subQueue
- the value to set- Returns:
- the dsl builder
-
subQueue
default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder subQueue(String subQueue)
Sets the type of the SubQueue to connect to. The option will be converted to a <code>com.azure.messaging.servicebus.models.SubQueue</code> type. Group: consumer- Parameters:
subQueue
- the value to set- Returns:
- the dsl builder
-
subscriptionName
default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder subscriptionName(String subscriptionName)
Sets the name of the subscription in the topic to listen to. topicOrQueueName and serviceBusType=topic must also be set. This property is required if serviceBusType=topic and the consumer is in use. The option is a: <code>java.lang.String</code> type. Group: consumer- Parameters:
subscriptionName
- the value to set- Returns:
- the dsl builder
-
connectionString
default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder connectionString(String connectionString)
Sets the connection string for a Service Bus namespace or a specific Service Bus resource. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
connectionString
- the value to set- Returns:
- the dsl builder
-
fullyQualifiedNamespace
default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder fullyQualifiedNamespace(String fullyQualifiedNamespace)
Fully Qualified Namespace of the service bus. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
fullyQualifiedNamespace
- the value to set- Returns:
- the dsl builder
-
tokenCredential
default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder tokenCredential(com.azure.core.credential.TokenCredential tokenCredential)
A TokenCredential for Azure AD authentication, implemented in com.azure.identity. The option is a: <code>com.azure.core.credential.TokenCredential</code> type. Group: security- Parameters:
tokenCredential
- the value to set- Returns:
- the dsl builder
-
tokenCredential
default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder tokenCredential(String tokenCredential)
A TokenCredential for Azure AD authentication, implemented in com.azure.identity. The option will be converted to a <code>com.azure.core.credential.TokenCredential</code> type. Group: security- Parameters:
tokenCredential
- the value to set- Returns:
- the dsl builder
-
-