Package com.azure.storage.blob

Class BlobServiceClientBuilder

java.lang.Object

com.azure.storage.blob.BlobServiceClientBuilder

All Implemented Interfaces:

AzureNamedKeyCredentialTrait<BlobServiceClientBuilder>, AzureSasCredentialTrait<BlobServiceClientBuilder>, ConfigurationTrait<BlobServiceClientBuilder>, ConnectionStringTrait<BlobServiceClientBuilder>, EndpointTrait<BlobServiceClientBuilder>, HttpTrait<BlobServiceClientBuilder>, TokenCredentialTrait<BlobServiceClientBuilder>

public final class BlobServiceClientBuilder
extends Object
implements TokenCredentialTrait<BlobServiceClientBuilder>, ConnectionStringTrait<BlobServiceClientBuilder>, AzureNamedKeyCredentialTrait<BlobServiceClientBuilder>, AzureSasCredentialTrait<BlobServiceClientBuilder>, HttpTrait<BlobServiceClientBuilder>, ConfigurationTrait<BlobServiceClientBuilder>, EndpointTrait<BlobServiceClientBuilder>

This class provides a fluent builder API to help aid the configuration and instantiation of BlobServiceClients and BlobServiceAsyncClients, call buildClient and buildAsyncClient respectively to construct an instance of the desired client.

The following information must be provided on this builder:

• the endpoint through .endpoint(), in the format of https://{accountName}.blob.core.windows.net.
• the credential through .credential() or .connectionString() if the container is not publicly accessible.

Constructor Summary

Constructors

Constructor	Description
BlobServiceClientBuilder()	Creates a builder instance that is able to configure and construct BlobServiceClients and BlobServiceAsyncClients.

Method Summary

Modifier and Type	Method	Description
BlobServiceClientBuilder	addPolicy(HttpPipelinePolicy pipelinePolicy)	Adds a pipeline policy to apply on each request sent.
BlobServiceClientBuilder	blobContainerEncryptionScope(BlobContainerEncryptionScope blobContainerEncryptionScope)	Sets the encryption scope that is used to determine how blob contents are encrypted on the server.
BlobServiceAsyncClient	buildAsyncClient()
BlobServiceClient	buildClient()
BlobServiceClientBuilder	clientOptions(ClientOptions clientOptions)	Allows for setting common properties such as application ID, headers, proxy configuration, etc.
BlobServiceClientBuilder	configuration(Configuration configuration)	Sets the configuration object used to retrieve environment configuration values during building of the client.
BlobServiceClientBuilder	connectionString(String connectionString)	Sets the connection string to connect to the service.
BlobServiceClientBuilder	credential(AzureNamedKeyCredential credential)	Sets the AzureNamedKeyCredential used to authorize requests sent to the service.
BlobServiceClientBuilder	credential(AzureSasCredential credential)	Sets the AzureSasCredential used to authorize requests sent to the service.
BlobServiceClientBuilder	credential(TokenCredential credential)	Sets the TokenCredential used to authorize requests sent to the service.
BlobServiceClientBuilder	credential(StorageSharedKeyCredential credential)	Sets the StorageSharedKeyCredential used to authorize requests sent to the service.
BlobServiceClientBuilder	customerProvidedKey(CustomerProvidedKey customerProvidedKey)	Sets the customer provided key that is used to encrypt blob contents on the server.
BlobServiceClientBuilder	encryptionScope(String encryptionScope)	Sets the encryption scope that is used to encrypt blob contents on the server.
BlobServiceClientBuilder	endpoint(String endpoint)	Sets the blob service endpoint, additionally parses it for information (SAS token)
static HttpLogOptions	getDefaultHttpLogOptions()	Gets the default Storage allowlist log headers and query parameters.
BlobServiceClientBuilder	httpClient(HttpClient httpClient)	Sets the HttpClient to use for sending and receiving requests to and from the service.
BlobServiceClientBuilder	httpLogOptions(HttpLogOptions logOptions)	Sets the logging configuration to use when sending and receiving requests to and from the service.
BlobServiceClientBuilder	pipeline(HttpPipeline httpPipeline)	Sets the HttpPipeline to use for the service client.
BlobServiceClientBuilder	retryOptions(RetryOptions retryOptions)	Sets the RetryOptions for all the requests made through the client.
BlobServiceClientBuilder	retryOptions(RequestRetryOptions retryOptions)	Sets the request retry options for all the requests made through the client.
BlobServiceClientBuilder	sasToken(String sasToken)	Sets the SAS token used to authorize requests sent to the service.
BlobServiceClientBuilder	serviceVersion(BlobServiceVersion version)	Sets the BlobServiceVersion 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 Details

