BlobClientBuilder Class

Package:

com.azure.storage.blob

Maven Artifact:

com.azure:azure-storage-blob:12.28.1

• java.lang.Object
• • com.azure.storage.blob.BlobClientBuilder

Implements

AzureNamedKeyCredentialTrait<BlobClientBuilder> AzureSasCredentialTrait<BlobClientBuilder> ConfigurationTrait<BlobClientBuilder> ConnectionStringTrait<BlobClientBuilder> EndpointTrait<BlobClientBuilder> HttpTrait<BlobClientBuilder> TokenCredentialTrait<BlobClientBuilder>

public final class BlobClientBuilder
implements TokenCredentialTrait<BlobClientBuilder>, ConnectionStringTrait<BlobClientBuilder>, AzureNamedKeyCredentialTrait<BlobClientBuilder>, AzureSasCredentialTrait<BlobClientBuilder>, HttpTrait<BlobClientBuilder>, ConfigurationTrait<BlobClientBuilder>, EndpointTrait<BlobClientBuilder>

This class provides a fluent builder API to help aid the configuration and instantiation of BlobClient and BlobAsyncClient, 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(), including the container name and blob name, in the format of https://{accountName}.blob.core.windows.net/{containerName}/{blobName}.
• the credential through .credential() or .connectionString() if the container is not publicly accessible.

Constructor Summary

Constructor	Description
BlobClientBuilder()	Creates a builder instance that is able to configure and construct BlobClient and BlobAsyncClient.

Method Summary

Modifier and Type	Method and Description
BlobClientBuilder	addPolicy(HttpPipelinePolicy pipelinePolicy) Adds a HttpPipelinePolicy to apply on each request sent.
BlobClientBuilder	audience(BlobAudience audience) Sets the Audience to use for authentication with Azure Active Directory (AAD).
BlobClientBuilder	blobName(String blobName) Sets the name of the blob.
BlobAsyncClient	buildAsyncClient() Creates a BlobAsyncClient based on options set in the builder.
BlobClient	buildClient() Creates a BlobClient based on options set in the builder.
BlobClientBuilder	clientOptions(ClientOptions clientOptions) Allows for setting common properties such as application ID, headers, proxy configuration, etc.
BlobClientBuilder	configuration(Configuration configuration) Sets the configuration object used to retrieve environment configuration values during building of the client.
BlobClientBuilder	connectionString(String connectionString) Sets the connection string to connect to the service.
BlobClientBuilder	containerName(String containerName) Sets the name of the container that contains the blob.
BlobClientBuilder	credential(AzureNamedKeyCredential credential) Sets the AzureNamedKeyCredential used to authorize requests sent to the service.
BlobClientBuilder	credential(AzureSasCredential credential) Sets the AzureSasCredential used to authorize requests sent to the service.
BlobClientBuilder	credential(TokenCredential credential) Sets the TokenCredential used to authorize requests sent to the service.
BlobClientBuilder	credential(StorageSharedKeyCredential credential) Sets the StorageSharedKeyCredential used to authorize requests sent to the service.
BlobClientBuilder	customerProvidedKey(CustomerProvidedKey customerProvidedKey) Sets the CustomerProvidedKey that is used to encrypt blob contents on the server.
BlobClientBuilder	encryptionScope(String encryptionScope) Sets the encryption scope that is used to encrypt blob contents on the server.
BlobClientBuilder	endpoint(String endpoint) Sets the service endpoint, additionally parses it for information (SAS token, container name, blob name)
static HttpLogOptions	getDefaultHttpLogOptions() Gets the default Storage allowlist log headers and query parameters.
BlobClientBuilder	httpClient(HttpClient httpClient) Sets the HttpClient to use for sending and receiving requests to and from the service.
BlobClientBuilder	httpLogOptions(HttpLogOptions logOptions) Sets the HttpLogOptions to use when sending and receiving requests to and from the service.
BlobClientBuilder	pipeline(HttpPipeline httpPipeline) Sets the HttpPipeline to use for the service client.
BlobClientBuilder	retryOptions(RetryOptions retryOptions) Sets the RetryOptions for all the requests made through the client.
BlobClientBuilder	retryOptions(RequestRetryOptions retryOptions) Sets the request retry options for all the requests made through the client.
BlobClientBuilder	sasToken(String sasToken) Sets the SAS token used to authorize requests sent to the service.
BlobClientBuilder	serviceVersion(BlobServiceVersion version) Sets the BlobServiceVersion that is used when making API requests.
BlobClientBuilder	setAnonymousAccess() Clears the credential used to authorize the request.
BlobClientBuilder	snapshot(String snapshot) Sets the snapshot identifier of the blob.
BlobClientBuilder	versionId(String versionId) Sets the version identifier of the blob.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

BlobClientBuilder

public BlobClientBuilder()

Creates a builder instance that is able to configure and construct BlobClient and BlobAsyncClient.

Method Details

addPolicy

public BlobClientBuilder addPolicy(HttpPipelinePolicy pipelinePolicy)

Adds a HttpPipelinePolicy 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.

Parameters:

pipelinePolicy - A HttpPipelinePolicy.

Returns:

the updated BlobClientBuilder object

