AmqpTrait<T> Interface

Package:

com.azure.core.amqp.client.traits

Maven Artifact:

com.azure:azure-core-amqp:2.9.12

Type Parameters

T

The concrete type that implements the trait. This is required so that fluent operations can continue to return the concrete type, rather than the trait type.

public interface AmqpTrait

An Azure SDK for Java trait providing a consistent interface for configuration of AMQP-specific settings.

Method Summary

Modifier and Type	Method and Description
abstract T	clientOptions(ClientOptions clientOptions) Allows for setting common properties such as application ID, headers, etc.
abstract T	proxyOptions(ProxyOptions proxyOptions) Sets the proxy configuration to use.
abstract T	retryOptions(AmqpRetryOptions retryOptions) Sets the retry policy.
abstract T	transportType(AmqpTransportType transport) Sets the transport type by which all the communication with Azure service occurs.

Method Details

clientOptions

public abstract T clientOptions(ClientOptions clientOptions)

Allows for setting common properties such as application ID, headers, etc.

Parameters:

clientOptions - A configured instance of ClientOptions.

Returns:

Returns the same concrete type with the appropriate properties updated, to allow for fluent chaining of operations.

proxyOptions

public abstract T proxyOptions(ProxyOptions proxyOptions)

Sets the proxy configuration to use. When a proxy is configured, AMQP_WEB_SOCKETS must be used for the transport type.

Parameters:

proxyOptions - The proxy configuration to use.

Returns:

Returns the same concrete type with the appropriate properties updated, to allow for fluent chaining of operations.

retryOptions

public abstract T retryOptions(AmqpRetryOptions retryOptions)

Sets the retry policy. If not specified, the default retry options are used.

Parameters:

retryOptions - The retry options to use.

Returns:

Returns the same concrete type with the appropriate properties updated, to allow for fluent chaining of operations.

transportType

public abstract T transportType(AmqpTransportType transport)

Sets the transport type by which all the communication with Azure service occurs. The default value is AMQP.

Parameters:

transport - The transport type to use.

Returns:

Returns the same concrete type with the appropriate properties updated, to allow for fluent chaining of operations.