ServiceBusAdministrationClientBuilder Clase

Paquete:

com.azure.messaging.servicebus.administration

Artefacto Maven:

com.azure:azure-messaging-servicebus:7.17.0

• java.lang.Object
• • com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder

Implementaciones

AzureSasCredentialTrait<ServiceBusAdministrationClientBuilder> ConfigurationTrait<ServiceBusAdministrationClientBuilder> ConnectionStringTrait<ServiceBusAdministrationClientBuilder> EndpointTrait<ServiceBusAdministrationClientBuilder> HttpTrait<ServiceBusAdministrationClientBuilder> TokenCredentialTrait<ServiceBusAdministrationClientBuilder>

public final class ServiceBusAdministrationClientBuilder
implements TokenCredentialTrait<ServiceBusAdministrationClientBuilder>, AzureSasCredentialTrait<ServiceBusAdministrationClientBuilder>, ConnectionStringTrait<ServiceBusAdministrationClientBuilder>, HttpTrait<ServiceBusAdministrationClientBuilder>, ConfigurationTrait<ServiceBusAdministrationClientBuilder>, EndpointTrait<ServiceBusAdministrationClientBuilder>

Esta clase proporciona una API fluida de Builder para ayudar a la configuración y creación de instancias de ServiceBusAdministrationClient y ServiceBusAdministrationAsyncClient. Llame a buildClient() y buildAsyncClient() , respectivamente, para construir una instancia del cliente deseado.

Las credenciales son necesarias para realizar operaciones con Azure Service Bus. Se pueden establecer mediante uno de los métodos siguientes:

• connectionString(String connectionString)con un espacio de nombres de Service Bus cadena de conexión.
• credential(String fullyQualifiedNamespace, TokenCredential credential) con el espacio de nombres completo de Service Bus y un conjunto de credenciales autorizadas para usar el espacio de nombres.
• credential(TokenCredential credential) y credential(AzureSasCredential credential) las sobrecargas se pueden usar con sus credenciales respectivas. Además, endpoint(String endpoint) debe establecerse.

La credencial usada en los ejemplos siguientes es DefaultAzureCredential para la autenticación. Es adecuado para la mayoría de los escenarios, incluidos los entornos de desarrollo y producción locales. Además, se recomienda usar la identidad administrada para la autenticación en entornos de producción. Puede encontrar más información sobre las distintas formas de autenticación y sus tipos de credenciales correspondientes en la documentación de Azure Identity.

Ejemplo: Creación del cliente de sincronización

En el ejemplo de código siguiente se muestra la creación del cliente de administración sincrónica.

HttpLogOptions logOptions = new HttpLogOptions()
     .setLogLevel(HttpLogDetailLevel.HEADERS);

 // DefaultAzureCredential creates a credential based on the environment it is executed in.
 TokenCredential tokenCredential = new DefaultAzureCredentialBuilder().build();

 // 'fullyQualifiedNamespace' will look similar to "{your-namespace}.servicebus.windows.net"
 ServiceBusAdministrationClient client = new ServiceBusAdministrationClientBuilder()
     .credential(fullyQualifiedNamespace, tokenCredential)
     .httpLogOptions(logOptions)
     .buildClient();

Ejemplo: Creación del cliente asincrónico mediante Azure Identity

En el ejemplo de código siguiente se muestra la creación del cliente de administración asincrónica.

// DefaultAzureCredential creates a credential based on the environment it is executed in.
 TokenCredential credential = new DefaultAzureCredentialBuilder().build();

 // 'fullyQualifiedNamespace' will look similar to "{your-namespace}.servicebus.windows.net"
 ServiceBusAdministrationAsyncClient client = new ServiceBusAdministrationClientBuilder()
     .credential(fullyQualifiedNamespace, new DefaultAzureCredentialBuilder().build())
     .buildAsyncClient();

Ejemplo: Creación del cliente asincrónico

En el ejemplo de código siguiente se muestra la creación del cliente de administración asincrónica con las opciones de reintento y las opciones de registro HTTP configuradas.

// DefaultAzureCredential creates a credential based on the environment it is executed in.
 TokenCredential credential = new DefaultAzureCredentialBuilder().build();

 RetryOptions retryOptions = new RetryOptions(new FixedDelayOptions(4, Duration.ofSeconds(20)));

 // "<<fully-qualified-namespace>>" will look similar to "{your-namespace}.servicebus.windows.net"
 ServiceBusAdministrationAsyncClient client = new ServiceBusAdministrationClientBuilder()
     .credential("<<fully-qualified-namespace>>", credential)
     .retryOptions(retryOptions)
     .httpLogOptions(new HttpLogOptions().setLogLevel(HttpLogDetailLevel.HEADERS))
     .buildAsyncClient();