audience

public BlobClientBuilder audience(BlobAudience audience)

Sets the Audience to use for authentication with Azure Active Directory (AAD). The audience is not considered when using a shared key.

Parameters:

audience - BlobAudience to be used when requesting a token from Azure Active Directory (AAD).

Returns:

the updated BlobClientBuilder object

blobName

public BlobClientBuilder blobName(String blobName)

Sets the name of the blob.

Parameters:

blobName - Name of the blob.

Returns:

the updated BlobClientBuilder object

buildAsyncClient

public BlobAsyncClient buildAsyncClient()

Creates a BlobAsyncClient based on options set in the builder. BlobAsyncClients are used to perform generic blob methods such as download and BlobAsyncClient#getProperties(), use this when the blob type is unknown.

Code Samples

BlobAsyncClient client = new BlobClientBuilder()
     .connectionString(connectionString)
     .buildAsyncClient();

Returns:

a BlobAsyncClient created from the configurations in this builder.

buildClient

public BlobClient buildClient()

Creates a BlobClient based on options set in the builder. BlobClients are used to perform generic blob methods such as download and get properties, use this when the blob type is unknown.

Code Samples

BlobClient client = new BlobClientBuilder()
     .connectionString(connectionString)
     .buildClient();

Returns:

a BlobClient created from the configurations in this builder.

clientOptions

public BlobClientBuilder 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.

Parameters:

clientOptions - A configured instance of HttpClientOptions.

Returns:

the updated BlobClientBuilder object

configuration

public BlobClientBuilder configuration(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 BlobClientBuilder object

connectionString

public BlobClientBuilder connectionString(String connectionString)

Sets the connection string to connect to the service.

Parameters:

connectionString - Connection string of the storage account.

Returns:

the updated BlobClientBuilder

containerName

public BlobClientBuilder containerName(String containerName)

Sets the name of the container that contains the blob.

Parameters:

containerName - Name of the container. If the value null or empty the root container, $root , will be used.

Returns:

the updated BlobClientBuilder object

credential

public BlobClientBuilder credential(AzureNamedKeyCredential credential)

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

Parameters:

credential - AzureNamedKeyCredential.

Returns:

the updated BlobClientBuilder

credential

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

credential

public BlobClientBuilder 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.

Parameters:

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

Returns:

the updated BlobClientBuilder

credential

public BlobClientBuilder credential(StorageSharedKeyCredential credential)

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

Parameters:

credential - StorageSharedKeyCredential.

Returns:

the updated BlobClientBuilder

customerProvidedKey

public BlobClientBuilder customerProvidedKey(CustomerProvidedKey customerProvidedKey)

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

Parameters:

customerProvidedKey - CustomerProvidedKey

Returns:

the updated BlobClientBuilder object

encryptionScope

public BlobClientBuilder 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 BlobClientBuilder object

endpoint

public BlobClientBuilder endpoint(String endpoint)

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

If the endpoint is to a blob in the root container, this method will fail as it will interpret the blob name as the container name. With only one path element, it is impossible to distinguish between a container name and a blob in the root container, so it is assumed to be the container name as this is much more common. When working with blobs in the root container, it is best to set the endpoint to the account url and specify the blob name separately using the blobName(String blobName) method.

Parameters:

endpoint - URL of the service

Returns:

the updated BlobClientBuilder object

getDefaultHttpLogOptions

public static HttpLogOptions getDefaultHttpLogOptions()

Gets the default Storage allowlist log headers and query parameters.

Returns:

the default http log options.

httpClient

public BlobClientBuilder 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.

Parameters:

httpClient - The HttpClient to use for requests.

Returns:

the updated BlobClientBuilder object

httpLogOptions

public BlobClientBuilder httpLogOptions(HttpLogOptions logOptions)

Sets the HttpLogOptions 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.

Parameters:

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

Returns:

the updated BlobClientBuilder object

pipeline

public BlobClientBuilder 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(String endpoint) is not ignored when pipeline is set.

Parameters:

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

Returns:

the updated BlobClientBuilder object

retryOptions

public BlobClientBuilder 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 retryOptions). Consider using retryOptions(RequestRetryOptions retryOptions) to also set storage specific options.

Parameters:

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

Returns:

the updated BlobClientBuilder object

retryOptions

public BlobClientBuilder 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 retryOptions).

Parameters:

retryOptions - RequestRetryOptions.

Returns:

the updated BlobClientBuilder object

sasToken

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

serviceVersion

public BlobClientBuilder 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 BlobClientBuilder object

setAnonymousAccess

public BlobClientBuilder setAnonymousAccess()

Clears the credential used to authorize the request.

This is for blobs that are publicly accessible.

Returns:

the updated BlobClientBuilder

snapshot

public BlobClientBuilder snapshot(String snapshot)

Sets the snapshot identifier of the blob.

Parameters:

snapshot - Snapshot identifier for the blob.

Returns:

the updated BlobClientBuilder object

versionId

public BlobClientBuilder versionId(String versionId)

Sets the version identifier of the blob.

Parameters:

versionId - Version identifier for the blob, pass null to interact with the latest blob version.

Returns:

the updated BlobClientBuilder object