BlobServiceClientBuilder

public BlobServiceClientBuilder()

Creates a builder instance that is able to configure and construct BlobServiceClients and BlobServiceAsyncClients.

Method Details

buildClient

public BlobServiceClient buildClient()

Returns:

a BlobServiceClient created from the configurations in this builder.

Throws:

IllegalArgumentException - If no credentials are provided.

IllegalStateException - If multiple credentials have been specified.

IllegalStateException - If both retryOptions(RetryOptions) and retryOptions(RequestRetryOptions) have been set.

buildAsyncClient

public BlobServiceAsyncClient buildAsyncClient()

Returns:

a BlobServiceAsyncClient created from the configurations in this builder.

Throws:

IllegalArgumentException - If no credentials are provided.

IllegalStateException - If multiple credentials have been specified.

IllegalStateException - If both retryOptions(RetryOptions) and retryOptions(RequestRetryOptions) have been set.

endpoint

public BlobServiceClientBuilder endpoint(String endpoint)

Sets the blob service endpoint, additionally parses it for information (SAS token)

Specified by:

endpoint in interface EndpointTrait<BlobServiceClientBuilder>

Parameters:

endpoint - URL of the service

Returns:

the updated BlobServiceClientBuilder object

Throws:

IllegalArgumentException - If endpoint is null or is a malformed URL.

customerProvidedKey

public BlobServiceClientBuilder customerProvidedKey(CustomerProvidedKey customerProvidedKey)

Sets the customer provided key that is used to encrypt blob contents on the server.

Parameters:

customerProvidedKey - Customer provided key containing the encryption key information.

Returns:

the updated BlobServiceClientBuilder object

encryptionScope

public BlobServiceClientBuilder encryptionScope(String encryptionScope)

Sets the encryption scope that is used to encrypt blob contents on the server.

Parameters:

encryptionScope - Encryption scope containing the encryption key information.

Returns:

the updated BlobServiceClientBuilder object

blobContainerEncryptionScope

public BlobServiceClientBuilder blobContainerEncryptionScope(BlobContainerEncryptionScope blobContainerEncryptionScope)

Sets the encryption scope that is used to determine how blob contents are encrypted on the server.

Parameters:

blobContainerEncryptionScope - Encryption scope containing the encryption key information.

Returns:

the updated BlobServiceClientBuilder object

credential

public BlobServiceClientBuilder credential(StorageSharedKeyCredential credential)

Sets the StorageSharedKeyCredential used to authorize requests sent to the service.

Parameters:

credential - StorageSharedKeyCredential.

Returns:

the updated BlobServiceClientBuilder

Throws:

NullPointerException - If credential is null.

credential

public BlobServiceClientBuilder credential(AzureNamedKeyCredential credential)

Sets the AzureNamedKeyCredential used to authorize requests sent to the service.

Specified by:

credential in interface AzureNamedKeyCredentialTrait<BlobServiceClientBuilder>

Parameters:

credential - AzureNamedKeyCredential.

Returns:

the updated BlobServiceClientBuilder

Throws:

NullPointerException - If credential is null.

credential

public BlobServiceClientBuilder credential(TokenCredential credential)

Sets the TokenCredential 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 the TokenCredential type.

Specified by:

credential in interface TokenCredentialTrait<BlobServiceClientBuilder>

Parameters:

credential - TokenCredential used to authorize requests sent to the service.

Returns:

the updated BlobServiceClientBuilder

Throws:

NullPointerException - If credential is null.

sasToken

public BlobServiceClientBuilder 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 BlobServiceClientBuilder

Throws:

NullPointerException - If sasToken is null.

credential

public BlobServiceClientBuilder credential(AzureSasCredential credential)

Sets the AzureSasCredential used to authorize requests sent to the service.

Specified by:

credential in interface AzureSasCredentialTrait<BlobServiceClientBuilder>

Parameters:

credential - AzureSasCredential used to authorize requests sent to the service.

Returns:

the updated BlobServiceClientBuilder

Throws:

NullPointerException - If credential is null.

connectionString

public BlobServiceClientBuilder connectionString(String connectionString)

Sets the connection string to connect to the service.

Specified by:

connectionString in interface ConnectionStringTrait<BlobServiceClientBuilder>

Parameters:

connectionString - Connection string of the storage account.

Returns:

the updated BlobServiceClientBuilder

Throws:

IllegalArgumentException - If connectionString in invalid.

NullPointerException - If connectionString is null.

httpClient

public BlobServiceClientBuilder httpClient(HttpClient httpClient)

Sets the HttpClient 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 no HttpPipeline 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 an HttpPipeline 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 interface HttpTrait<BlobServiceClientBuilder>

Parameters:

httpClient - The HttpClient to use for requests.

Returns:

the updated BlobServiceClientBuilder object

addPolicy

public BlobServiceClientBuilder addPolicy(HttpPipelinePolicy pipelinePolicy)

Adds a pipeline 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 no HttpPipeline 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 an HttpPipeline 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 interface HttpTrait<BlobServiceClientBuilder>

Parameters:

pipelinePolicy - A pipeline policy.

Returns:

the updated BlobServiceClientBuilder object

Throws:

NullPointerException - If pipelinePolicy is null.

httpLogOptions

public BlobServiceClientBuilder httpLogOptions(HttpLogOptions logOptions)

Sets the logging configuration to use when sending and receiving requests to and from the service. If a logLevel is not provided, default value of HttpLogDetailLevel.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 no HttpPipeline 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 an HttpPipeline 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 interface HttpTrait<BlobServiceClientBuilder>

Parameters:

logOptions - The logging configuration to use when sending and receiving requests to and from the service.

Returns:

the updated BlobServiceClientBuilder object

Throws:

NullPointerException - If logOptions is null.

getDefaultHttpLogOptions

public static HttpLogOptions getDefaultHttpLogOptions()

Gets the default Storage allowlist log headers and query parameters.

Returns:

the default http log options.

configuration

public BlobServiceClientBuilder configuration(Configuration configuration)

Sets the configuration object used to retrieve environment configuration values during building of the client.

Specified by:

configuration in interface ConfigurationTrait<BlobServiceClientBuilder>

Parameters:

configuration - Configuration store used to retrieve environment configurations.

Returns:

the updated BlobServiceClientBuilder object

retryOptions

public BlobServiceClientBuilder retryOptions(RequestRetryOptions retryOptions)

Sets the request retry options for all the requests made through the client. Setting this is mutually exclusive with using retryOptions(RetryOptions).

Parameters:

retryOptions - RequestRetryOptions.

Returns:

the updated BlobServiceClientBuilder object

retryOptions

public BlobServiceClientBuilder retryOptions(RetryOptions retryOptions)

Sets the RetryOptions 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 no HttpPipeline 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 an HttpPipeline 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 using retryOptions(RequestRetryOptions) to also set storage specific options.

Specified by:

retryOptions in interface HttpTrait<BlobServiceClientBuilder>

Parameters:

retryOptions - The RetryOptions to use for all the requests made through the client.

Returns:

the updated BlobServiceClientBuilder object

clientOptions

public BlobServiceClientBuilder clientOptions(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 the HttpClientOptions class (a subclass of the ClientOptions 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 no HttpPipeline 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 an HttpPipeline 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 interface HttpTrait<BlobServiceClientBuilder>

Parameters:

clientOptions - A configured instance of HttpClientOptions.

Returns:

the updated BlobServiceClientBuilder object

Throws:

NullPointerException - If clientOptions is null.

See Also:

• HttpClientOptions

pipeline

public BlobServiceClientBuilder pipeline(HttpPipeline httpPipeline)

Sets the HttpPipeline 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 no HttpPipeline 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 an HttpPipeline 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 when pipeline is set.

Specified by:

pipeline in interface HttpTrait<BlobServiceClientBuilder>

Parameters:

httpPipeline - HttpPipeline to use for sending service requests and receiving responses.

Returns:

the updated BlobServiceClientBuilder object

serviceVersion

public BlobServiceClientBuilder serviceVersion(BlobServiceVersion version)

Sets the BlobServiceVersion 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 - BlobServiceVersion of the service to be used when making requests.

Returns:

the updated BlobServiceClientBuilder object