Resumen del constructor

Constructor	Description
ServiceBusAdministrationClientBuilder()	Construye un generador con los parámetros predeterminados.

Resumen del método

Modificador y tipo	Método y descripción
ServiceBusAdministrationClientBuilder	addPolicy(HttpPipelinePolicy policy) Agrega un HttpPipelinePolicy objeto que se aplicará en cada solicitud enviada.
ServiceBusAdministrationAsyncClient	buildAsyncClient() Crea un ServiceBusAdministrationAsyncClient objeto basado en las opciones establecidas en el generador.
ServiceBusAdministrationClient	buildClient() Crea un ServiceBusAdministrationClient objeto basado en las opciones establecidas en el generador.
ServiceBusAdministrationClientBuilder	clientOptions(ClientOptions clientOptions) Permite establecer propiedades comunes, como el identificador de aplicación, los encabezados, la configuración de proxy, etc.
ServiceBusAdministrationClientBuilder	configuration(Configuration configuration) Establece el almacén de configuración que se usa durante la construcción del cliente de servicio.
ServiceBusAdministrationClientBuilder	connectionString(String connectionString) Establece el cadena de conexión para un espacio de nombres de Service Bus o un recurso de Service Bus específico.
ServiceBusAdministrationClientBuilder	credential(AzureSasCredential credential) Establece la credencial con firma de acceso compartido para el recurso de Service Bus.
ServiceBusAdministrationClientBuilder	credential(TokenCredential credential) Establece el TokenCredential objeto utilizado para autorizar las solicitudes enviadas al servicio.
ServiceBusAdministrationClientBuilder	credential(String fullyQualifiedNamespace, TokenCredential credential) Establece la credencial usada para autenticar las solicitudes HTTP en el espacio de nombres de Service Bus.
ServiceBusAdministrationClientBuilder	endpoint(String endpoint) Establece el punto de conexión de servicio para el espacio de nombres de Service Bus.
ServiceBusAdministrationClientBuilder	httpClient(HttpClient client) Establece el objeto HttpClient que se va a usar para enviar y recibir solicitudes hacia y desde el servicio.
ServiceBusAdministrationClientBuilder	httpLogOptions(HttpLogOptions logOptions) Establece el objeto HttpLogOptions que se va a usar al enviar y recibir solicitudes hacia y desde el servicio.
ServiceBusAdministrationClientBuilder	pipeline(HttpPipeline pipeline) Establece el objeto HttpPipeline que se va a usar para el cliente de servicio.
ServiceBusAdministrationClientBuilder	retryOptions(RetryOptions retryOptions) Establece para RetryOptions todas las solicitudes realizadas a través del cliente.
ServiceBusAdministrationClientBuilder	retryPolicy(HttpPipelinePolicy retryPolicy) Establece el HttpPipelinePolicy objeto que se usa cuando se envía cada solicitud.
ServiceBusAdministrationClientBuilder	serviceVersion(ServiceBusServiceVersion serviceVersion) Establece el ServiceBusServiceVersion objeto que se usa.

Métodos heredados de java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Detalles del constructor

ServiceBusAdministrationClientBuilder

public ServiceBusAdministrationClientBuilder()

Construye un generador con los parámetros predeterminados.

Detalles del método

addPolicy

public ServiceBusAdministrationClientBuilder addPolicy(HttpPipelinePolicy policy)

Agrega un HttpPipelinePolicy objeto que se aplicará en cada solicitud enviada.

Nota: Es importante comprender el orden de precedencia de las API de HttpTrait. En concreto, si se especifica un HttpPipeline , esto tiene prioridad sobre todas las demás API del rasgo y se omitirán. Si no se especifica , HttpPipeline una canalización HTTP se construirá internamente en función de la configuración proporcionada a este rasgo. Además, puede haber otras API en los tipos que implementan este rasgo que también se omiten si se especifica un HttpPipeline , por lo que asegúrese de consultar la documentación de los tipos que implementan este rasgo para comprender todo el conjunto de implicaciones.

Parameters:

policy - Un objeto HttpPipelinePolicy.

Returns:

Objeto ServiceBusAdministrationClientBuilder actualizado.

buildAsyncClient

public ServiceBusAdministrationAsyncClient buildAsyncClient()

Crea un ServiceBusAdministrationAsyncClient objeto basado en las opciones establecidas en el generador. Cada vez buildAsyncClient que se invoca, se crea una nueva instancia del cliente.

Si pipeline(HttpPipeline pipeline) se establece , y pipelineendpoint(String endpoint) se usan para crear .ServiceBusAdministrationAsyncClient Se omiten todas las demás configuraciones del generador.

Returns:

con ServiceBusAdministrationAsyncClient las opciones establecidas en el generador.

buildClient

public ServiceBusAdministrationClient buildClient()

Crea un ServiceBusAdministrationClient objeto basado en las opciones establecidas en el generador. Cada vez buildClient que se invoca, se crea una nueva instancia del cliente.

Si pipeline(HttpPipeline pipeline) se establece , y pipelineendpoint(String endpoint) se usan para crear .ServiceBusAdministrationClient Se omiten todas las demás configuraciones del generador.

Returns:

con ServiceBusAdministrationClient las opciones establecidas en el generador.

clientOptions

public ServiceBusAdministrationClientBuilder clientOptions(ClientOptions clientOptions)

Permite establecer propiedades comunes, como el identificador de aplicación, los encabezados, la configuración de proxy, etc. Tenga en cuenta que se recomienda llamar a este método con una instancia de la HttpClientOptions clase (una subclase de la ClientOptions clase base). La subclase HttpClientOptions proporciona más opciones de configuración adecuadas para los clientes HTTP, que se aplican a cualquier clase que implemente esta interfaz HttpTrait.

Nota: Es importante comprender el orden de precedencia de las API de HttpTrait. En concreto, si se especifica un HttpPipeline , esto tiene prioridad sobre todas las demás API del rasgo y se omitirán. Si no se especifica , HttpPipeline una canalización HTTP se construirá internamente en función de la configuración proporcionada a este rasgo. Además, puede haber otras API en los tipos que implementan este rasgo que también se omiten si se especifica un HttpPipeline , por lo que asegúrese de consultar la documentación de los tipos que implementan este rasgo para comprender todo el conjunto de implicaciones.

Parameters:

clientOptions - Instancia configurada de HttpClientOptions.

Returns:

Objeto ServiceBusAdministrationClientBuilder actualizado.

configuration

public ServiceBusAdministrationClientBuilder configuration(Configuration configuration)

Establece el almacén de configuración que se usa durante la construcción del cliente de servicio. El almacén de configuración predeterminado es un clon de , se usa NONE para omitir el uso de global configuration storelos valores de configuración durante la construcción.

Parameters:

configuration - El almacén de configuración usado para

Returns:

Objeto ServiceBusAdministrationClientBuilder actualizado.

connectionString

public ServiceBusAdministrationClientBuilder connectionString(String connectionString)

Establece el cadena de conexión para un espacio de nombres de Service Bus o un recurso de Service Bus específico.

Parameters:

connectionString - Cadena de conexión para un espacio de nombres de Service Bus o un recurso de Service Bus específico.

Returns:

Objeto ServiceBusAdministrationClientBuilder actualizado.

credential

public ServiceBusAdministrationClientBuilder credential(AzureSasCredential credential)

Establece la credencial con firma de acceso compartido para el recurso de Service Bus. Consulte Control de acceso de Service Bus con firmas de acceso compartido.

Parameters:

credential - AzureSasCredential que se usará para la autenticación.

Returns:

Objeto ServiceBusAdministrationClientBuilder actualizado.

credential

public ServiceBusAdministrationClientBuilder credential(TokenCredential credential)

Establece el TokenCredential objeto utilizado para autorizar las solicitudes enviadas al servicio. Consulte la documentación de autenticación e identidad de Azure SDK para Java para más información sobre el uso adecuado del TokenCredential tipo.

Parameters:

credential - TokenCredential se usa para autorizar las solicitudes enviadas al servicio.

Returns:

Objeto ServiceBusAdministrationClientBuilder actualizado.

credential

public ServiceBusAdministrationClientBuilder credential(String fullyQualifiedNamespace, TokenCredential credential)

Establece la credencial usada para autenticar las solicitudes HTTP en el espacio de nombres de Service Bus.

Parameters:

fullyQualifiedNamespace - para Service Bus.

credential - TokenCredential que se usará para la autenticación.

Returns:

Objeto ServiceBusAdministrationClientBuilder actualizado.

endpoint

public ServiceBusAdministrationClientBuilder endpoint(String endpoint)

Establece el punto de conexión de servicio para el espacio de nombres de Service Bus.

Parameters:

endpoint - Dirección URL del espacio de nombres de Service Bus.

Returns:

Objeto ServiceBusAdministrationClientBuilder actualizado.

httpClient

public ServiceBusAdministrationClientBuilder httpClient(HttpClient client)

Establece el objeto HttpClient que se va a usar para enviar y recibir solicitudes hacia y desde el servicio.

