org.apache.camel.builder.endpoint.dsl

Interface ServiceBusEndpointBuilderFactory.ServiceBusEndpointProducerBuilder

All Superinterfaces:

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

All Known Subinterfaces:

ServiceBusEndpointBuilderFactory.ServiceBusEndpointBuilder

Enclosing interface:

ServiceBusEndpointBuilderFactory

public static interface ServiceBusEndpointBuilderFactory.ServiceBusEndpointProducerBuilder
extends org.apache.camel.builder.EndpointProducerBuilder

Builder for endpoint producers for the Azure ServiceBus component.

Method Summary

Modifier and Type	Method and Description
default ServiceBusEndpointBuilderFactory.AdvancedServiceBusEndpointProducerBuilder	advanced()
default ServiceBusEndpointBuilderFactory.ServiceBusEndpointProducerBuilder	amqpRetryOptions(Object amqpRetryOptions) Sets the retry options for Service Bus clients.
default ServiceBusEndpointBuilderFactory.ServiceBusEndpointProducerBuilder	amqpRetryOptions(String amqpRetryOptions) Sets the retry options for Service Bus clients.
default ServiceBusEndpointBuilderFactory.ServiceBusEndpointProducerBuilder	amqpTransportType(ServiceBusEndpointBuilderFactory.AmqpTransportType amqpTransportType) Sets the transport type by which all the communication with Azure Service Bus occurs.
default ServiceBusEndpointBuilderFactory.ServiceBusEndpointProducerBuilder	amqpTransportType(String amqpTransportType) Sets the transport type by which all the communication with Azure Service Bus occurs.
default ServiceBusEndpointBuilderFactory.ServiceBusEndpointProducerBuilder	clientOptions(Object 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.ServiceBusEndpointProducerBuilder	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.ServiceBusEndpointProducerBuilder	connectionString(String connectionString) Sets the connection string for a Service Bus namespace or a specific Service Bus resource.
default ServiceBusEndpointBuilderFactory.ServiceBusEndpointProducerBuilder	lazyStartProducer(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message).
default ServiceBusEndpointBuilderFactory.ServiceBusEndpointProducerBuilder	lazyStartProducer(String lazyStartProducer) Whether the producer should be started lazy (on the first message).
default ServiceBusEndpointBuilderFactory.ServiceBusEndpointProducerBuilder	producerOperation(ServiceBusEndpointBuilderFactory.ServiceBusProducerOperationDefinition producerOperation) Sets the desired operation to be used in the producer.
default ServiceBusEndpointBuilderFactory.ServiceBusEndpointProducerBuilder	producerOperation(String producerOperation) Sets the desired operation to be used in the producer.
default ServiceBusEndpointBuilderFactory.ServiceBusEndpointProducerBuilder	proxyOptions(Object proxyOptions) Sets the proxy configuration to use for ServiceBusSenderAsyncClient.
default ServiceBusEndpointBuilderFactory.ServiceBusEndpointProducerBuilder	proxyOptions(String proxyOptions) Sets the proxy configuration to use for ServiceBusSenderAsyncClient.
default ServiceBusEndpointBuilderFactory.ServiceBusEndpointProducerBuilder	scheduledEnqueueTime(OffsetDateTime scheduledEnqueueTime) Sets OffsetDateTime at which the message should appear in the Service Bus queue or topic.
default ServiceBusEndpointBuilderFactory.ServiceBusEndpointProducerBuilder	scheduledEnqueueTime(String scheduledEnqueueTime) Sets OffsetDateTime at which the message should appear in the Service Bus queue or topic.
default ServiceBusEndpointBuilderFactory.ServiceBusEndpointProducerBuilder	senderAsyncClient(Object senderAsyncClient) Sets SenderAsyncClient to be used in the producer.
default ServiceBusEndpointBuilderFactory.ServiceBusEndpointProducerBuilder	senderAsyncClient(String senderAsyncClient) Sets SenderAsyncClient to be used in the producer.
default ServiceBusEndpointBuilderFactory.ServiceBusEndpointProducerBuilder	serviceBusTransactionContext(Object serviceBusTransactionContext) Represents transaction in service.
default ServiceBusEndpointBuilderFactory.ServiceBusEndpointProducerBuilder	serviceBusTransactionContext(String serviceBusTransactionContext) Represents transaction in service.
default ServiceBusEndpointBuilderFactory.ServiceBusEndpointProducerBuilder	serviceBusType(ServiceBusEndpointBuilderFactory.ServiceBusType serviceBusType) The service bus type of connection to execute.
default ServiceBusEndpointBuilderFactory.ServiceBusEndpointProducerBuilder	serviceBusType(String serviceBusType) The service bus type of connection to execute.

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 ServiceBusEndpointBuilderFactory.AdvancedServiceBusEndpointProducerBuilder advanced()

amqpRetryOptions

default ServiceBusEndpointBuilderFactory.ServiceBusEndpointProducerBuilder amqpRetryOptions(Object 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.ServiceBusEndpointProducerBuilder 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.ServiceBusEndpointProducerBuilder amqpTransportType(ServiceBusEndpointBuilderFactory.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.ServiceBusEndpointProducerBuilder 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.ServiceBusEndpointProducerBuilder clientOptions(Object 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.ServiceBusEndpointProducerBuilder 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.ServiceBusEndpointProducerBuilder proxyOptions(Object 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.ServiceBusEndpointProducerBuilder 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.ServiceBusEndpointProducerBuilder serviceBusType(ServiceBusEndpointBuilderFactory.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.ServiceBusEndpointProducerBuilder 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

lazyStartProducer

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

producerOperation

default ServiceBusEndpointBuilderFactory.ServiceBusEndpointProducerBuilder producerOperation(ServiceBusEndpointBuilderFactory.ServiceBusProducerOperationDefinition producerOperation)

Sets the desired operation to be used in the producer. The option is a: <code>org.apache.camel.component.azure.servicebus.ServiceBusProducerOperationDefinition</code> type. Default: sendMessages Group: producer

Parameters:

producerOperation - the value to set

Returns:

the dsl builder

producerOperation

default ServiceBusEndpointBuilderFactory.ServiceBusEndpointProducerBuilder producerOperation(String producerOperation)

Sets the desired operation to be used in the producer. The option will be converted to a <code>org.apache.camel.component.azure.servicebus.ServiceBusProducerOperationDefinition</code> type. Default: sendMessages Group: producer

Parameters:

producerOperation - the value to set

Returns:

the dsl builder

scheduledEnqueueTime

default ServiceBusEndpointBuilderFactory.ServiceBusEndpointProducerBuilder scheduledEnqueueTime(OffsetDateTime scheduledEnqueueTime)

Sets OffsetDateTime at which the message should appear in the Service Bus queue or topic. The option is a: <code>java.time.OffsetDateTime</code> type. Group: producer

Parameters:

scheduledEnqueueTime - the value to set

Returns:

the dsl builder

scheduledEnqueueTime

default ServiceBusEndpointBuilderFactory.ServiceBusEndpointProducerBuilder scheduledEnqueueTime(String scheduledEnqueueTime)

Sets OffsetDateTime at which the message should appear in the Service Bus queue or topic. The option will be converted to a <code>java.time.OffsetDateTime</code> type. Group: producer

Parameters:

scheduledEnqueueTime - the value to set

Returns:

the dsl builder

senderAsyncClient

default ServiceBusEndpointBuilderFactory.ServiceBusEndpointProducerBuilder senderAsyncClient(Object senderAsyncClient)

Sets SenderAsyncClient to be used in the producer. The option is a: <code>com.azure.messaging.servicebus.ServiceBusSenderAsyncClient</code> type. Group: producer

Parameters:

senderAsyncClient - the value to set

Returns:

the dsl builder

senderAsyncClient

default ServiceBusEndpointBuilderFactory.ServiceBusEndpointProducerBuilder senderAsyncClient(String senderAsyncClient)

Sets SenderAsyncClient to be used in the producer. The option will be converted to a <code>com.azure.messaging.servicebus.ServiceBusSenderAsyncClient</code> type. Group: producer

Parameters:

senderAsyncClient - the value to set

Returns:

the dsl builder

serviceBusTransactionContext

default ServiceBusEndpointBuilderFactory.ServiceBusEndpointProducerBuilder serviceBusTransactionContext(Object serviceBusTransactionContext)

Represents transaction in service. This object just contains transaction id. The option is a: <code>com.azure.messaging.servicebus.ServiceBusTransactionContext</code> type. Group: producer

Parameters:

serviceBusTransactionContext - the value to set

Returns:

the dsl builder

serviceBusTransactionContext

default ServiceBusEndpointBuilderFactory.ServiceBusEndpointProducerBuilder serviceBusTransactionContext(String serviceBusTransactionContext)

Represents transaction in service. This object just contains transaction id. The option will be converted to a <code>com.azure.messaging.servicebus.ServiceBusTransactionContext</code> type. Group: producer

Parameters:

serviceBusTransactionContext - the value to set

Returns:

the dsl builder

connectionString

default ServiceBusEndpointBuilderFactory.ServiceBusEndpointProducerBuilder 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. Required: true Group: security

Parameters:

connectionString - the value to set

Returns:

the dsl builder