BlobContainerClientBuilder Class

Package:

com.azure.storage.blob

Maven Artifact:

com.azure:azure-storage-blob:12.29.0

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

Implements

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

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

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

Constructor Summary

Constructor	Description
BlobContainerClientBuilder()	Creates a builder instance that is able to configure and construct BlobContainerClient and BlobContainerAsyncClient.

Method Summary

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

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

BlobContainerClientBuilder

public BlobContainerClientBuilder()

Creates a builder instance that is able to configure and construct BlobContainerClient and BlobContainerAsyncClient.

Method Details

addPolicy

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

audience

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

blobContainerEncryptionScope

public BlobContainerClientBuilder blobContainerEncryptionScope(BlobContainerEncryptionScope blobContainerEncryptionScope)

Sets the BlobContainerEncryptionScope 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 BlobContainerClientBuilder object

buildAsyncClient

public BlobContainerAsyncClient buildAsyncClient()

Creates a BlobContainerAsyncClient from the configured options.

Code Samples

BlobContainerAsyncClient client = new BlobContainerClientBuilder()
     .connectionString(connectionString)
     .buildAsyncClient();

Returns:

a BlobContainerAsyncClient created from the configurations in this builder.

buildClient

public BlobContainerClient buildClient()

Creates a BlobContainerClient from the configured options.

Code Samples

BlobContainerClient client = new BlobContainerClientBuilder()
     .connectionString(connectionString)
     .buildClient();

Returns:

a BlobContainerClient created from the configurations in this builder.

clientOptions

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

configuration

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

connectionString

public BlobContainerClientBuilder connectionString(String connectionString)

Sets the connection string to connect to the service.

Parameters:

connectionString - Connection string of the storage account.

Returns:

the updated BlobContainerClientBuilder

containerName

public BlobContainerClientBuilder containerName(String containerName)

Sets the name of the container.

Parameters:

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

Returns:

the updated BlobContainerClientBuilder object

credential

public BlobContainerClientBuilder credential(AzureNamedKeyCredential credential)

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

Parameters:

credential - AzureNamedKeyCredential.

Returns:

the updated BlobContainerClientBuilder

credential

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

credential

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

credential

public BlobContainerClientBuilder credential(StorageSharedKeyCredential credential)

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

Parameters:

credential - StorageSharedKeyCredential.

Returns:

the updated BlobContainerClientBuilder

customerProvidedKey

public BlobContainerClientBuilder customerProvidedKey(CustomerProvidedKey customerProvidedKey)

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

Parameters:

customerProvidedKey - Customer provided key containing the encryption key information.

Returns:

the updated BlobContainerClientBuilder object

encryptionScope

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

endpoint

public BlobContainerClientBuilder endpoint(String endpoint)

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

Parameters:

endpoint - URL of the service

Returns:

the updated BlobContainerClientBuilder object

getDefaultHttpLogOptions

public static HttpLogOptions getDefaultHttpLogOptions()

Gets the default Storage allowlist log headers and query parameters.

Returns:

the default http log options.

httpClient

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

httpLogOptions

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

pipeline

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

retryOptions

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

retryOptions

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

sasToken

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

serviceVersion

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

setAnonymousAccess

public BlobContainerClientBuilder setAnonymousAccess()

Clears the credential used to authorize the request.

This is for containers that are publicly accessible.

Returns:

the updated BlobContainerClientBuilder