QueueServiceClientBuilder クラス

public QueueServiceClientBuilder()

と QueueServiceAsyncClientを構成および構築QueueServiceClientできるビルダー インスタンスを作成します。

public QueueServiceClientBuilder addPolicy(HttpPipelinePolicy pipelinePolicy)

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

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

Parameters:

Returns:

public QueueServiceAsyncClient buildAsyncClient()

ビルダーで設定された QueueServiceAsyncClient オプションに基づいて を作成します。 これがの新しいインスタンス QueueServiceAsyncClient と呼ばれるたびにが作成されます。

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

Returns:

public QueueServiceClient buildClient()

ビルダーで設定された QueueServiceClient オプションに基づいて を作成します。 これがの新しいインスタンス QueueServiceClient と呼ばれるたびにが作成されます。

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

Returns:

public QueueServiceClientBuilder clientOptions(ClientOptions clientOptions)

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

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

Parameters:

Returns:

public QueueServiceClientBuilder configuration(Configuration configuration)

クライアントのビルド中に環境構成値を取得するために使用する構成オブジェクトを設定します。

Parameters:

Returns:

public QueueServiceClientBuilder connectionString(String connectionString)

サービスに接続する接続文字列を設定します。

Parameters:

Returns:

public QueueServiceClientBuilder credential(AzureNamedKeyCredential credential)

サービスに AzureNamedKeyCredential 送信された要求を承認するために使用される を設定します。

Parameters:

Returns:

public QueueServiceClientBuilder credential(AzureSasCredential credential)

サービスに AzureSasCredential 送信された要求を承認するために使用される を設定します。

Parameters:

Returns:

public QueueServiceClientBuilder credential(TokenCredential credential)

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

Parameters:

Returns:

public QueueServiceClientBuilder credential(StorageSharedKeyCredential credential)

サービスに StorageSharedKeyCredential 送信された要求を承認するために使用される を設定します。

Parameters:

Returns:

public QueueServiceClientBuilder endpoint(String endpoint)

クライアントが対話する Azure Storage Queue インスタンスのエンドポイントを設定します。

エンドポイントのクエリ パラメーターは、サービスに送信された要求を認証するための SAS トークンを生成しようとして解析されます。

Parameters:

Returns:

public static HttpLogOptions getDefaultHttpLogOptions()

既定のストレージ 許可リスト のログ ヘッダーとクエリ パラメーターを取得します。

Returns:

public QueueServiceClientBuilder httpClient(HttpClient httpClient)

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

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

Parameters:

Returns:

public QueueServiceClientBuilder httpLogOptions(HttpLogOptions logOptions)

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

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

Parameters:

Returns:

public QueueServiceClientBuilder messageEncoding(QueueMessageEncoding messageEncoding)

キュー メッセージのエンコードを設定します。

Parameters:

Returns:

public QueueServiceClientBuilder pipeline(HttpPipeline httpPipeline)

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

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

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

Parameters:

Returns:

public QueueServiceClientBuilder processMessageDecodingError(Consumer processMessageDecodingErrorHandler)

キューからメッセージを受信またはピークしたときに必要なタスクを実行するハンドラーを設定しますが、デコードできません。

キューが特定 QueueMessageEncoding のメッセージを予期しているが、メッセージを予期した方法でエンコードしていない別のプロデューサーがある場合は、このようなメッセージを受信またはピークにできます。 つまり、キューにはエンコードが異なるメッセージが含まれています。

QueueMessageDecodingErrorQueueClientには、メッセージgetQueueMessageItem()getPeekedMessageItem()を受信したキューおよび未加工の本文を含むキューが含まれます。つまり、キューから受信された本文を検査できるようにデコードは試行されません。

ハンドラーは、キューからメッセージを削除しようとしません。 したがって、このような処理はハンドラー自体に含める必要があります。

ハンドラーは、このビルダーから作成 QueueServiceClient または QueueServiceAsyncClient ビルドされたすべてのキュー クライアントによって共有されます。

このハンドラーは同期 QueueClientに使用することをお勧めします。

コード サンプル

