QueueClientBuilder (Azure SDK for Java Reference Documentation)

java.lang.Object
- com.azure.storage.queue.QueueClientBuilder

```
public final class QueueClientBuilder
extends Object
```
This class provides a fluent builder API to help aid the configuration and instantiation of the QueueClients and QueueAsyncClients, calling buildClient constructs an instance of QueueClient and calling buildAsyncClient constructs an instance of QueueAsyncClient.
The client needs the endpoint of the Azure Storage Queue service, name of the queue, and authorization credentials. endpoint gives the builder the endpoint and may give the builder the queueName and a SAS token that authorizes the client.

Instantiating a synchronous Queue Client with SAS token
```
 QueueClient client = new QueueClientBuilder()
     .endpoint("https://${accountName}.queue.core.windows.net?${SASToken}")
     .buildClient();
 
```
Instantiating an Asynchronous Queue Client with SAS token
```
 QueueAsyncClient queueAsyncClient = new QueueClientBuilder()
     .endpoint("https://{accountName}.queue.core.windows.net?{SASToken}")
     .buildAsyncClient();
 
```
If the endpoint doesn't contain the queue name or SAS token they may be set using queueName and SAS token.

Instantiating a synchronous Queue Client with credential
```
 QueueClient client = new QueueClientBuilder()
     .endpoint("https://${accountName}.queue.core.windows.net")
     .queueName("myqueue")
     .sasToken("{SASTokenQueryParams}")
     .buildClient();
 
```
Instantiating an Asynchronous Queue Client with credential
```
 QueueAsyncClient queueAsyncClient = new QueueClientBuilder()
     .endpoint("https://{accountName}.queue.core.windows.net")
     .queueName("myqueue")
     .sasToken("{SASTokenQueryParams}")
     .buildAsyncClient();
 
```
Another way to authenticate the client is using a StorageSharedKeyCredential. To create a StorageSharedKeyCredential a connection string from the Storage Queue service must be used. Set the StorageSharedKeyCredential with connectionString. If the builder has both a SAS token and StorageSharedKeyCredential the StorageSharedKeyCredential will be preferred when authorizing requests sent to the service.

Instantiating a synchronous Queue Client with connection string.
```
 String connectionString = "DefaultEndpointsProtocol=https;AccountName={name};"
     + "AccountKey={key};EndpointSuffix={core.windows.net}";
 QueueClient client = new QueueClientBuilder()
     .connectionString(connectionString)
     .buildClient();
 
```
Instantiating an Asynchronous Queue Client with connection string.
```
 String connectionString = "DefaultEndpointsProtocol=https;AccountName={name};"
     + "AccountKey={key};EndpointSuffix={core.windows.net}";
 QueueAsyncClient queueAsyncClient = new QueueClientBuilder()
     .connectionString(connectionString)
     .buildAsyncClient();
 
```
See Also:

QueueClient, QueueAsyncClient, StorageSharedKeyCredential

Constructor Summary

Constructors
Constructor and Description

QueueClientBuilder()
Creates a builder instance that is able to configure and construct QueueClients and QueueAsyncClients.

