com.azure.messaging.servicebus

Class ServiceBusClientBuilder

java.lang.Object

com.azure.messaging.servicebus.ServiceBusClientBuilder

public final class ServiceBusClientBuilder
extends Object

The builder to create ServiceBusReceiverAsyncClient and ServiceBusSenderAsyncClient.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ServiceBusClientBuilder.ServiceBusReceiverClientBuilder Builder for creating ServiceBusReceiverClient and ServiceBusReceiverAsyncClient to consume messages from Service Bus.
class	ServiceBusClientBuilder.ServiceBusSenderClientBuilder Builder for creating ServiceBusSenderClient and ServiceBusSenderAsyncClient to publish messages to Service Bus.
class	ServiceBusClientBuilder.ServiceBusSessionReceiverClientBuilder Builder for creating ServiceBusReceiverClient and ServiceBusReceiverAsyncClient to consume messages from a session aware Service Bus entity.

Constructor Summary

Constructors

Constructor and Description
ServiceBusClientBuilder() Creates a new instance with the default transport AmqpTransportType.AMQP.

Method Summary

Modifier and Type	Method and Description
ServiceBusClientBuilder	configuration(com.azure.core.util.Configuration configuration) Sets the configuration store that is used during construction of the service client.
ServiceBusClientBuilder	connectionString(String connectionString) Sets the connection string for a Service Bus namespace or a specific Service Bus resource.
ServiceBusClientBuilder	credential(String fullyQualifiedNamespace, com.azure.core.credential.TokenCredential credential) Sets the credential for the Service Bus resource.
ServiceBusClientBuilder	proxyOptions(com.azure.core.amqp.ProxyOptions proxyOptions) Sets the proxy configuration to use for ServiceBusSenderAsyncClient.
ServiceBusClientBuilder.ServiceBusReceiverClientBuilder	receiver() A new instance of ServiceBusClientBuilder.ServiceBusReceiverClientBuilder used to configure Service Bus message consumers.
ServiceBusClientBuilder	retryOptions(com.azure.core.amqp.AmqpRetryOptions retryOptions) Sets the retry options for Service Bus clients.
ServiceBusClientBuilder.ServiceBusSenderClientBuilder	sender() A new instance of ServiceBusClientBuilder.ServiceBusSenderClientBuilder used to configure Service Bus message senders.
ServiceBusClientBuilder.ServiceBusSessionReceiverClientBuilder	sessionReceiver() A new instance of ServiceBusClientBuilder.ServiceBusSessionReceiverClientBuilder used to configure session aware Service Bus message consumers.
ServiceBusClientBuilder	transportType(com.azure.core.amqp.AmqpTransportType transportType) Sets the transport type by which all the communication with Azure Service Bus occurs.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ServiceBusClientBuilder

public ServiceBusClientBuilder()

Creates a new instance with the default transport AmqpTransportType.AMQP.

Method Detail

connectionString

public ServiceBusClientBuilder connectionString(String connectionString)

Sets the connection string for a Service Bus namespace or a specific Service Bus resource.

Parameters:

connectionString - Connection string for a Service Bus namespace or a specific Service Bus resource.

Returns:

The updated ServiceBusClientBuilder object.

configuration

public ServiceBusClientBuilder configuration(com.azure.core.util.Configuration configuration)

Sets the configuration store that is used during construction of the service client. If not specified, the default configuration store is used to configure Service Bus clients. Use Configuration.NONE to bypass using configuration settings during construction.

Parameters:

configuration - The configuration store used to configure Service Bus clients.

Returns:

The updated ServiceBusClientBuilder object.

credential

public ServiceBusClientBuilder credential(String fullyQualifiedNamespace,
                                          com.azure.core.credential.TokenCredential credential)

Sets the credential for the Service Bus resource.

Parameters:

fullyQualifiedNamespace - for the Service Bus.

credential - TokenCredential to be used for authentication.

Returns:

The updated ServiceBusClientBuilder object.

proxyOptions

public ServiceBusClientBuilder 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.

Parameters:

proxyOptions - The proxy configuration to use.

Returns:

The updated ServiceBusClientBuilder object.

retryOptions

public ServiceBusClientBuilder retryOptions(com.azure.core.amqp.AmqpRetryOptions retryOptions)

Sets the retry options for Service Bus clients. If not specified, the default retry options are used.

Parameters:

retryOptions - The retry options to use.

Returns:

The updated ServiceBusClientBuilder object.

transportType

public ServiceBusClientBuilder transportType(com.azure.core.amqp.AmqpTransportType transportType)

Sets the transport type by which all the communication with Azure Service Bus occurs. Default value is AmqpTransportType.AMQP.

Parameters:

transportType - The transport type to use.

Returns:

The updated ServiceBusClientBuilder object.

sender

public ServiceBusClientBuilder.ServiceBusSenderClientBuilder sender()

A new instance of ServiceBusClientBuilder.ServiceBusSenderClientBuilder used to configure Service Bus message senders.

Returns:

A new instance of ServiceBusClientBuilder.ServiceBusSenderClientBuilder.

receiver

public ServiceBusClientBuilder.ServiceBusReceiverClientBuilder receiver()

A new instance of ServiceBusClientBuilder.ServiceBusReceiverClientBuilder used to configure Service Bus message consumers.

Returns:

A new instance of ServiceBusClientBuilder.ServiceBusReceiverClientBuilder.

sessionReceiver

public ServiceBusClientBuilder.ServiceBusSessionReceiverClientBuilder sessionReceiver()

A new instance of ServiceBusClientBuilder.ServiceBusSessionReceiverClientBuilder used to configure session aware Service Bus message consumers.

Returns:

A new instance of ServiceBusClientBuilder.ServiceBusSessionReceiverClientBuilder.