Freigeben über

ServiceBusAdministrationClientBuilder Klasse

  • Referenz
Paket:
com.azure.messaging.servicebus.administration
Maven-Artefakt:
com.azure:azure-messaging-servicebus:7.17.0
  • java.lang.Object
    • com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder

Implementiert

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>

Diese Klasse bietet eine Fluent-Generator-API, um die Konfiguration und Instanziierung von ServiceBusAdministrationClient und ServiceBusAdministrationAsyncClientzu unterstützen. Rufen Sie buildClient() bzwbuildAsyncClient(). auf, um eine instance des gewünschten Clients zu erstellen.

Anmeldeinformationen sind erforderlich, um Vorgänge für Azure Service Bus auszuführen. Sie können mit einer der folgenden Methoden festgelegt werden:

Die in den folgenden Beispielen verwendeten Anmeldeinformationen dienen DefaultAzureCredential der Authentifizierung. Es eignet sich für die meisten Szenarien, einschließlich lokaler Entwicklungs- und Produktionsumgebungen. Darüber hinaus wird empfohlen, die verwaltete Identität für die Authentifizierung in Produktionsumgebungen zu verwenden. Weitere Informationen zu verschiedenen Authentifizierungsmethoden und den entsprechenden Anmeldeinformationstypen finden Sie in der Dokumentation zu Azure Identity.

Beispiel: Erstellen des Synchronisierungsclients

Im folgenden Codebeispiel wird die Erstellung des synchronen Verwaltungsclients veranschaulicht.

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();

Beispiel: Erstellen des asynchronen Clients mithilfe von Azure Identity

Im folgenden Codebeispiel wird die Erstellung des asynchronen Verwaltungsclients veranschaulicht.

// 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();

Beispiel: Erstellen des asynchronen Clients

Das folgende Codebeispiel veranschaulicht die Erstellung des asynchronen Verwaltungsclients mit konfigurierten Wiederholungsoptionen und HTTP-Protokolloptionen.

// 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();

Zusammenfassung zum Konstruktor

Konstruktor Beschreibung
ServiceBusAdministrationClientBuilder()

Erstellt einen Generator mit den Standardparametern.

Methodenzusammenfassung

Modifizierer und Typ Methode und Beschreibung
ServiceBusAdministrationClientBuilder addPolicy(HttpPipelinePolicy policy)

Fügt eine HttpPipelinePolicy hinzu, die auf jede gesendete Anforderung angewendet werden soll.
ServiceBusAdministrationAsyncClient buildAsyncClient()

Erstellt eine ServiceBusAdministrationAsyncClient basierend auf den im Generator festgelegten Optionen.
ServiceBusAdministrationClient buildClient()

Erstellt eine ServiceBusAdministrationClient basierend auf den im Generator festgelegten Optionen.
ServiceBusAdministrationClientBuilder clientOptions(ClientOptions clientOptions)

Ermöglicht das Festlegen allgemeiner Eigenschaften wie Anwendungs-ID, Header, Proxykonfiguration usw.
ServiceBusAdministrationClientBuilder configuration(Configuration configuration)

Legt den Konfigurationsspeicher fest, der beim Erstellen des Dienstclients verwendet wird.
ServiceBusAdministrationClientBuilder connectionString(String connectionString)

Legt die Verbindungszeichenfolge für einen Service Bus-Namespace oder eine bestimmte Service Bus-Ressource fest.
ServiceBusAdministrationClientBuilder credential(AzureSasCredential credential)

Legt die Anmeldeinformationen mit Shared Access Signature für die Service Bus-Ressource fest.
ServiceBusAdministrationClientBuilder credential(TokenCredential credential)

Legt den fest, der TokenCredential zum Autorisieren von Anforderungen verwendet wird, die an den Dienst gesendet werden.
ServiceBusAdministrationClientBuilder credential(String fullyQualifiedNamespace, TokenCredential credential)

Legt die Anmeldeinformationen fest, die zum Authentifizieren von HTTP-Anforderungen für den Service Bus-Namespace verwendet werden.
ServiceBusAdministrationClientBuilder endpoint(String endpoint)

Legt den Dienstendpunkt für den Service Bus-Namespace fest.
ServiceBusAdministrationClientBuilder httpClient(HttpClient client)

Legt fest, dass HttpClient zum Senden und Empfangen von Anforderungen an und vom Dienst verwendet werden soll.
ServiceBusAdministrationClientBuilder httpLogOptions(HttpLogOptions logOptions)

Legt fest, dass HttpLogOptions beim Senden und Empfangen von Anforderungen an und vom Dienst verwendet werden soll.
ServiceBusAdministrationClientBuilder pipeline(HttpPipeline pipeline)