Constructors
Constructor and Description
`QueueClientBuilder()` Creates a builder instance that is able to configure and construct `QueueClients` and `QueueAsyncClients`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`QueueClientBuilder`	`addPolicy(com.azure.core.http.policy.HttpPipelinePolicy pipelinePolicy)` Adds a pipeline policy to apply on each request sent.
`QueueAsyncClient`	`buildAsyncClient()` Creates a `QueueAsyncClient` based on options set in the builder.
`QueueClient`	`buildClient()` Creates a `QueueClient` based on options set in the builder.
`QueueClientBuilder`	`clientOptions(com.azure.core.util.ClientOptions clientOptions)` Sets the client options for all the requests made through the client.
`QueueClientBuilder`	`configuration(com.azure.core.util.Configuration configuration)` Sets the configuration object used to retrieve environment configuration values during building of the client.
`QueueClientBuilder`	`connectionString(String connectionString)` Sets the connection string to connect to the service.
`QueueClientBuilder`	`credential(com.azure.core.credential.AzureSasCredential credential)` Sets the `AzureSasCredential` used to authorize requests sent to the service.
`QueueClientBuilder`	`credential(StorageSharedKeyCredential credential)` Sets the `StorageSharedKeyCredential` used to authorize requests sent to the service.
`QueueClientBuilder`	`credential(com.azure.core.credential.TokenCredential credential)` Sets the `TokenCredential` used to authorize requests sent to the service.
`QueueClientBuilder`	`endpoint(String endpoint)` Sets the endpoint for the Azure Storage Queue instance that the client will interact with.
`static com.azure.core.http.policy.HttpLogOptions`	`getDefaultHttpLogOptions()` Gets the default Storage allowlist log headers and query parameters.
`QueueClientBuilder`	`httpClient(com.azure.core.http.HttpClient httpClient)` Sets the `HttpClient` to use for sending a receiving requests to and from the service.
`QueueClientBuilder`	`httpLogOptions(com.azure.core.http.policy.HttpLogOptions logOptions)` Sets the `HttpLogOptions` for service requests.
`QueueClientBuilder`	`messageEncoding(QueueMessageEncoding messageEncoding)` Sets the queue message encoding.
`QueueClientBuilder`	`pipeline(com.azure.core.http.HttpPipeline httpPipeline)` Sets the `HttpPipeline` to use for the service client.
`QueueClientBuilder`	`processMessageDecodingError(Consumer<QueueMessageDecodingError> processMessageDecodingErrorHandler)` Sets the handler that performs the tasks needed when a message is received or peaked from the queue but cannot be decoded.
`QueueClientBuilder`	`processMessageDecodingErrorAsync(Function<QueueMessageDecodingError,Mono<Void>> processMessageDecodingErrorAsyncHandler)` Sets the asynchronous handler that performs the tasks needed when a message is received or peaked from the queue but cannot be decoded.
`QueueClientBuilder`	`queueName(String queueName)` Sets the name of the queue that the client will interact with.
`QueueClientBuilder`	`retryOptions(RequestRetryOptions retryOptions)` Sets the request retry options for all the requests made through the client.
`QueueClientBuilder`	`sasToken(String sasToken)` Sets the SAS token used to authorize requests sent to the service.
`QueueClientBuilder`	`serviceVersion(QueueServiceVersion version)` Sets the `QueueServiceVersion` that is used when making API requests.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - QueueClientBuilder
```
public QueueClientBuilder()
```
    Creates a builder instance that is able to configure and construct QueueClients and QueueAsyncClients.
- Method Detail
  - buildClient
```
public QueueClient buildClient()
```
    Creates a QueueClient based on options set in the builder. Every time buildClient() is called a new instance of QueueClient is created.
    If pipeline is set, then the pipeline, endpoint, and queueName are used to create the client. All other builder settings are ignored.
    
    Returns:
    
    A QueueClient with the options set from the builder.
    
    Throws:
    
    NullPointerException - If endpoint or queueName have not been set.
    
    IllegalStateException - If neither a StorageSharedKeyCredential or SAS token has been set.
    
    IllegalStateException - If multiple credentials have been specified.
  - buildAsyncClient
```
public QueueAsyncClient buildAsyncClient()
```
    Creates a QueueAsyncClient based on options set in the builder. Every time buildAsyncClient() is called a new instance of QueueAsyncClient is created.
    If pipeline is set, then the pipeline, endpoint, and queueName are used to create the client. All other builder settings are ignored.
    
    Returns:
    
    A QueueAsyncClient with the options set from the builder.
    
    Throws:
    
    NullPointerException - If endpoint or queueName have not been set.
    
    IllegalArgumentException - If neither a StorageSharedKeyCredential or SAS token has been set.
    
    IllegalStateException - If multiple credentials have been specified.
  - endpoint
```
public QueueClientBuilder endpoint(String endpoint)
```
    Sets the endpoint for the Azure Storage Queue instance that the client will interact with.
    The first path segment, if the endpoint contains path segments, will be assumed to be the name of the queue that the client will interact with.
    
    Query parameters of the endpoint will be parsed in an attempt to generate a SAS token to authenticate requests sent to the service.
    
    Parameters:
    
    endpoint - The URL of the Azure Storage Queue instance to send service requests to and receive responses from.
    
    Returns:
    
    the updated QueueClientBuilder object
    
    Throws:
    
    IllegalArgumentException - If endpoint isn't a proper URL
  - queueName
```
public QueueClientBuilder queueName(String queueName)
```
    Sets the name of the queue that the client will interact with.
    
    Parameters:
    
    queueName - Name of the queue
    
    Returns:
    
    the updated QueueClientBuilder object
    
    Throws:
    
    NullPointerException - If queueName is null.
  - credential
```
public QueueClientBuilder credential(StorageSharedKeyCredential credential)
```
    Sets the StorageSharedKeyCredential used to authorize requests sent to the service.
    
    Parameters:
    
    credential - StorageSharedKeyCredential.
    
    Returns:
    
    the updated QueueClientBuilder
    
    Throws:
    
    NullPointerException - If credential is null.
  - credential
```
public QueueClientBuilder credential(com.azure.core.credential.TokenCredential credential)
```
    Sets the TokenCredential used to authorize requests sent to the service.
    
    Parameters:
    
    credential - TokenCredential.
    
    Returns:
    
    the updated QueueClientBuilder
    
    Throws:
    
    NullPointerException - If credential is null.
  - sasToken
```
public QueueClientBuilder sasToken(String sasToken)
```
    Sets the SAS token used to authorize requests sent to the service.
    
    Parameters:
    
    sasToken - The SAS token to use for authenticating requests. This string should only be the query parameters (with or without a leading '?') and not a full url.
    
    Returns:
    
    the updated QueueClientBuilder
    
    Throws:
    
    NullPointerException - If sasToken is null.
  - credential
```
public QueueClientBuilder credential(com.azure.core.credential.AzureSasCredential credential)
```
    Sets the AzureSasCredential used to authorize requests sent to the service.
    
    Parameters:
    
    credential - AzureSasCredential used to authorize requests sent to the service.
    
    Returns:
    
    the updated QueueClientBuilder
    
    Throws:
    
    NullPointerException - If credential is null.
  - connectionString
```
public QueueClientBuilder connectionString(String connectionString)
```
    Sets the connection string to connect to the service.
    
    Parameters:
    
    connectionString - Connection string of the storage account.
    
    Returns:
    
    the updated QueueClientBuilder
    
    Throws:
    
    IllegalArgumentException - If connectionString is invalid.
  - httpClient
```
public QueueClientBuilder httpClient(com.azure.core.http.HttpClient httpClient)
```
    Sets the HttpClient to use for sending a receiving requests to and from the service.
    
    Parameters:
    
    httpClient - HttpClient to use for requests.
    
    Returns:
    
    the updated QueueClientBuilder object
  - addPolicy
```
public QueueClientBuilder addPolicy(com.azure.core.http.policy.HttpPipelinePolicy pipelinePolicy)
```
    Adds a pipeline policy to apply on each request sent. The policy will be added after the retry policy. If the method is called multiple times, all policies will be added and their order preserved.
    
    Parameters:
    
    pipelinePolicy - a pipeline policy
    
    Returns:
    
    the updated QueueClientBuilder object
    
    Throws:
    
    NullPointerException - If pipelinePolicy is null.
  - httpLogOptions
```
public QueueClientBuilder httpLogOptions(com.azure.core.http.policy.HttpLogOptions logOptions)
```
    Sets the HttpLogOptions for service requests.
    
    Parameters:
    
    logOptions - The logging configuration to use when sending and receiving HTTP requests/responses.
    
    Returns:
    
    the updated QueueClientBuilder object
    
    Throws:
    
    NullPointerException - If logOptions is null.
  - getDefaultHttpLogOptions
```
public static com.azure.core.http.policy.HttpLogOptions getDefaultHttpLogOptions()
```
    Gets the default Storage allowlist log headers and query parameters.
    
    Returns:
    
    the default http log options.
  - configuration
```
public QueueClientBuilder configuration(com.azure.core.util.Configuration configuration)
```
    Sets the configuration object used to retrieve environment configuration values during building of the client.
    
    Parameters:
    
    configuration - Configuration store used to retrieve environment configurations.
    
    Returns:
    
    the updated QueueClientBuilder object
  - retryOptions
```
public QueueClientBuilder retryOptions(RequestRetryOptions retryOptions)
```
    Sets the request retry options for all the requests made through the client.
    
    Parameters:
    
    retryOptions - RequestRetryOptions.
    
    Returns:
    
    the updated QueueClientBuilder object
    
    Throws:
    
    NullPointerException - If retryOptions is null.
  - pipeline
```
public QueueClientBuilder pipeline(com.azure.core.http.HttpPipeline httpPipeline)
```
    Sets the HttpPipeline to use for the service client. If pipeline is set, all other settings are ignored, aside from endpoint.
    
    Parameters:
    
    httpPipeline - HttpPipeline to use for sending service requests and receiving responses.
    
    Returns:
    
    the updated QueueClientBuilder object
  - clientOptions
```
public QueueClientBuilder clientOptions(com.azure.core.util.ClientOptions clientOptions)
```
    Sets the client options for all the requests made through the client.
    
    Parameters:
    
    clientOptions - ClientOptions.
    
    Returns:
    
    the updated QueueClientBuilder object
    
    Throws:
    
    NullPointerException - If clientOptions is null.
  - messageEncoding
```
public QueueClientBuilder messageEncoding(QueueMessageEncoding messageEncoding)
```
    Sets the queue message encoding.
    
    Parameters:
    
    messageEncoding - QueueMessageEncoding.
    
    Returns:
    
    the updated QueueClientBuilder object
    
    Throws:
    
    NullPointerException - If messageEncoding is null.
  - processMessageDecodingErrorAsync
```
public QueueClientBuilder processMessageDecodingErrorAsync(Function<QueueMessageDecodingError,Mono<Void>> processMessageDecodingErrorAsyncHandler)
```
    Sets the asynchronous handler that performs the tasks needed when a message is received or peaked from the queue but cannot be decoded.
    Such message can be received or peaked when queue is expecting certain QueueMessageEncoding but there's another producer that is not encoding messages in expected way. I.e. the queue contains messages with different encoding.
    QueueMessageDecodingError contains QueueAsyncClient for the queue that has received the message as well as QueueMessageDecodingError.getQueueMessageItem() or QueueMessageDecodingError.getPeekedMessageItem() with raw body, i.e. no decoding will be attempted so that body can be inspected as has been received from the queue.
    The handler won't attempt to remove the message from the queue. Therefore such handling should be included into handler itself.
    Code Samples
```
 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();
         }
     };
 
 QueueClient client = new QueueClientBuilder()
     .connectionString(connectionString)
     .processMessageDecodingErrorAsync(processMessageDecodingErrorHandler)
     .buildClient();
 
```
    Parameters:
    
    processMessageDecodingErrorAsyncHandler - the handler.
    
    Returns:
    
    the updated QueueClientBuilder object
  - processMessageDecodingError
```
public QueueClientBuilder processMessageDecodingError(Consumer<QueueMessageDecodingError> processMessageDecodingErrorHandler)
```
    Sets the handler that performs the tasks needed when a message is received or peaked from the queue but cannot be decoded.
    Such message can be received or peaked when queue is expecting certain QueueMessageEncoding but there's another producer that is not encoding messages in expected way. I.e. the queue contains messages with different encoding.
    QueueMessageDecodingError contains QueueAsyncClient for the queue that has received the message as well as QueueMessageDecodingError.getQueueMessageItem() or QueueMessageDecodingError.getPeekedMessageItem() with raw body, i.e. no decoding will be attempted so that body can be inspected as has been received from the queue.
    The handler won't attempt to remove the message from the queue. Therefore such handling should be included into handler itself.
    Code Samples
```
 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());
         }
     };
 
 QueueClient client = new QueueClientBuilder()
     .connectionString(connectionString)
     .processMessageDecodingError(processMessageDecodingErrorHandler)
     .buildClient();
 
```
    Parameters:
    
    processMessageDecodingErrorHandler - the handler.
    
    Returns:
    
    the updated QueueClientBuilder object
  - serviceVersion
```
public QueueClientBuilder serviceVersion(QueueServiceVersion version)
```
    Sets the QueueServiceVersion that is used when making API requests.
    If a service version is not provided, the service version that will be used will be the latest known service version based on the version of the client library being used. If no service version is specified, updating to a newer version of the client library will have the result of potentially moving to a newer service version.
    Targeting a specific service version may also mean that the service will return an error for newer APIs.
    
    Parameters:
    
    version - QueueServiceVersion of the service to be used when making requests.
    
    Returns:
    
    the updated QueueClientBuilder object

Visit the Azure for Java Developers site for more Java documentation, including quick starts, tutorials, and code samples.

Class QueueClientBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

QueueClientBuilder

Method Detail

buildClient

buildAsyncClient

endpoint

queueName

credential

credential

sasToken

credential

connectionString

httpClient

addPolicy

httpLogOptions

getDefaultHttpLogOptions

configuration

retryOptions

pipeline

clientOptions

messageEncoding

processMessageDecodingErrorAsync

processMessageDecodingError

serviceVersion