Class QueueClientBuilder
- java.lang.Object
-
- com.azure.storage.queue.QueueClientBuilder
-
- All Implemented Interfaces:
com.azure.core.client.traits.AzureNamedKeyCredentialTrait<QueueClientBuilder>
,com.azure.core.client.traits.AzureSasCredentialTrait<QueueClientBuilder>
,com.azure.core.client.traits.ConfigurationTrait<QueueClientBuilder>
,com.azure.core.client.traits.ConnectionStringTrait<QueueClientBuilder>
,com.azure.core.client.traits.EndpointTrait<QueueClientBuilder>
,com.azure.core.client.traits.HttpTrait<QueueClientBuilder>
,com.azure.core.client.traits.TokenCredentialTrait<QueueClientBuilder>
public final class QueueClientBuilder extends Object implements com.azure.core.client.traits.TokenCredentialTrait<QueueClientBuilder>, com.azure.core.client.traits.ConnectionStringTrait<QueueClientBuilder>, com.azure.core.client.traits.AzureNamedKeyCredentialTrait<QueueClientBuilder>, com.azure.core.client.traits.AzureSasCredentialTrait<QueueClientBuilder>, com.azure.core.client.traits.HttpTrait<QueueClientBuilder>, com.azure.core.client.traits.ConfigurationTrait<QueueClientBuilder>, com.azure.core.client.traits.EndpointTrait<QueueClientBuilder>
This class provides a fluent builder API to help aid the configuration and instantiation of theQueueClients
andQueueAsyncClients
, callingbuildClient
constructs an instance of QueueClient and callingbuildAsyncClient
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 thequeueName
and aSAS 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 orSAS token
they may be set usingqueueName
andSAS 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 withconnectionString
. 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 Description QueueClientBuilder()
Creates a builder instance that is able to configure and constructQueueClients
andQueueAsyncClients
.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description QueueClientBuilder
addPolicy(com.azure.core.http.policy.HttpPipelinePolicy pipelinePolicy)
Adds apipeline policy
to apply on each request sent.QueueAsyncClient
buildAsyncClient()
Creates aQueueAsyncClient
based on options set in the builder.QueueClient
buildClient()
Creates aQueueClient
based on options set in the builder.QueueClientBuilder
clientOptions(com.azure.core.util.ClientOptions clientOptions)
Allows for setting common properties such as application ID, headers, proxy configuration, etc.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.AzureNamedKeyCredential credential)
Sets theAzureNamedKeyCredential
used to authorize requests sent to the service.QueueClientBuilder
credential(com.azure.core.credential.AzureSasCredential credential)
Sets theAzureSasCredential
used to authorize requests sent to the service.QueueClientBuilder
credential(com.azure.core.credential.TokenCredential credential)
Sets theTokenCredential
used to authorize requests sent to the service.QueueClientBuilder
credential(StorageSharedKeyCredential credential)
Sets theStorageSharedKeyCredential
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 theHttpClient
to use for sending and receiving requests to and from the service.QueueClientBuilder
httpLogOptions(com.azure.core.http.policy.HttpLogOptions logOptions)
Sets thelogging configuration
to use when sending and receiving requests to and from the service.QueueClientBuilder
messageEncoding(QueueMessageEncoding messageEncoding)
Sets the queue message encoding.QueueClientBuilder
pipeline(com.azure.core.http.HttpPipeline httpPipeline)
Sets theHttpPipeline
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(com.azure.core.http.policy.RetryOptions retryOptions)
Sets theRetryOptions
for all the requests made through the client.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 theQueueServiceVersion
that is used when making API requests.
-
-
-
Constructor Detail
-
QueueClientBuilder
public QueueClientBuilder()
Creates a builder instance that is able to configure and constructQueueClients
andQueueAsyncClients
.
-
-
Method Detail
-
buildClient
public QueueClient buildClient()
Creates aQueueClient
based on options set in the builder. Every timebuildClient()
is called a new instance ofQueueClient
is created.If
pipeline
is set, then thepipeline
,endpoint
, andqueueName
are used to create theclient
. All other builder settings are ignored.- Returns:
- A QueueClient with the options set from the builder.
- Throws:
NullPointerException
- Ifendpoint
orqueueName
have not been set.IllegalStateException
- If neither aStorageSharedKeyCredential
orSAS token
has been set.IllegalStateException
- If multiple credentials have been specified.IllegalStateException
- If bothretryOptions(RetryOptions)
andretryOptions(RequestRetryOptions)
have been set.
-
buildAsyncClient
public QueueAsyncClient buildAsyncClient()
Creates aQueueAsyncClient
based on options set in the builder. Every timebuildAsyncClient()
is called a new instance ofQueueAsyncClient
is created.If
pipeline
is set, then thepipeline
,endpoint
, andqueueName
are used to create theclient
. All other builder settings are ignored.- Returns:
- A QueueAsyncClient with the options set from the builder.
- Throws:
NullPointerException
- Ifendpoint
orqueueName
have not been set.IllegalArgumentException
- If neither aStorageSharedKeyCredential
orSAS token
has been set.IllegalStateException
- If multiple credentials have been specified.IllegalStateException
- If bothretryOptions(RetryOptions)
andretryOptions(RequestRetryOptions)
have been set.
-
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.- Specified by:
endpoint
in interfacecom.azure.core.client.traits.EndpointTrait<QueueClientBuilder>
- 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
- Ifendpoint
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
- IfqueueName
isnull
.
-
credential
public QueueClientBuilder credential(StorageSharedKeyCredential credential)
Sets theStorageSharedKeyCredential
used to authorize requests sent to the service.- Parameters:
credential
-StorageSharedKeyCredential
.- Returns:
- the updated QueueClientBuilder
- Throws:
NullPointerException
- Ifcredential
isnull
.
-
credential
public QueueClientBuilder credential(com.azure.core.credential.AzureNamedKeyCredential credential)
Sets theAzureNamedKeyCredential
used to authorize requests sent to the service.- Specified by:
credential
in interfacecom.azure.core.client.traits.AzureNamedKeyCredentialTrait<QueueClientBuilder>
- Parameters:
credential
-AzureNamedKeyCredential
.- Returns:
- the updated QueueClientBuilder
- Throws:
NullPointerException
- Ifcredential
isnull
.
-
credential
public QueueClientBuilder credential(com.azure.core.credential.TokenCredential credential)
Sets theTokenCredential
used to authorize requests sent to the service. Refer to the Azure SDK for Java identity and authentication documentation for more details on proper usage of theTokenCredential
type.- Specified by:
credential
in interfacecom.azure.core.client.traits.TokenCredentialTrait<QueueClientBuilder>
- Parameters:
credential
-TokenCredential
used to authorize requests sent to the service.- Returns:
- the updated QueueClientBuilder
- Throws:
NullPointerException
- Ifcredential
isnull
.
-
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
- IfsasToken
isnull
.
-
credential
public QueueClientBuilder credential(com.azure.core.credential.AzureSasCredential credential)
Sets theAzureSasCredential
used to authorize requests sent to the service.- Specified by:
credential
in interfacecom.azure.core.client.traits.AzureSasCredentialTrait<QueueClientBuilder>
- Parameters:
credential
-AzureSasCredential
used to authorize requests sent to the service.- Returns:
- the updated QueueClientBuilder
- Throws:
NullPointerException
- Ifcredential
isnull
.
-
connectionString
public QueueClientBuilder connectionString(String connectionString)
Sets the connection string to connect to the service.- Specified by:
connectionString
in interfacecom.azure.core.client.traits.ConnectionStringTrait<QueueClientBuilder>
- Parameters:
connectionString
- Connection string of the storage account.- Returns:
- the updated QueueClientBuilder
- Throws:
IllegalArgumentException
- IfconnectionString
is invalid.
-
httpClient
public QueueClientBuilder httpClient(com.azure.core.http.HttpClient httpClient)
Sets theHttpClient
to use for sending and receiving requests to and from the service.Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a
HttpPipeline
is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If noHttpPipeline
is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if anHttpPipeline
is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.- Specified by:
httpClient
in interfacecom.azure.core.client.traits.HttpTrait<QueueClientBuilder>
- Parameters:
httpClient
- TheHttpClient
to use for requests.- Returns:
- the updated QueueClientBuilder object
-
addPolicy
public QueueClientBuilder addPolicy(com.azure.core.http.policy.HttpPipelinePolicy pipelinePolicy)
Adds apipeline policy
to apply on each request sent.Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a
HttpPipeline
is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If noHttpPipeline
is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if anHttpPipeline
is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.- Specified by:
addPolicy
in interfacecom.azure.core.client.traits.HttpTrait<QueueClientBuilder>
- Parameters:
pipelinePolicy
- Apipeline policy
.- Returns:
- the updated QueueClientBuilder object
- Throws:
NullPointerException
- IfpipelinePolicy
isnull
.
-
httpLogOptions
public QueueClientBuilder httpLogOptions(com.azure.core.http.policy.HttpLogOptions logOptions)
Sets thelogging configuration
to use when sending and receiving requests to and from the service. If alogLevel
is not provided, default value ofHttpLogDetailLevel.NONE
is set.Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a
HttpPipeline
is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If noHttpPipeline
is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if anHttpPipeline
is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.- Specified by:
httpLogOptions
in interfacecom.azure.core.client.traits.HttpTrait<QueueClientBuilder>
- Parameters:
logOptions
- Thelogging configuration
to use when sending and receiving requests to and from the service.- Returns:
- the updated QueueClientBuilder object
- Throws:
NullPointerException
- IflogOptions
isnull
.
-
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.- Specified by:
configuration
in interfacecom.azure.core.client.traits.ConfigurationTrait<QueueClientBuilder>
- 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. Setting this is mutually exclusive with usingretryOptions(RetryOptions)
.- Parameters:
retryOptions
-RequestRetryOptions
.- Returns:
- the updated QueueClientBuilder object.
-
retryOptions
public QueueClientBuilder retryOptions(com.azure.core.http.policy.RetryOptions retryOptions)
Sets theRetryOptions
for all the requests made through the client.Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a
HttpPipeline
is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If noHttpPipeline
is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if anHttpPipeline
is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.Setting this is mutually exclusive with using
retryOptions(RequestRetryOptions)
. Consider usingretryOptions(RequestRetryOptions)
to also set storage specific options.- Specified by:
retryOptions
in interfacecom.azure.core.client.traits.HttpTrait<QueueClientBuilder>
- Parameters:
retryOptions
- TheRetryOptions
to use for all the requests made through the client.- Returns:
- the updated QueueClientBuilder object
-
pipeline
public QueueClientBuilder pipeline(com.azure.core.http.HttpPipeline httpPipeline)
Sets theHttpPipeline
to use for the service client.Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a
HttpPipeline
is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If noHttpPipeline
is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if anHttpPipeline
is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.The
endpoint
is not ignored whenpipeline
is set.- Specified by:
pipeline
in interfacecom.azure.core.client.traits.HttpTrait<QueueClientBuilder>
- 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)
Allows for setting common properties such as application ID, headers, proxy configuration, etc. Note that it is recommended that this method be called with an instance of theHttpClientOptions
class (a subclass of theClientOptions
base class). The HttpClientOptions subclass provides more configuration options suitable for HTTP clients, which is applicable for any class that implements this HttpTrait interface.Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a
HttpPipeline
is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If noHttpPipeline
is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if anHttpPipeline
is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.- Specified by:
clientOptions
in interfacecom.azure.core.client.traits.HttpTrait<QueueClientBuilder>
- Parameters:
clientOptions
- A configured instance ofHttpClientOptions
.- Returns:
- the updated QueueClientBuilder object
- Throws:
NullPointerException
- IfclientOptions
isnull
.- See Also:
HttpClientOptions
-
messageEncoding
public QueueClientBuilder messageEncoding(QueueMessageEncoding messageEncoding)
Sets the queue message encoding.- Parameters:
messageEncoding
-QueueMessageEncoding
.- Returns:
- the updated QueueClientBuilder object
- Throws:
NullPointerException
- IfmessageEncoding
isnull
.
-
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
containsQueueAsyncClient
for the queue that has received the message as well asQueueMessageDecodingError.getQueueMessageItem()
orQueueMessageDecodingError.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
containsQueueAsyncClient
for the queue that has received the message as well asQueueMessageDecodingError.getQueueMessageItem()
orQueueMessageDecodingError.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 theQueueServiceVersion
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
-
-