Nota: Es importante comprender el orden de precedencia de las API de HttpTrait. En concreto, si se especifica un HttpPipeline , esto tiene prioridad sobre todas las demás API del rasgo y se omitirán. Si no se especifica , HttpPipeline una canalización HTTP se construirá internamente en función de la configuración proporcionada a este rasgo. Además, puede haber otras API en los tipos que implementan este rasgo que también se omiten si se especifica un HttpPipeline , por lo que asegúrese de consultar la documentación de los tipos que implementan este rasgo para comprender todo el conjunto de implicaciones.

Parameters:

client - que HttpClient se va a usar para las solicitudes.

Returns:

Objeto ServiceBusAdministrationClientBuilder actualizado.

httpLogOptions

public ServiceBusAdministrationClientBuilder httpLogOptions(HttpLogOptions logOptions)

Establece el objeto HttpLogOptions que se va a usar al enviar y recibir solicitudes hacia y desde el servicio. Si no se proporciona , logLevel se establece el valor predeterminado de HttpLogDetailLevel#NONE .

Nota: Es importante comprender el orden de precedencia de las API de HttpTrait. En concreto, si se especifica un HttpPipeline , esto tiene prioridad sobre todas las demás API del rasgo y se omitirán. Si no se especifica , HttpPipeline una canalización HTTP se construirá internamente en función de la configuración proporcionada a este rasgo. Además, puede haber otras API en los tipos que implementan este rasgo que también se omiten si se especifica un HttpPipeline , por lo que asegúrese de consultar la documentación de los tipos que implementan este rasgo para comprender todo el conjunto de implicaciones.

Parameters:

logOptions - que HttpLogOptions se va a usar al enviar y recibir solicitudes hacia y desde el servicio.

Returns:

Objeto ServiceBusAdministrationClientBuilder actualizado.

pipeline

public ServiceBusAdministrationClientBuilder pipeline(HttpPipeline pipeline)

Establece el objeto HttpPipeline que se va a usar para el cliente de servicio.

Nota: Es importante comprender el orden de precedencia de las API de HttpTrait. En concreto, si se especifica un HttpPipeline , esto tiene prioridad sobre todas las demás API del rasgo y se omitirán. Si no se especifica , HttpPipeline una canalización HTTP se construirá internamente en función de la configuración proporcionada a este rasgo. Además, puede haber otras API en los tipos que implementan este rasgo que también se omiten si se especifica un HttpPipeline , por lo que asegúrese de consultar la documentación de los tipos que implementan este rasgo para comprender todo el conjunto de implicaciones.

No endpoint(String endpoint) se omite cuando pipeline se establece .

Parameters:

pipeline - HttpPipeline para usar para enviar solicitudes de servicio y recibir respuestas.

Returns:

Objeto ServiceBusAdministrationClientBuilder actualizado.

retryOptions

public ServiceBusAdministrationClientBuilder retryOptions(RetryOptions retryOptions)

Establece para RetryOptions todas las solicitudes realizadas a través del cliente.

Nota: Es importante comprender el orden de precedencia de las API de HttpTrait. En concreto, si se especifica un HttpPipeline , esto tiene prioridad sobre todas las demás API del rasgo y se omitirán. Si no se especifica , HttpPipeline una canalización HTTP se construirá internamente en función de la configuración proporcionada a este rasgo. Además, puede haber otras API en los tipos que implementan este rasgo que también se omiten si se especifica un HttpPipeline , por lo que asegúrese de consultar la documentación de los tipos que implementan este rasgo para comprender todo el conjunto de implicaciones.

Establecer esto es mutuamente excluyente con el uso de retryPolicy(HttpPipelinePolicy retryPolicy).

Parameters:

retryOptions - que RetryOptions se va a usar para todas las solicitudes realizadas a través del cliente.

Returns:

Objeto ServiceBusAdministrationClientBuilder actualizado.

retryPolicy

public ServiceBusAdministrationClientBuilder retryPolicy(HttpPipelinePolicy retryPolicy)

Establece el HttpPipelinePolicy objeto que se usa cuando se envía cada solicitud. La directiva de reintento predeterminada se usará si no se proporciona buildAsyncClient() para compilar ServiceBusAdministrationClient o ServiceBusAdministrationAsyncClient. Establecer esto es mutuamente excluyente con el uso de retryOptions(RetryOptions retryOptions).

Parameters:

retryPolicy - La directiva de reintento del usuario aplicada a cada solicitud.

Returns:

Objeto ServiceBusAdministrationClientBuilder actualizado.

serviceVersion

public ServiceBusAdministrationClientBuilder serviceVersion(ServiceBusServiceVersion serviceVersion)

Establece el ServiceBusServiceVersion objeto que se usa. De forma predeterminada getLatest() , se usa cuando no se especifica ninguno.

Parameters:

serviceVersion - Versión del servicio que se va a usar.

Returns:

Objeto ServiceBusAdministrationClientBuilder actualizado.