String connectionString = "DefaultEndpointsProtocol=https;AccountName={name};"
     + "AccountKey={key};EndpointSuffix={core.windows.net}";

 Consumer<QueueMessageDecodingError> processMessageDecodingErrorHandler =
     (queueMessageDecodingFailure) -> {
         QueueMessageItem queueMessageItem = queueMessageDecodingFailure.getQueueMessageItem();
         PeekedMessageItem peekedMessageItem = queueMessageDecodingFailure.getPeekedMessageItem();
         if (queueMessageItem != null) {
             System.out.printf("Received badly encoded message, messageId=%s, messageBody=%s",
                 queueMessageItem.getMessageId(),
                 queueMessageItem.getBody().toString());
             queueMessageDecodingFailure
                 .getQueueClient()
                 .deleteMessage(queueMessageItem.getMessageId(), queueMessageItem.getPopReceipt());
         } else if (peekedMessageItem != null) {
             System.out.printf("Peeked badly encoded message, messageId=%s, messageBody=%s",
                 peekedMessageItem.getMessageId(),
                 peekedMessageItem.getBody().toString());
         }
     };

 QueueServiceClient client = new QueueServiceClientBuilder()
     .connectionString(connectionString)
     .processMessageDecodingError(processMessageDecodingErrorHandler)
     .buildClient();

Parameters:

Returns:

public QueueServiceClientBuilder processMessageDecodingErrorAsync(Function> processMessageDecodingErrorAsyncHandler)

メッセージの受信時またはキューからのピーク時に必要なタスクを実行する非同期ハンドラーを設定しますが、デコードできません。

キューが特定 QueueMessageEncoding のメッセージを予期しているが、メッセージを予期した方法でエンコードしていない別のプロデューサーがある場合は、このようなメッセージを受信またはピークにできます。 つまり、キューにはエンコードが異なるメッセージが含まれています。

QueueMessageDecodingErrorQueueAsyncClientには、メッセージgetQueueMessageItem()getPeekedMessageItem()を受信したキューおよび未加工の本文を含むキューが含まれます。つまり、キューから受信された本文を検査できるようにデコードは試行されません。

ハンドラーは、キューからメッセージを削除しようとしません。 したがって、このような処理はハンドラー自体に含める必要があります。

ハンドラーは、このビルダーから作成 QueueServiceClient または QueueServiceAsyncClient ビルドされたすべてのキュー クライアントによって共有されます。

このハンドラーは非同期 QueueAsyncClientに使用することをお勧めします。

コード サンプル

String connectionString = "DefaultEndpointsProtocol=https;AccountName={name};"
     + "AccountKey={key};EndpointSuffix={core.windows.net}";

 Function<QueueMessageDecodingError, Mono<Void>> processMessageDecodingErrorHandler =
     (queueMessageDecodingFailure) -> {
         QueueMessageItem queueMessageItem = queueMessageDecodingFailure.getQueueMessageItem();
         PeekedMessageItem peekedMessageItem = queueMessageDecodingFailure.getPeekedMessageItem();
         if (queueMessageItem != null) {
             System.out.printf("Received badly encoded message, messageId=%s, messageBody=%s",
                 queueMessageItem.getMessageId(),
                 queueMessageItem.getBody().toString());
             return queueMessageDecodingFailure
                 .getQueueAsyncClient()
                 .deleteMessage(queueMessageItem.getMessageId(), queueMessageItem.getPopReceipt());
         } else if (peekedMessageItem != null) {
             System.out.printf("Peeked badly encoded message, messageId=%s, messageBody=%s",
                 peekedMessageItem.getMessageId(),
                 peekedMessageItem.getBody().toString());
             return Mono.empty();
         } else {
             return Mono.empty();
         }
     };

 QueueServiceClient client = new QueueServiceClientBuilder()
     .connectionString(connectionString)
     .processMessageDecodingErrorAsync(processMessageDecodingErrorHandler)
     .buildClient();

Parameters:

Returns:

public QueueServiceClientBuilder retryOptions(RetryOptions retryOptions)

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

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

この設定は、 を使用する場合 retryOptions(RequestRetryOptions retryOptions)と相互に排他的です。 を使用して retryOptions(RequestRetryOptions retryOptions) 、ストレージ固有のオプションも設定することを検討してください。

Parameters:

Returns:

public QueueServiceClientBuilder retryOptions(RequestRetryOptions retryOptions)

クライアントを介して行われたすべての要求の要求再試行オプションを設定します。 この設定は、 を使用する場合 retryOptions(RetryOptions retryOptions)と相互に排他的です。

Parameters:

Returns:

public QueueServiceClientBuilder sasToken(String sasToken)

サービスに送信される要求を承認するために使用する SAS トークンを設定します。

Parameters:

Returns:

public QueueServiceClientBuilder serviceVersion(QueueServiceVersion version)

API 要求を QueueServiceVersion 行うときに使用する を設定します。

サービス バージョンが指定されていない場合、使用されるサービス バージョンは、使用されているクライアント ライブラリのバージョンに基づく最新の既知のサービス バージョンになります。 サービス バージョンが指定されていない場合、新しいバージョンのクライアント ライブラリに更新すると、新しいサービス バージョンに移行する可能性があります。

特定のサービス バージョンを対象とすると、サービスから新しい API のエラーが返される可能性もあります。

Parameters:

Returns: