ServiceBusAdministrationClientBuilder Classe
- java.
lang. Object - com.
azure. messaging. servicebus. administration. ServiceBusAdministrationClientBuilder
- com.
Implémente
public final class ServiceBusAdministrationClientBuilder
implements TokenCredentialTrait<ServiceBusAdministrationClientBuilder>, AzureSasCredentialTrait<ServiceBusAdministrationClientBuilder>, ConnectionStringTrait<ServiceBusAdministrationClientBuilder>, HttpTrait<ServiceBusAdministrationClientBuilder>, ConfigurationTrait<ServiceBusAdministrationClientBuilder>, EndpointTrait<ServiceBusAdministrationClientBuilder>
Cette classe fournit une API Fluent Builder pour faciliter la configuration et l’instanciation de ServiceBusAdministrationClient et ServiceBusAdministrationAsyncClient. Appelez buildClient() et buildAsyncClient() respectivement pour construire un instance du client souhaité.
Les informations d’identification sont requises pour effectuer des opérations sur Azure Service Bus. Ils peuvent être définis à l’aide de l’une des méthodes suivantes :
- connectionString(String connectionString)avec un espace de noms Service Bus chaîne de connexion.
- credential(String fullyQualifiedNamespace, TokenCredential credential) avec l’espace de noms Service Bus complet et un ensemble d’informations d’identification autorisées à utiliser l’espace de noms.
- credential(TokenCredential credential) les surcharges et credential(AzureSasCredential credential) peuvent être utilisées avec leurs informations d’identification respectives. En outre, endpoint(String endpoint) doit être défini.
Les informations d’identification utilisées dans les exemples suivants sont destinées à l’authentification DefaultAzureCredential . Il convient à la plupart des scénarios, y compris aux environnements de développement et de production locaux. En outre, nous vous recommandons d’utiliser une identité managée pour l’authentification dans les environnements de production. Vous trouverez plus d’informations sur les différentes méthodes d’authentification et leurs types d’informations d’identification correspondants dans la documentation Azure Identity.
Exemple : Créer le client de synchronisation
L’exemple de code suivant illustre la création du client d’administration synchrone.
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();
Exemple : Créer le client asynchrone à l’aide d’Azure Identity
L’exemple de code suivant illustre la création du client d’administration asynchrone.
// 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();
Exemple : Créer le client asynchrone
L’exemple de code suivant illustre la création du client d’administration asynchrone avec des options de nouvelle tentative et des options de journal HTTP configurées.
// 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();
Récapitulatif du constructeur
| Constructeur | Description |
|---|---|
| ServiceBusAdministrationClientBuilder() |
Construit un générateur avec les paramètres par défaut. |
Résumé de la méthode
Méthodes héritées de java.lang.Object
Détails du constructeur
ServiceBusAdministrationClientBuilder
public ServiceBusAdministrationClientBuilder()
Construit un générateur avec les paramètres par défaut.
Détails de la méthode
addPolicy
public ServiceBusAdministrationClientBuilder addPolicy(HttpPipelinePolicy policy)
Ajoute un HttpPipelinePolicy à appliquer à chaque requête envoyée.
Note: Il est important de comprendre l’ordre de priorité des API HttpTrait. En particulier, si un HttpPipeline est spécifié, cela est prioritaire sur toutes les autres API du trait et elles sont ignorées. Si aucun n’est HttpPipeline spécifié, un pipeline HTTP est construit en interne en fonction des paramètres fournis à cette caractéristique. En outre, il peut y avoir d’autres API dans les types qui implémentent ce trait qui sont également ignorées si un HttpPipeline est spécifié. Veillez donc à vous reporter à la documentation des types qui implémentent ce trait pour comprendre l’ensemble complet des implications.
Parameters:
Returns:
buildAsyncClient
public ServiceBusAdministrationAsyncClient buildAsyncClient()
Crée un en fonction des ServiceBusAdministrationAsyncClient options définies dans le générateur. Chaque fois buildAsyncClient qu’est appelé, une nouvelle instance du client est créée.
Si pipeline(HttpPipeline pipeline) est défini, les pipeline et endpoint(String endpoint) sont utilisés pour créer le ServiceBusAdministrationAsyncClient. Tous les autres paramètres du générateur sont ignorés.
Returns:
buildClient
public ServiceBusAdministrationClient buildClient()
Crée un en fonction des ServiceBusAdministrationClient options définies dans le générateur. Chaque fois buildClient qu’est appelé, une nouvelle instance du client est créée.
Si pipeline(HttpPipeline pipeline) est défini, les pipeline et endpoint(String endpoint) sont utilisés pour créer le ServiceBusAdministrationClient. Tous les autres paramètres du générateur sont ignorés.
Returns:
clientOptions
public ServiceBusAdministrationClientBuilder clientOptions(ClientOptions clientOptions)
Permet de définir des propriétés courantes telles que l’ID d’application, les en-têtes, la configuration du proxy, etc. Notez qu’il est recommandé d’appeler cette méthode avec un instance de la HttpClientOptions classe (une sous-classe de la ClientOptions classe de base). La sous-classe HttpClientOptions fournit davantage d’options de configuration adaptées aux clients HTTP, ce qui s’applique à toute classe qui implémente cette interface HttpTrait.
Note: Il est important de comprendre l’ordre de priorité des API HttpTrait. En particulier, si un HttpPipeline est spécifié, cela est prioritaire sur toutes les autres API du trait et elles sont ignorées. Si aucun n’est HttpPipeline spécifié, un pipeline HTTP est construit en interne en fonction des paramètres fournis à cette caractéristique. En outre, il peut y avoir d’autres API dans les types qui implémentent ce trait qui sont également ignorées si un HttpPipeline est spécifié. Veillez donc à vous reporter à la documentation des types qui implémentent ce trait pour comprendre l’ensemble complet des implications.
Parameters:
Returns:
configuration
public ServiceBusAdministrationClientBuilder configuration(Configuration configuration)
Définit le magasin de configuration utilisé pendant la construction du client de service. Le magasin de configuration par défaut est un clone du , utilisez NONE pour contourner l’utilisation des paramètres de configuration pendant la global configuration storeconstruction.
Parameters:
Returns:
connectionString
public ServiceBusAdministrationClientBuilder connectionString(String connectionString)
Définit le chaîne de connexion d’un espace de noms Service Bus ou d’une ressource Service Bus spécifique.
Parameters:
Returns:
credential
public ServiceBusAdministrationClientBuilder credential(AzureSasCredential credential)
Définit les informations d’identification avec la signature d’accès partagé pour la ressource Service Bus. Reportez-vous à Contrôle d’accès Service Bus avec signatures d’accès partagé.
Parameters:
Returns:
credential
public ServiceBusAdministrationClientBuilder credential(TokenCredential credential)
Définit le TokenCredential utilisé pour autoriser les requêtes envoyées au service. Pour plus d’informations sur l’utilisation appropriée du type, consultez la documentation sur l’identité et l’authentification du TokenCredential Kit de développement logiciel (SDK) Azure pour Java.
Parameters:
Returns:
credential
public ServiceBusAdministrationClientBuilder credential(String fullyQualifiedNamespace, TokenCredential credential)
Définit les informations d’identification utilisées pour authentifier les requêtes HTTP auprès de l’espace de noms Service Bus.
Parameters:
Returns:
endpoint
public ServiceBusAdministrationClientBuilder endpoint(String endpoint)
Définit le point de terminaison de service pour l’espace de noms Service Bus.
Parameters:
Returns:
httpClient
public ServiceBusAdministrationClientBuilder httpClient(HttpClient client)
Définit le HttpClient à utiliser pour l’envoi et la réception de requêtes vers et à partir du service.
Note: Il est important de comprendre l’ordre de priorité des API HttpTrait. En particulier, si un HttpPipeline est spécifié, cela est prioritaire sur toutes les autres API du trait et elles seront ignorées. Si aucun n’est HttpPipeline spécifié, un pipeline HTTP est construit en interne en fonction des paramètres fournis à cette caractéristique. En outre, il peut y avoir d’autres API dans les types qui implémentent ce trait qui sont également ignorés si un HttpPipeline est spécifié. Veillez donc à consulter la documentation des types qui implémentent cette caractéristique pour comprendre l’ensemble complet des implications.
Parameters:
Returns:
httpLogOptions
public ServiceBusAdministrationClientBuilder httpLogOptions(HttpLogOptions logOptions)
Définit le à utiliser lors de l’envoi HttpLogOptions et de la réception de requêtes vers et à partir du service. Si un logLevel n’est pas fourni, la valeur par défaut de HttpLogDetailLevel#NONE est définie.
Note: Il est important de comprendre l’ordre de priorité des API HttpTrait. En particulier, si un HttpPipeline est spécifié, cela est prioritaire sur toutes les autres API du trait et elles seront ignorées. Si aucun n’est HttpPipeline spécifié, un pipeline HTTP est construit en interne en fonction des paramètres fournis à cette caractéristique. En outre, il peut y avoir d’autres API dans les types qui implémentent ce trait qui sont également ignorés si un HttpPipeline est spécifié. Veillez donc à consulter la documentation des types qui implémentent cette caractéristique pour comprendre l’ensemble complet des implications.
Parameters:
Returns:
pipeline
public ServiceBusAdministrationClientBuilder pipeline(HttpPipeline pipeline)
Définit le HttpPipeline à utiliser pour le client de service.
Note: Il est important de comprendre l’ordre de priorité des API HttpTrait. En particulier, si un HttpPipeline est spécifié, cela est prioritaire sur toutes les autres API du trait et elles seront ignorées. Si aucun n’est HttpPipeline spécifié, un pipeline HTTP est construit en interne en fonction des paramètres fournis à cette caractéristique. En outre, il peut y avoir d’autres API dans les types qui implémentent ce trait qui sont également ignorés si un HttpPipeline est spécifié. Veillez donc à consulter la documentation des types qui implémentent cette caractéristique pour comprendre l’ensemble complet des implications.
Le endpoint(String endpoint) n’est pas ignoré quand pipeline est défini.
Parameters:
Returns:
retryOptions
public ServiceBusAdministrationClientBuilder retryOptions(RetryOptions retryOptions)
Définit le RetryOptions pour toutes les demandes effectuées via le client.
Note: Il est important de comprendre l’ordre de priorité des API HttpTrait. En particulier, si un HttpPipeline est spécifié, cela est prioritaire sur toutes les autres API du trait et elles seront ignorées. Si aucun n’est HttpPipeline spécifié, un pipeline HTTP est construit en interne en fonction des paramètres fournis à cette caractéristique. En outre, il peut y avoir d’autres API dans les types qui implémentent ce trait qui sont également ignorés si un HttpPipeline est spécifié. Veillez donc à consulter la documentation des types qui implémentent cette caractéristique pour comprendre l’ensemble complet des implications.
La définition de cette valeur s’exclue mutuellement avec l’utilisation de retryPolicy(HttpPipelinePolicy retryPolicy).
Parameters:
Returns:
retryPolicy
public ServiceBusAdministrationClientBuilder retryPolicy(HttpPipelinePolicy retryPolicy)
Définit le HttpPipelinePolicy qui est utilisé lors de l’envoi de chaque requête. La stratégie de nouvelle tentative par défaut sera utilisée si elle n’est pas fournie buildAsyncClient() pour générer ServiceBusAdministrationClient ou ServiceBusAdministrationAsyncClient. La définition de cette valeur s’exclue mutuellement avec l’utilisation de retryOptions(RetryOptions retryOptions).
Parameters:
Returns:
serviceVersion
public ServiceBusAdministrationClientBuilder serviceVersion(ServiceBusServiceVersion serviceVersion)
Définit le ServiceBusServiceVersion qui est utilisé. Par défaut getLatest() , est utilisé lorsqu’aucun n’est spécifié.
Parameters:
Returns:
S’applique à
Azure SDK for Java