ServiceBusAdministrationClientBuilder Classe
- java.
lang. Object - com.
azure. messaging. servicebus. administration. ServiceBusAdministrationClientBuilder
- com.
Implementações
public final class ServiceBusAdministrationClientBuilder
implements TokenCredentialTrait<ServiceBusAdministrationClientBuilder>, AzureSasCredentialTrait<ServiceBusAdministrationClientBuilder>, ConnectionStringTrait<ServiceBusAdministrationClientBuilder>, HttpTrait<ServiceBusAdministrationClientBuilder>, ConfigurationTrait<ServiceBusAdministrationClientBuilder>, EndpointTrait<ServiceBusAdministrationClientBuilder>
Essa classe fornece uma API de construtor fluente para ajudar a ajudar na configuração e na instanciação de ServiceBusAdministrationClient e ServiceBusAdministrationAsyncClient. Chame buildClient() e buildAsyncClient() , respectivamente, para construir uma instância do cliente desejado.
As credenciais são necessárias para executar operações em Barramento de Serviço do Azure. Eles podem ser definidos usando um dos seguintes métodos:
- connectionString(String connectionString)com um namespace do Barramento de Serviço cadeia de conexão.
- credential(String fullyQualifiedNamespace, TokenCredential credential) com o namespace do Barramento de Serviço totalmente qualificado e um conjunto de credenciais autorizadas a usar o namespace.
- credential(TokenCredential credential) e credential(AzureSasCredential credential) sobrecargas podem ser usadas com suas respectivas credenciais. Além disso, endpoint(String endpoint) deve ser definido.
A credencial usada nos exemplos a seguir é DefaultAzureCredential para autenticação. É apropriado para a maioria dos cenários, incluindo ambientes locais de desenvolvimento e produção. Além disso, recomendamos usar a identidade gerenciada para autenticação em ambientes de produção. Você pode encontrar mais informações sobre diferentes maneiras de autenticação e seus tipos de credencial correspondentes na documentação da Identidade do Azure.
Exemplo: criar o cliente de sincronização
O exemplo de código a seguir demonstra a criação do cliente de administração síncrona.
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();
Exemplo: criar o cliente assíncrono usando a Identidade do Azure
O exemplo de código a seguir demonstra a criação do cliente de administração assíncrona.
// 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();
Exemplo: criar o cliente assíncrono
O exemplo de código a seguir demonstra a criação do cliente de administração assíncrona com opções de repetição e opções de log 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();
Resumo do Construtor
| Construtor | Description |
|---|---|
| ServiceBusAdministrationClientBuilder() |
Constrói um construtor com os parâmetros padrão. |
Resumo do método
Métodos herdados de java.lang.Object
Detalhes do construtor
ServiceBusAdministrationClientBuilder
public ServiceBusAdministrationClientBuilder()
Constrói um construtor com os parâmetros padrão.
Detalhes do método
addPolicy
public ServiceBusAdministrationClientBuilder addPolicy(HttpPipelinePolicy policy)
Adiciona um HttpPipelinePolicy a ser aplicado em cada solicitação enviada.
Nota: É importante entender a ordem de precedência das APIs HttpTrait. Em particular, se um HttpPipeline for especificado, isso terá precedência sobre todas as outras APIs na característica e elas serão ignoradas. Se não HttpPipeline for especificado, um pipeline HTTP será construído internamente com base nas configurações fornecidas a essa característica. Além disso, pode haver outras APIs em tipos que implementam essa característica que também são ignoradas se um HttpPipeline for especificado, portanto, consulte a documentação de tipos que implementam essa característica para entender o conjunto completo de implicações.
Parameters:
Returns:
buildAsyncClient
public ServiceBusAdministrationAsyncClient buildAsyncClient()
Cria um ServiceBusAdministrationAsyncClient com base nas opções definidas no construtor. Sempre que buildAsyncClient é invocado, uma nova instância do cliente é criada.
Se pipeline(HttpPipeline pipeline) estiver definido, o pipeline e endpoint(String endpoint) serão usados para criar o ServiceBusAdministrationAsyncClient. Todas as outras configurações do construtor são ignoradas.
Returns:
buildClient
public ServiceBusAdministrationClient buildClient()
Cria um ServiceBusAdministrationClient com base nas opções definidas no construtor. Sempre que buildClient é invocado, uma nova instância do cliente é criada.
Se pipeline(HttpPipeline pipeline) estiver definido, o pipeline e endpoint(String endpoint) serão usados para criar o ServiceBusAdministrationClient. Todas as outras configurações do construtor são ignoradas.
Returns:
clientOptions
public ServiceBusAdministrationClientBuilder clientOptions(ClientOptions clientOptions)
Permite definir propriedades comuns, como ID do aplicativo, cabeçalhos, configuração de proxy etc. Observe que é recomendável que esse método seja chamado com uma instância da HttpClientOptions classe (uma subclasse da ClientOptions classe base). A subclasse HttpClientOptions fornece mais opções de configuração adequadas para clientes HTTP, que é aplicável a qualquer classe que implemente essa interface HttpTrait.
Nota: É importante entender a ordem de precedência das APIs HttpTrait. Em particular, se um HttpPipeline for especificado, isso terá precedência sobre todas as outras APIs na característica e elas serão ignoradas. Se não HttpPipeline for especificado, um pipeline HTTP será construído internamente com base nas configurações fornecidas a essa característica. Além disso, pode haver outras APIs em tipos que implementam essa característica que também são ignoradas se um HttpPipeline for especificado, portanto, consulte a documentação de tipos que implementam essa característica para entender o conjunto completo de implicações.
Parameters:
Returns:
configuration
public ServiceBusAdministrationClientBuilder configuration(Configuration configuration)
Define o repositório de configuração usado durante a construção do cliente de serviço. O repositório de configuração padrão é um clone do global configuration store, usado NONE para ignorar o uso das configurações durante a construção.
Parameters:
Returns:
connectionString
public ServiceBusAdministrationClientBuilder connectionString(String connectionString)
Define o cadeia de conexão para um namespace do Barramento de Serviço ou um recurso específico do Barramento de Serviço.
Parameters:
Returns:
credential
public ServiceBusAdministrationClientBuilder credential(AzureSasCredential credential)
Define a credencial com a Assinatura de Acesso Compartilhado para o recurso do Barramento de Serviço. Consulte Controle de acesso do Barramento de Serviço com Assinaturas de Acesso Compartilhado.
Parameters:
Returns:
credential
public ServiceBusAdministrationClientBuilder credential(TokenCredential credential)
Define o TokenCredential usado para autorizar solicitações enviadas ao serviço. Consulte a documentação de identidade e autenticação do SDK do Azure para Java para obter mais detalhes sobre o uso adequado do TokenCredential tipo.
Parameters:
Returns:
credential
public ServiceBusAdministrationClientBuilder credential(String fullyQualifiedNamespace, TokenCredential credential)
Define a credencial usada para autenticar solicitações HTTP no namespace do Barramento de Serviço.
Parameters:
Returns:
endpoint
public ServiceBusAdministrationClientBuilder endpoint(String endpoint)
Define o ponto de extremidade de serviço para o namespace do Barramento de Serviço.
Parameters:
Returns:
httpClient
public ServiceBusAdministrationClientBuilder httpClient(HttpClient client)
Define o HttpClient a ser usado para enviar e receber solicitações de e para o serviço.
Nota: É importante entender a ordem de precedência das APIs HttpTrait. Em particular, se um HttpPipeline for especificado, isso terá precedência sobre todas as outras APIs na característica e elas serão ignoradas. Se não HttpPipeline for especificado, um pipeline HTTP será construído internamente com base nas configurações fornecidas a essa característica. Além disso, pode haver outras APIs em tipos que implementam essa característica que também são ignoradas se um HttpPipeline for especificado, portanto, consulte a documentação de tipos que implementam essa característica para entender o conjunto completo de implicações.
Parameters:
Returns:
httpLogOptions
public ServiceBusAdministrationClientBuilder httpLogOptions(HttpLogOptions logOptions)
Define o HttpLogOptions a ser usado ao enviar e receber solicitações de e para o serviço. Se um logLevel não for fornecido, o valor padrão de HttpLogDetailLevel#NONE será definido.
Nota: É importante entender a ordem de precedência das APIs HttpTrait. Em particular, se um HttpPipeline for especificado, isso terá precedência sobre todas as outras APIs na característica e elas serão ignoradas. Se não HttpPipeline for especificado, um pipeline HTTP será construído internamente com base nas configurações fornecidas a essa característica. Além disso, pode haver outras APIs em tipos que implementam essa característica que também são ignoradas se um HttpPipeline for especificado, portanto, consulte a documentação de tipos que implementam essa característica para entender o conjunto completo de implicações.
Parameters:
Returns:
pipeline
public ServiceBusAdministrationClientBuilder pipeline(HttpPipeline pipeline)
Define o HttpPipeline a ser usado para o cliente de serviço.
Nota: É importante entender a ordem de precedência das APIs HttpTrait. Em particular, se um HttpPipeline for especificado, isso terá precedência sobre todas as outras APIs na característica e elas serão ignoradas. Se não HttpPipeline for especificado, um pipeline HTTP será construído internamente com base nas configurações fornecidas a essa característica. Além disso, pode haver outras APIs em tipos que implementam essa característica que também são ignoradas se um HttpPipeline for especificado, portanto, consulte a documentação de tipos que implementam essa característica para entender o conjunto completo de implicações.
O endpoint(String endpoint) não é ignorado quando pipeline é definido.
Parameters:
Returns:
retryOptions
public ServiceBusAdministrationClientBuilder retryOptions(RetryOptions retryOptions)
Define o RetryOptions para todas as solicitações feitas por meio do cliente.
Nota: É importante entender a ordem de precedência das APIs HttpTrait. Em particular, se um HttpPipeline for especificado, isso terá precedência sobre todas as outras APIs na característica e elas serão ignoradas. Se não HttpPipeline for especificado, um pipeline HTTP será construído internamente com base nas configurações fornecidas a essa característica. Além disso, pode haver outras APIs em tipos que implementam essa característica que também são ignoradas se um HttpPipeline for especificado, portanto, consulte a documentação de tipos que implementam essa característica para entender o conjunto completo de implicações.
Definir isso é mutuamente exclusivo com o uso de retryPolicy(HttpPipelinePolicy retryPolicy).
Parameters:
Returns:
retryPolicy
public ServiceBusAdministrationClientBuilder retryPolicy(HttpPipelinePolicy retryPolicy)
Define o HttpPipelinePolicy usado quando cada solicitação é enviada. A política de repetição padrão será usada se não for fornecida buildAsyncClient() para compilar ServiceBusAdministrationClient ou ServiceBusAdministrationAsyncClient. Definir isso é mutuamente exclusivo com o uso de retryOptions(RetryOptions retryOptions).
Parameters:
Returns:
serviceVersion
public ServiceBusAdministrationClientBuilder serviceVersion(ServiceBusServiceVersion serviceVersion)
Define o ServiceBusServiceVersion que é usado. Por padrão getLatest() , é usado quando nenhum é especificado.
Parameters:
Returns:
Aplica-se a
Azure SDK for Java