Legt fest, dass HttpPipeline für den Dienstclient verwendet werden soll.
ServiceBusAdministrationClientBuilder retryOptions(RetryOptions retryOptions)

Legt den RetryOptions für alle Anforderungen fest, die über den Client gesendet werden.
ServiceBusAdministrationClientBuilder retryPolicy(HttpPipelinePolicy retryPolicy)

Legt den fest, der HttpPipelinePolicy verwendet wird, wenn jede Anforderung gesendet wird.
ServiceBusAdministrationClientBuilder serviceVersion(ServiceBusServiceVersion serviceVersion)

Legt den fest, der ServiceBusServiceVersion verwendet wird.

Geerbte Methoden von java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Details zum Konstruktor

ServiceBusAdministrationClientBuilder

public ServiceBusAdministrationClientBuilder()

Erstellt einen Generator mit den Standardparametern.

Details zur Methode

addPolicy

public ServiceBusAdministrationClientBuilder addPolicy(HttpPipelinePolicy policy)

Fügt eine HttpPipelinePolicy hinzu, die auf jede gesendete Anforderung angewendet werden soll.

Hinweis: Es ist wichtig, die Rangfolge der HttpTrait-APIs zu verstehen. Insbesondere, wenn ein HttpPipeline angegeben wird, hat dies Vorrang vor allen anderen APIs im Trait, und sie werden ignoriert. Wenn nein HttpPipeline angegeben ist, wird eine HTTP-Pipeline intern basierend auf den Einstellungen erstellt, die für dieses Merkmal bereitgestellt werden. Darüber hinaus gibt es möglicherweise andere APIs in Typen, die dieses Merkmal implementieren, die auch ignoriert werden, wenn ein HttpPipeline angegeben ist. Lesen Sie daher unbedingt die Dokumentation der Typen, die dieses Merkmal implementieren, um den vollständigen Satz von Auswirkungen zu verstehen.

Parameters:

policy - einen HttpPipelinePolicy

Returns:

Das aktualisierte ServiceBusAdministrationClientBuilder Objekt.

buildAsyncClient

public ServiceBusAdministrationAsyncClient buildAsyncClient()

Erstellt eine ServiceBusAdministrationAsyncClient basierend auf den im Generator festgelegten Optionen. buildAsyncClient Bei jedem Aufruf wird eine neue instance des Clients erstellt.

Wenn pipeline(HttpPipeline pipeline) festgelegt ist, werden und pipelineendpoint(String endpoint) zum Erstellen von ServiceBusAdministrationAsyncClientverwendet. Alle anderen Generatoreinstellungen werden ignoriert.

Returns:

Ein ServiceBusAdministrationAsyncClient mit den im Generator festgelegten Optionen.

buildClient

public ServiceBusAdministrationClient buildClient()

Erstellt eine ServiceBusAdministrationClient basierend auf den im Generator festgelegten Optionen. buildClient Bei jedem Aufruf wird eine neue instance des Clients erstellt.

Wenn pipeline(HttpPipeline pipeline) festgelegt ist, werden und pipelineendpoint(String endpoint) zum Erstellen von ServiceBusAdministrationClientverwendet. Alle anderen Generatoreinstellungen werden ignoriert.

Returns:

Ein ServiceBusAdministrationClient mit den im Generator festgelegten Optionen.

clientOptions

public ServiceBusAdministrationClientBuilder clientOptions(ClientOptions clientOptions)

Ermöglicht das Festlegen allgemeiner Eigenschaften wie Anwendungs-ID, Header, Proxykonfiguration usw. Beachten Sie, dass es empfohlen wird, diese Methode mit einem instance der HttpClientOptions -Klasse (einer Unterklasse der ClientOptions Basisklasse) zu aufrufen. Die Unterklasse HttpClientOptions bietet weitere Konfigurationsoptionen, die für HTTP-Clients geeignet sind. Dies gilt für jede Klasse, die diese HttpTrait-Schnittstelle implementiert.

Hinweis: Es ist wichtig, die Rangfolge der HttpTrait-APIs zu verstehen. Insbesondere, wenn ein HttpPipeline angegeben wird, hat dies Vorrang vor allen anderen APIs im Trait, und sie werden ignoriert. Wenn nein HttpPipeline angegeben ist, wird eine HTTP-Pipeline intern basierend auf den Einstellungen erstellt, die für dieses Merkmal bereitgestellt werden. Darüber hinaus gibt es möglicherweise andere APIs in Typen, die dieses Merkmal implementieren, die auch ignoriert werden, wenn ein HttpPipeline angegeben ist. Lesen Sie daher unbedingt die Dokumentation der Typen, die dieses Merkmal implementieren, um den vollständigen Satz von Auswirkungen zu verstehen.

Parameters:

clientOptions - Eine konfigurierte instance von HttpClientOptions.

