Package org.apache.camel.builder.endpoint.dsl

Interface ServiceBusEndpointBuilderFactory.ServiceBusEndpointBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver, org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver, ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder, ServiceBusEndpointBuilderFactory.ServiceBusEndpointProducerBuilder

Enclosing interface:

ServiceBusEndpointBuilderFactory

public static interface ServiceBusEndpointBuilderFactory.ServiceBusEndpointBuilder
extends ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder, ServiceBusEndpointBuilderFactory.ServiceBusEndpointProducerBuilder

Builder for endpoint for the Azure ServiceBus component.

Method Summary

Modifier and Type	Method	Description
default ServiceBusEndpointBuilderFactory.AdvancedServiceBusEndpointBuilder	advanced()
default ServiceBusEndpointBuilderFactory.ServiceBusEndpointBuilder	amqpRetryOptions(com.azure.core.amqp.AmqpRetryOptions amqpRetryOptions)	Sets the retry options for Service Bus clients.
default ServiceBusEndpointBuilderFactory.ServiceBusEndpointBuilder	amqpRetryOptions(String amqpRetryOptions)	Sets the retry options for Service Bus clients.
default ServiceBusEndpointBuilderFactory.ServiceBusEndpointBuilder	amqpTransportType(com.azure.core.amqp.AmqpTransportType amqpTransportType)	Sets the transport type by which all the communication with Azure Service Bus occurs.
default ServiceBusEndpointBuilderFactory.ServiceBusEndpointBuilder	amqpTransportType(String amqpTransportType)	Sets the transport type by which all the communication with Azure Service Bus occurs.
default ServiceBusEndpointBuilderFactory.ServiceBusEndpointBuilder	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.ServiceBusEndpointBuilder	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.ServiceBusEndpointBuilder	connectionString(String connectionString)	Sets the connection string for a Service Bus namespace or a specific Service Bus resource.
default ServiceBusEndpointBuilderFactory.ServiceBusEndpointBuilder	fullyQualifiedNamespace(String fullyQualifiedNamespace)	Fully Qualified Namespace of the service bus.
default ServiceBusEndpointBuilderFactory.ServiceBusEndpointBuilder	proxyOptions(com.azure.core.amqp.ProxyOptions proxyOptions)	Sets the proxy configuration to use for ServiceBusSenderAsyncClient.
default ServiceBusEndpointBuilderFactory.ServiceBusEndpointBuilder	proxyOptions(String proxyOptions)	Sets the proxy configuration to use for ServiceBusSenderAsyncClient.
default ServiceBusEndpointBuilderFactory.ServiceBusEndpointBuilder	serviceBusType(String serviceBusType)	The service bus type of connection to execute.
default ServiceBusEndpointBuilderFactory.ServiceBusEndpointBuilder	serviceBusType(org.apache.camel.component.azure.servicebus.ServiceBusType serviceBusType)	The service bus type of connection to execute.
default ServiceBusEndpointBuilderFactory.ServiceBusEndpointBuilder	tokenCredential(com.azure.core.credential.TokenCredential tokenCredential)	A TokenCredential for Azure AD authentication, implemented in com.azure.identity.
default ServiceBusEndpointBuilderFactory.ServiceBusEndpointBuilder	tokenCredential(String tokenCredential)	A TokenCredential for Azure AD authentication, implemented in com.azure.identity.

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve, resolve

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder

consumerOperation, consumerOperation, disableAutoComplete, disableAutoComplete, maxAutoLockRenewDuration, maxAutoLockRenewDuration, peekNumMaxMessages, peekNumMaxMessages, prefetchCount, prefetchCount, receiverAsyncClient, receiverAsyncClient, serviceBusReceiveMode, serviceBusReceiveMode, subQueue, subQueue, subscriptionName

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.ServiceBusEndpointBuilderFactory.ServiceBusEndpointProducerBuilder

producerOperation, producerOperation, scheduledEnqueueTime, scheduledEnqueueTime, senderAsyncClient, senderAsyncClient, serviceBusTransactionContext, serviceBusTransactionContext

Method Detail

advanced

default ServiceBusEndpointBuilderFactory.AdvancedServiceBusEndpointBuilder advanced()

Specified by:

advanced in interface ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder

Specified by:

advanced in interface ServiceBusEndpointBuilderFactory.ServiceBusEndpointProducerBuilder

amqpRetryOptions

default ServiceBusEndpointBuilderFactory.ServiceBusEndpointBuilder 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

Specified by:

amqpRetryOptions in interface ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder

Specified by:

amqpRetryOptions in interface ServiceBusEndpointBuilderFactory.ServiceBusEndpointProducerBuilder

Parameters:

amqpRetryOptions - the value to set

Returns:

the dsl builder

amqpRetryOptions

default ServiceBusEndpointBuilderFactory.ServiceBusEndpointBuilder 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

