ServiceBusAdministrationClientBuilder クラス

  • リファレンス
パッケージ:
com.azure.messaging.servicebus.administration
Maven 成果物:
com.azure:azure-messaging-servicebus:7.17.0
  • java.lang.Object
    • com.azure.messaging.servicebus.administration.ServiceBusAdministrationClientBuilder

実装

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>

このクラスは、 と の構成とインスタンス化 ServiceBusAdministrationClient を支援する fluent Builder API を提供します ServiceBusAdministrationAsyncClient。 buildAsyncClient()と をそれぞれ呼び出buildClient()して、目的のクライアントのインスタンスを構築します。

Azure Service Busに対して操作を実行するには、資格情報が必要です。 これらは、次のいずれかの方法を使用して設定できます。

次のサンプルで使用される資格情報は、認証用です DefaultAzureCredential 。 ローカルの開発環境や運用環境など、ほとんどのシナリオに適しています。 さらに、運用環境での認証には マネージド ID を 使用することをお勧めします。 さまざまな認証方法と、それに対応する資格情報の種類の詳細については、 Azure Id のドキュメントを参照してください。

サンプル: 同期クライアントを作成する

次のコード サンプルは、同期管理クライアントの作成を示しています。

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

サンプル: Azure Identity を使用して非同期クライアントを作成する

次のコード サンプルは、非同期管理クライアントの作成を示しています。

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

サンプル: 非同期クライアントを作成する

次のコード サンプルは、再試行オプションと HTTP ログ オプションが構成された非同期管理クライアントの作成を示しています。

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

コンストラクターの概要

コンストラクター 説明
ServiceBusAdministrationClientBuilder()

既定のパラメーターを使用してビルダーを構築します。

メソッドの概要

修飾子と型 メソッドと説明
ServiceBusAdministrationClientBuilder addPolicy(HttpPipelinePolicy policy)

HttpPipelinePolicy送信された各要求に適用する を追加します。
ServiceBusAdministrationAsyncClient buildAsyncClient()

ビルダーで設定された ServiceBusAdministrationAsyncClient オプションに基づいて を作成します。
ServiceBusAdministrationClient buildClient()

ビルダーで設定された ServiceBusAdministrationClient オプションに基づいて を作成します。
ServiceBusAdministrationClientBuilder clientOptions(ClientOptions clientOptions)

アプリケーション ID、ヘッダー、プロキシ構成などの共通プロパティを設定できます。
ServiceBusAdministrationClientBuilder configuration(Configuration configuration)

サービス クライアントの構築中に使用される構成ストアを設定します。
ServiceBusAdministrationClientBuilder connectionString(String connectionString)

Service Bus 名前空間または特定の Service Bus リソースの接続文字列を設定します。
ServiceBusAdministrationClientBuilder credential(AzureSasCredential credential)

Service Bus リソースの Shared Access Signature を使用して資格情報を設定します。
ServiceBusAdministrationClientBuilder credential(TokenCredential credential)

サービスに TokenCredential 送信される要求を承認するために使用する を設定します。
ServiceBusAdministrationClientBuilder credential(String fullyQualifiedNamespace, TokenCredential credential)

Service Bus 名前空間に対する HTTP 要求の認証に使用する資格情報を設定します。
ServiceBusAdministrationClientBuilder endpoint(String endpoint)

Service Bus 名前空間のサービス エンドポイントを設定します。
ServiceBusAdministrationClientBuilder httpClient(HttpClient client)

サービスとの間で HttpClient 要求を送受信するために使用する を設定します。
ServiceBusAdministrationClientBuilder httpLogOptions(HttpLogOptions logOptions)

サービスとの間で HttpLogOptions 要求を送受信するときに使用する を設定します。
ServiceBusAdministrationClientBuilder pipeline(HttpPipeline pipeline)

HttpPipelineサービス クライアントに使用する を設定します。
ServiceBusAdministrationClientBuilder retryOptions(RetryOptions retryOptions)

クライアントを RetryOptions 介して行われたすべての要求の を設定します。
ServiceBusAdministrationClientBuilder retryPolicy(HttpPipelinePolicy retryPolicy)

各要求が HttpPipelinePolicy 送信されるときに使用される を設定します。
ServiceBusAdministrationClientBuilder serviceVersion(ServiceBusServiceVersion serviceVersion)

使用する を ServiceBusServiceVersion 設定します。

メソッドの継承元: java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

コンストラクターの詳細

ServiceBusAdministrationClientBuilder

public ServiceBusAdministrationClientBuilder()

既定のパラメーターを使用してビルダーを構築します。

メソッドの詳細

addPolicy

public ServiceBusAdministrationClientBuilder addPolicy(HttpPipelinePolicy policy)

HttpPipelinePolicy送信された各要求に適用する を追加します。

メモ： HttpTrait API の優先順位を理解することが重要です。 特に、 が指定されている場合 HttpPipeline 、これは特性内の他のすべての API よりも優先され、無視されます。 が指定されていない HttpPipeline 場合、HTTP パイプラインは、この特性に指定された設定に基づいて内部的に構築されます。 また、 が指定されている場合も無視される、この特性を実装する型には他の API が存在する可能性 HttpPipeline があるため、この特性を実装する型のドキュメントを必ず参照して、影響の完全なセットを理解してください。

Parameters:

policy - HttpPipelinePolicy。

Returns:

更新後の ServiceBusAdministrationClientBuilder オブジェクト。

buildAsyncClient

public ServiceBusAdministrationAsyncClient buildAsyncClient()

ビルダーで設定された ServiceBusAdministrationAsyncClient オプションに基づいて を作成します。 buildAsyncClientが呼び出されるたびに、クライアントの新しいインスタンスが作成されます。

が設定されている場合pipeline(HttpPipeline pipeline)は、 と endpoint(String endpoint)pipeline を使用して を作成しますServiceBusAdministrationAsyncClient。 その他のビルダー設定はすべて無視されます。

Returns:

ServiceBusAdministrationAsyncClientビルダーで設定されたオプションを含む 。

buildClient

public ServiceBusAdministrationClient buildClient()

ビルダーで設定された ServiceBusAdministrationClient オプションに基づいて を作成します。 buildClientが呼び出されるたびに、クライアントの新しいインスタンスが作成されます。

が設定されている場合pipeline(HttpPipeline pipeline)は、 と endpoint(String endpoint)pipeline を使用して を作成しますServiceBusAdministrationClient。 その他のビルダー設定はすべて無視されます。

Returns:

ServiceBusAdministrationClientビルダーで設定されたオプションを含む 。

clientOptions

public ServiceBusAdministrationClientBuilder clientOptions(ClientOptions clientOptions)

アプリケーション ID、ヘッダー、プロキシ構成などの共通プロパティを設定できます。このメソッドは、 クラスのインスタンス (基底クラスの HttpClientOptions サブクラス ClientOptions ) で呼び出することをお勧めします。 HttpClientOptions サブクラスは、HTTP クライアントに適した構成オプションをさらに提供します。これは、この HttpTrait インターフェイスを実装するすべてのクラスに適用できます。

メモ： HttpTrait API の優先順位を理解することが重要です。 特に、 が指定されている場合 HttpPipeline 、これは特性内の他のすべての API よりも優先され、無視されます。 が指定されていない HttpPipeline 場合、HTTP パイプラインは、この特性に指定された設定に基づいて内部的に構築されます。 また、 が指定されている場合も無視される、この特性を実装する型には他の API が存在する可能性 HttpPipeline があるため、この特性を実装する型のドキュメントを必ず参照して、影響の完全なセットを理解してください。

Parameters:

clientOptions - の構成済みインスタンス HttpClientOptions。

Returns:

更新後の ServiceBusAdministrationClientBuilder オブジェクト。

configuration

public ServiceBusAdministrationClientBuilder configuration(Configuration configuration)

サービス クライアントの構築中に使用される構成ストアを設定します。 既定の構成ストアは の複製であり、 global configuration storeを使用 NONE して、構築時に構成設定を使用してバイパスします。

Parameters:

configuration - に使用される構成ストア

Returns:

更新後の ServiceBusAdministrationClientBuilder オブジェクト。

connectionString

public ServiceBusAdministrationClientBuilder connectionString(String connectionString)

Service Bus 名前空間または特定の Service Bus リソースの接続文字列を設定します。

Parameters:

connectionString - Service Bus 名前空間または特定の Service Bus リソースの接続文字列。

Returns:

更新後の ServiceBusAdministrationClientBuilder オブジェクト。

credential

public ServiceBusAdministrationClientBuilder credential(AzureSasCredential credential)

Service Bus リソースの Shared Access Signature を使用して資格情報を設定します。 「Shared Access Signature を使用した Service Bus アクセス制御」を参照してください。

Parameters:

credential - AzureSasCredential 認証に使用する。

Returns:

更新後の ServiceBusAdministrationClientBuilder オブジェクト。

credential

public ServiceBusAdministrationClientBuilder credential(TokenCredential credential)

サービスに TokenCredential 送信される要求を承認するために使用する を設定します。 型の適切な使用方法の詳細については、Azure SDK for Java の ID と認証 に関するドキュメントを TokenCredential 参照してください。

Parameters:

credential - TokenCredential サービスに送信された要求を承認するために使用されます。

Returns:

更新後の ServiceBusAdministrationClientBuilder オブジェクト。

credential

public ServiceBusAdministrationClientBuilder credential(String fullyQualifiedNamespace, TokenCredential credential)

Service Bus 名前空間に対する HTTP 要求の認証に使用する資格情報を設定します。

Parameters:

fullyQualifiedNamespace - Service Bus の場合は 。
credential - TokenCredential 認証に使用する。

Returns:

更新後の ServiceBusAdministrationClientBuilder オブジェクト。

endpoint

public ServiceBusAdministrationClientBuilder endpoint(String endpoint)

Service Bus 名前空間のサービス エンドポイントを設定します。

Parameters:

endpoint - Service Bus 名前空間の URL。

Returns:

更新後の ServiceBusAdministrationClientBuilder オブジェクト。

httpClient

public ServiceBusAdministrationClientBuilder httpClient(HttpClient client)

サービスとの間で HttpClient 要求を送受信するために使用する を設定します。

メモ： HttpTrait API の優先順位を理解することが重要です。 特に、 が指定されている場合 HttpPipeline 、これは特性内の他のすべての API よりも優先され、無視されます。 が指定されていない HttpPipeline 場合、HTTP パイプラインは、この特性に指定された設定に基づいて内部的に構築されます。 また、 が指定されている場合 HttpPipeline にも無視されるこの特性を実装する型には他の API が存在する可能性があるため、この特性を実装する型のドキュメントを参照して、影響の完全なセットを理解してください。

Parameters:

client - HttpClient要求に使用する 。

Returns:

更新後の ServiceBusAdministrationClientBuilder オブジェクト。

httpLogOptions

public ServiceBusAdministrationClientBuilder httpLogOptions(HttpLogOptions logOptions)

サービスとの間で HttpLogOptions 要求を送受信するときに使用する を設定します。 logLevelが指定されていない場合、 のHttpLogDetailLevel#NONE既定値が設定されます。

メモ： HttpTrait API の優先順位を理解することが重要です。 特に、 が指定されている場合 HttpPipeline 、これは特性内の他のすべての API よりも優先され、無視されます。 が指定されていない HttpPipeline 場合、HTTP パイプラインは、この特性に指定された設定に基づいて内部的に構築されます。 また、 が指定されている場合 HttpPipeline にも無視されるこの特性を実装する型には他の API が存在する可能性があるため、この特性を実装する型のドキュメントを参照して、影響の完全なセットを理解してください。

Parameters:

logOptions - HttpLogOptionsサービスとの間で要求を送受信するときに使用する 。

Returns:

更新後の ServiceBusAdministrationClientBuilder オブジェクト。

pipeline

public ServiceBusAdministrationClientBuilder pipeline(HttpPipeline pipeline)

HttpPipelineサービス クライアントに使用する を設定します。

メモ： HttpTrait API の優先順位を理解することが重要です。 特に、 が指定されている場合 HttpPipeline 、これは特性内の他のすべての API よりも優先され、無視されます。 が指定されていない HttpPipeline 場合、HTTP パイプラインは、この特性に指定された設定に基づいて内部的に構築されます。 また、 が指定されている場合 HttpPipeline にも無視されるこの特性を実装する型には他の API が存在する可能性があるため、この特性を実装する型のドキュメントを参照して、影響の完全なセットを理解してください。

endpoint(String endpoint)が設定されている場合pipeline、 は無視されません。

Parameters:

pipeline - HttpPipeline を使用して、サービス要求の送信と応答の受信に使用します。

Returns:

更新後の ServiceBusAdministrationClientBuilder オブジェクト。

retryOptions

public ServiceBusAdministrationClientBuilder retryOptions(RetryOptions retryOptions)

クライアントを RetryOptions 介して行われたすべての要求の を設定します。

メモ： HttpTrait API の優先順位を理解することが重要です。 特に、 が指定されている場合 HttpPipeline 、これは特性内の他のすべての API よりも優先され、無視されます。 が指定されていない HttpPipeline 場合、HTTP パイプラインは、この特性に指定された設定に基づいて内部的に構築されます。 また、 が指定されている場合 HttpPipeline にも無視されるこの特性を実装する型には他の API が存在する可能性があるため、この特性を実装する型のドキュメントを参照して、影響の完全なセットを理解してください。

この設定は、 を使用する場合 retryPolicy(HttpPipelinePolicy retryPolicy)と相互に排他的です。

Parameters:

retryOptions - RetryOptionsクライアントを介して行われたすべての要求に使用する 。

Returns:

更新後の ServiceBusAdministrationClientBuilder オブジェクト。

retryPolicy

public ServiceBusAdministrationClientBuilder retryPolicy(HttpPipelinePolicy retryPolicy)

各要求が HttpPipelinePolicy 送信されるときに使用される を設定します。 ビルドServiceBusAdministrationClientまたは ServiceBusAdministrationAsyncClientに指定buildAsyncClient()されていない場合は、既定の再試行ポリシーが使用されます。 この設定は、 を使用する場合 retryOptions(RetryOptions retryOptions)と相互に排他的です。

Parameters:

retryPolicy - 各要求に適用されたユーザーの再試行ポリシー。

Returns:

更新後の ServiceBusAdministrationClientBuilder オブジェクト。

serviceVersion

public ServiceBusAdministrationClientBuilder serviceVersion(ServiceBusServiceVersion serviceVersion)

使用する を ServiceBusServiceVersion 設定します。 既定 getLatest() では、何も指定されていない場合に使用されます。

Parameters:

serviceVersion - 使用するサービス バージョン。

Returns:

更新後の ServiceBusAdministrationClientBuilder オブジェクト。

適用対象