Returns:

Das aktualisierte ServiceBusAdministrationClientBuilder Objekt.

configuration

public ServiceBusAdministrationClientBuilder configuration(Configuration configuration)

Legt den Konfigurationsspeicher fest, der beim Erstellen des Dienstclients verwendet wird. Der Standardkonfigurationsspeicher ist ein Klon von , NONE verwenden global configuration storeSie, um die Verwendung von Konfigurationseinstellungen während der Konstruktion zu umgehen.

Parameters:

configuration - Der verwendete Konfigurationsspeicher

Returns:

Das aktualisierte ServiceBusAdministrationClientBuilder Objekt.

connectionString

public ServiceBusAdministrationClientBuilder connectionString(String connectionString)

Legt die Verbindungszeichenfolge für einen Service Bus-Namespace oder eine bestimmte Service Bus-Ressource fest.

Parameters:

connectionString - Verbindungszeichenfolge für einen Service Bus-Namespace oder eine bestimmte Service Bus-Ressource.

Returns:

Das aktualisierte ServiceBusAdministrationClientBuilder Objekt.

credential

public ServiceBusAdministrationClientBuilder credential(AzureSasCredential credential)

Legt die Anmeldeinformationen mit Shared Access Signature für die Service Bus-Ressource fest. Weitere Informationen finden Sie unter Service Bus-Zugriffssteuerung mit Shared Access Signatures.

Parameters:

credential - AzureSasCredential für die Authentifizierung zu verwenden.

Returns:

Das aktualisierte ServiceBusAdministrationClientBuilder Objekt.

credential

public ServiceBusAdministrationClientBuilder credential(TokenCredential credential)

Legt den fest, der TokenCredential zum Autorisieren von Anforderungen verwendet wird, die an den Dienst gesendet werden. Weitere Informationen zur ordnungsgemäßen Verwendung des Typs finden Sie in der Dokumentation zur Identität und Authentifizierung des TokenCredential Azure SDK für Java.

Parameters:

credential - TokenCredential wird verwendet, um an den Dienst gesendete Anforderungen zu autorisieren.

Returns:

Das aktualisierte ServiceBusAdministrationClientBuilder Objekt.

credential

public ServiceBusAdministrationClientBuilder credential(String fullyQualifiedNamespace, TokenCredential credential)

Legt die Anmeldeinformationen fest, die zum Authentifizieren von HTTP-Anforderungen für den Service Bus-Namespace verwendet werden.

Parameters:

fullyQualifiedNamespace - für Service Bus.
credential - TokenCredential für die Authentifizierung zu verwenden.

Returns:

Das aktualisierte ServiceBusAdministrationClientBuilder Objekt.

endpoint

public ServiceBusAdministrationClientBuilder endpoint(String endpoint)

Legt den Dienstendpunkt für den Service Bus-Namespace fest.

Parameters:

endpoint - Die URL des Service Bus-Namespace.

Returns:

Das aktualisierte ServiceBusAdministrationClientBuilder Objekt.

httpClient

public ServiceBusAdministrationClientBuilder httpClient(HttpClient client)

Legt fest, dass HttpClient zum Senden und Empfangen von Anforderungen an und vom Dienst verwendet werden soll.

Hinweis: Es ist wichtig, die Rangfolge der HttpTrait-APIs zu verstehen. Insbesondere wenn ein HttpPipeline angegeben wird, hat dies Vorrang vor allen anderen APIs in der Eigenschaft, und sie werden ignoriert. Wenn kein HttpPipeline angegeben ist, wird intern eine HTTP-Pipeline basierend auf den Einstellungen erstellt, die für dieses Merkmal bereitgestellt werden. Darüber hinaus können andere APIs in Typen vorhanden sein, die dieses Merkmal implementieren, die auch ignoriert werden, wenn ein HttpPipeline angegeben wird. Lesen Sie daher unbedingt die Dokumentation der Typen, die dieses Merkmal implementieren, um den vollständigen Satz von Auswirkungen zu verstehen.

Parameters:

client - Die , die HttpClient für Anforderungen verwendet werden soll.

Returns:

Das aktualisierte ServiceBusAdministrationClientBuilder Objekt.

httpLogOptions

public ServiceBusAdministrationClientBuilder httpLogOptions(HttpLogOptions logOptions)

Legt fest, dass HttpLogOptions beim Senden und Empfangen von Anforderungen an und vom Dienst verwendet werden soll. Wenn kein logLevel angegeben wird, wird der Standardwert von HttpLogDetailLevel#NONE festgelegt.