Specified by:

amqpRetryOptions in interface ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder

Specified by:

amqpRetryOptions in interface ServiceBusEndpointBuilderFactory.ServiceBusEndpointProducerBuilder

Parameters:

amqpRetryOptions - the value to set

Returns:

the dsl builder

amqpTransportType

default ServiceBusEndpointBuilderFactory.ServiceBusEndpointBuilder 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

Specified by:

amqpTransportType in interface ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder

Specified by:

amqpTransportType in interface ServiceBusEndpointBuilderFactory.ServiceBusEndpointProducerBuilder

Parameters:

amqpTransportType - the value to set

Returns:

the dsl builder

amqpTransportType

default ServiceBusEndpointBuilderFactory.ServiceBusEndpointBuilder 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

Specified by:

amqpTransportType in interface ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder

Specified by:

amqpTransportType in interface ServiceBusEndpointBuilderFactory.ServiceBusEndpointProducerBuilder

Parameters:

amqpTransportType - the value to set

Returns:

the dsl builder

clientOptions

default ServiceBusEndpointBuilderFactory.ServiceBusEndpointBuilder 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

Specified by:

clientOptions in interface ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder

Specified by:

clientOptions in interface ServiceBusEndpointBuilderFactory.ServiceBusEndpointProducerBuilder

Parameters:

clientOptions - the value to set

Returns:

the dsl builder

clientOptions

default ServiceBusEndpointBuilderFactory.ServiceBusEndpointBuilder 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

Specified by:

clientOptions in interface ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder

Specified by:

clientOptions in interface ServiceBusEndpointBuilderFactory.ServiceBusEndpointProducerBuilder

Parameters:

clientOptions - the value to set

Returns:

the dsl builder

proxyOptions

default ServiceBusEndpointBuilderFactory.ServiceBusEndpointBuilder 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

Specified by:

proxyOptions in interface ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder

Specified by:

proxyOptions in interface ServiceBusEndpointBuilderFactory.ServiceBusEndpointProducerBuilder

Parameters:

proxyOptions - the value to set

Returns:

the dsl builder

proxyOptions

default ServiceBusEndpointBuilderFactory.ServiceBusEndpointBuilder 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

Specified by:

proxyOptions in interface ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder

Specified by:

proxyOptions in interface ServiceBusEndpointBuilderFactory.ServiceBusEndpointProducerBuilder

Parameters:

proxyOptions - the value to set

Returns:

the dsl builder

serviceBusType

default ServiceBusEndpointBuilderFactory.ServiceBusEndpointBuilder 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

Specified by:

serviceBusType in interface ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder

Specified by:

serviceBusType in interface ServiceBusEndpointBuilderFactory.ServiceBusEndpointProducerBuilder

Parameters:

serviceBusType - the value to set

Returns:

the dsl builder

serviceBusType

default ServiceBusEndpointBuilderFactory.ServiceBusEndpointBuilder 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

Specified by:

serviceBusType in interface ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder

Specified by:

serviceBusType in interface ServiceBusEndpointBuilderFactory.ServiceBusEndpointProducerBuilder

Parameters:

serviceBusType - the value to set

Returns:

the dsl builder

connectionString

default ServiceBusEndpointBuilderFactory.ServiceBusEndpointBuilder 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

Specified by:

connectionString in interface ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder

Specified by:

connectionString in interface ServiceBusEndpointBuilderFactory.ServiceBusEndpointProducerBuilder

Parameters:

connectionString - the value to set

Returns:

the dsl builder

fullyQualifiedNamespace

default ServiceBusEndpointBuilderFactory.ServiceBusEndpointBuilder fullyQualifiedNamespace(String fullyQualifiedNamespace)

Fully Qualified Namespace of the service bus. The option is a: <code>java.lang.String</code> type. Group: security

Specified by:

fullyQualifiedNamespace in interface ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder

Specified by:

fullyQualifiedNamespace in interface ServiceBusEndpointBuilderFactory.ServiceBusEndpointProducerBuilder

Parameters:

fullyQualifiedNamespace - the value to set

Returns:

the dsl builder

tokenCredential

default ServiceBusEndpointBuilderFactory.ServiceBusEndpointBuilder 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

Specified by:

tokenCredential in interface ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder

Specified by:

tokenCredential in interface ServiceBusEndpointBuilderFactory.ServiceBusEndpointProducerBuilder

Parameters:

tokenCredential - the value to set

Returns:

the dsl builder

tokenCredential

default ServiceBusEndpointBuilderFactory.ServiceBusEndpointBuilder 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

Specified by:

tokenCredential in interface ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder

Specified by:

tokenCredential in interface ServiceBusEndpointBuilderFactory.ServiceBusEndpointProducerBuilder

Parameters:

tokenCredential - the value to set

Returns:

the dsl builder