com.azure.storage.blob

Class BlobContainerClientBuilder

java.lang.Object

com.azure.storage.blob.BlobContainerClientBuilder

public final class BlobContainerClientBuilder
extends Object

This class provides a fluent builder API to help aid the configuration and instantiation of BlobContainerClients and BlobContainerAsyncClients, 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

Constructors

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

Method Summary

Modifier and Type	Method and Description
BlobContainerClientBuilder	addPolicy(HttpPipelinePolicy pipelinePolicy) Adds a pipeline policy to apply on each request sent.
BlobContainerAsyncClient	buildAsyncClient() Code Samples
BlobContainerClient	buildClient() Code Samples
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(StorageSharedKeyCredential credential) Sets the StorageSharedKeyCredential used to authorize requests sent to the service.
BlobContainerClientBuilder	credential(TokenCredential credential) Sets the TokenCredential used to authorize requests sent to the service.
BlobContainerClientBuilder	customerProvidedKey(CustomerProvidedKey customerProvidedKey) Sets the customer provided key 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 whitelist log headers and query parameters.
BlobContainerClientBuilder	httpClient(HttpClient httpClient) Sets the HttpClient to use for sending a receiving requests to and from the service.
BlobContainerClientBuilder	httpLogOptions(HttpLogOptions logOptions) Sets the HttpLogOptions for service requests.
BlobContainerClientBuilder	pipeline(HttpPipeline httpPipeline) Sets the HttpPipeline to use for the service 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 class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BlobContainerClientBuilder

public BlobContainerClientBuilder()

Creates a builder instance that is able to configure and construct ContainerClients and ContainerAsyncClients.

Method Detail

buildClient

public BlobContainerClient buildClient()

Code Samples

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

Returns:

a BlobContainerClient created from the configurations in this builder.

buildAsyncClient

public BlobContainerAsyncClient buildAsyncClient()

Code Samples

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

Returns:

a BlobContainerAsyncClient created from the configurations in this builder.

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

Throws:

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

customerProvidedKey

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

credential

public BlobContainerClientBuilder credential(StorageSharedKeyCredential credential)

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

Parameters:

credential - The credential to use for authenticating request.

Returns:

the updated BlobContainerClientBuilder

Throws:

NullPointerException - If credential is null.

credential

public BlobContainerClientBuilder credential(TokenCredential credential)

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

Parameters:

credential - The credential to use for authenticating request.

Returns:

the updated BlobContainerClientBuilder

Throws:

NullPointerException - If credential is null.

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.

Returns:

the updated BlobContainerClientBuilder

Throws:

NullPointerException - If sasToken is null.

setAnonymousAccess

public BlobContainerClientBuilder setAnonymousAccess()

Clears the credential used to authorize the request.

This is for containers that are publicly accessible.

Returns:

the updated BlobContainerClientBuilder

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

Throws:

IllegalArgumentException - If connectionString in invalid.

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

httpClient

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

addPolicy

public BlobContainerClientBuilder addPolicy(HttpPipelinePolicy pipelinePolicy)

Adds a pipeline policy to apply on each request sent.

Parameters:

pipelinePolicy - a pipeline policy

Returns:

the updated BlobContainerClientBuilder object

Throws:

NullPointerException - If pipelinePolicy is null.

httpLogOptions

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

Throws:

NullPointerException - If logOptions is null.

getDefaultHttpLogOptions

public static HttpLogOptions getDefaultHttpLogOptions()

Gets the default Storage whitelist log headers and query parameters.

Returns:

the default http log options.

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

retryOptions

public BlobContainerClientBuilder retryOptions(RequestRetryOptions retryOptions)

Sets the request retry options for all the requests made through the client.

Parameters:

retryOptions - The options used to configure retry behavior.

Returns:

the updated BlobContainerClientBuilder object

Throws:

NullPointerException - If retryOptions is null.

pipeline

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

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 the client library will have the result of potentially moving to a newer service version.

Parameters:

version - BlobServiceVersion of the service to be used when making requests.

Returns:

the updated BlobContainerClientBuilder object