Hinweis: Es ist wichtig, die Rangfolge der HttpTrait-APIs zu verstehen. Insbesondere wenn ein HttpPipeline angegeben wird, hat dies Vorrang vor allen anderen APIs in der Eigenschaft, und sie werden ignoriert. Wenn kein HttpPipeline angegeben ist, wird intern eine HTTP-Pipeline basierend auf den Einstellungen erstellt, die für dieses Merkmal bereitgestellt werden. Darüber hinaus können andere APIs in Typen vorhanden sein, die dieses Merkmal implementieren, die auch ignoriert werden, wenn ein HttpPipeline angegeben wird. Lesen Sie daher unbedingt die Dokumentation der Typen, die dieses Merkmal implementieren, um den vollständigen Satz von Auswirkungen zu verstehen.

Parameters:

logOptions - Die HttpLogOptions , die beim Senden und Empfangen von Anforderungen an und vom Dienst verwendet werden soll.

Returns:

Das aktualisierte ServiceBusAdministrationClientBuilder Objekt.

pipeline

public ServiceBusAdministrationClientBuilder pipeline(HttpPipeline pipeline)

Legt fest, dass HttpPipeline für den Dienstclient verwendet werden soll.

Hinweis: Es ist wichtig, die Rangfolge der HttpTrait-APIs zu verstehen. Insbesondere wenn ein HttpPipeline angegeben wird, hat dies Vorrang vor allen anderen APIs in der Eigenschaft, und sie werden ignoriert. Wenn kein HttpPipeline angegeben ist, wird intern eine HTTP-Pipeline basierend auf den Einstellungen erstellt, die für dieses Merkmal bereitgestellt werden. Darüber hinaus können andere APIs in Typen vorhanden sein, die dieses Merkmal implementieren, die auch ignoriert werden, wenn ein HttpPipeline angegeben wird. Lesen Sie daher unbedingt die Dokumentation der Typen, die dieses Merkmal implementieren, um den vollständigen Satz von Auswirkungen zu verstehen.

Wird endpoint(String endpoint) nicht ignoriert, wenn pipeline festgelegt ist.

Parameters:

pipeline - HttpPipeline , um Dienstanforderungen zu senden und Antworten zu empfangen.

Returns:

Das aktualisierte ServiceBusAdministrationClientBuilder Objekt.

retryOptions

public ServiceBusAdministrationClientBuilder retryOptions(RetryOptions retryOptions)

Legt den RetryOptions für alle Anforderungen fest, die über den Client gesendet werden.

Hinweis: Es ist wichtig, die Rangfolge der HttpTrait-APIs zu verstehen. Insbesondere wenn ein HttpPipeline angegeben wird, hat dies Vorrang vor allen anderen APIs in der Eigenschaft, und sie werden ignoriert. Wenn kein HttpPipeline angegeben ist, wird intern eine HTTP-Pipeline basierend auf den Einstellungen erstellt, die für dieses Merkmal bereitgestellt werden. Darüber hinaus können andere APIs in Typen vorhanden sein, die dieses Merkmal implementieren, die auch ignoriert werden, wenn ein HttpPipeline angegeben wird. Lesen Sie daher unbedingt die Dokumentation der Typen, die dieses Merkmal implementieren, um den vollständigen Satz von Auswirkungen zu verstehen.

Das Festlegen dieser Einstellung schließt sich mit gegenseitig retryPolicy(HttpPipelinePolicy retryPolicy)aus.

Parameters:

retryOptions - Die RetryOptions , die für alle Anforderungen verwendet werden soll, die über den Client gesendet werden.

Returns:

Das aktualisierte ServiceBusAdministrationClientBuilder Objekt.

retryPolicy

public ServiceBusAdministrationClientBuilder retryPolicy(HttpPipelinePolicy retryPolicy)

Legt den fest, der HttpPipelinePolicy verwendet wird, wenn jede Anforderung gesendet wird. Die Standardwiebelerichtlinie wird verwendet, wenn sie nicht zum Erstellen ServiceBusAdministrationClient von oder ServiceBusAdministrationAsyncClientbereitgestellt buildAsyncClient() wird. Das Festlegen dieser Einstellung schließt sich mit gegenseitig retryOptions(RetryOptions retryOptions)aus.

Parameters:

retryPolicy - Die Wiederholungsrichtlinie des Benutzers, die auf jede Anforderung angewendet wird.

Returns:

Das aktualisierte ServiceBusAdministrationClientBuilder Objekt.

serviceVersion

public ServiceBusAdministrationClientBuilder serviceVersion(ServiceBusServiceVersion serviceVersion)

Legt den fest, der ServiceBusServiceVersion verwendet wird. Standardmäßig getLatest() wird verwendet, wenn keine angegeben ist.

Parameters:

serviceVersion - Zu verwendende Dienstversion.

Returns:

Das aktualisierte ServiceBusAdministrationClientBuilder Objekt.

Gilt für: