com.azure.storage.blob

Class BlobClientBuilder

java.lang.Object

com.azure.storage.common.BaseClientBuilder<T>

com.azure.storage.blob.BaseBlobClientBuilder<BlobClientBuilder>

com.azure.storage.blob.BlobClientBuilder

public final class BlobClientBuilder
extends BaseBlobClientBuilder<BlobClientBuilder>

This class provides a fluent builder API to help aid the configuration and instantiation of BlobClients and BlobAsyncClients when buildClient and buildAsyncClient as called respectively.

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.

Field Summary

Fields inherited from class com.azure.storage.blob.BaseBlobClientBuilder

customerProvidedKey

Fields inherited from class com.azure.storage.common.BaseClientBuilder

accountName, endpoint

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
BlobClientBuilder	blobName(String blobName) Sets the name of the blob this client is connecting to.
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	containerName(String containerName) Sets the name of the container this client is connecting to.
BlobClientBuilder	endpoint(String endpoint) Sets the service endpoint, additionally parses it for information (SAS token, container name, blob name)
protected Class<BlobClientBuilder>	getClazz()
BlobClientBuilder	snapshot(String snapshot) Sets the snapshot of the blob this client is connecting to.

Methods inherited from class com.azure.storage.blob.BaseBlobClientBuilder

applyServiceSpecificValidations, customerProvidedKey, getServiceUrlMidfix, getUserAgentPolicy

Methods inherited from class com.azure.storage.common.BaseClientBuilder

addOptionalEncryptionPolicy, addPolicy, buildPipeline, configuration, connectionString, credential, credential, getConfiguration, getPipeline, hasCredential, httpClient, httpLogOptions, pipeline, retryOptions, sasToken, setAnonymousCredential

Methods inherited from class java.lang.Object

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

Constructor Detail

BlobClientBuilder

public BlobClientBuilder()

Creates a builder instance that is able to configure and construct BlobClients and BlobAsyncClients.

Method Detail

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.

Throws:

NullPointerException - If endpoint, containerName, or blobName is null.

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 BlobAsyncClientBase.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.

Throws:

NullPointerException - If endpoint, containerName, or blobName is null.

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 method.

Code Samples

BlobClient client = new BlobClientBuilder()
    .endpoint(endpoint)
    .credential(sharedKeyCredential)
    .buildClient();

Specified by:

endpoint in class BaseClientBuilder<BlobClientBuilder>

Parameters:

endpoint - URL of the service

Returns:

the updated BlobClientBuilder object

Throws:

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

containerName

public BlobClientBuilder containerName(String containerName)

Sets the name of the container this client is connecting to.

Code Samples

BlobClient client = new BlobClientBuilder()
    .endpoint(endpoint)
    .containerName(containerName)
    .buildClient();

Parameters:

containerName - the name of the container. If the value is set to null or empty, it will be interpreted as the root container, and "$root" will be inserted as the container name.

Returns:

the updated BlobClientBuilder object

Throws:

NullPointerException - If containerName is null

blobName

public BlobClientBuilder blobName(String blobName)

Sets the name of the blob this client is connecting to.

Parameters:

blobName - the name of the blob

Returns:

the updated BlobClientBuilder object

Throws:

NullPointerException - If blobName is null

snapshot

public BlobClientBuilder snapshot(String snapshot)

Sets the snapshot of the blob this client is connecting to.

Parameters:

snapshot - the snapshot identifier for the blob

Returns:

the updated BlobClientBuilder object

getClazz

protected Class<BlobClientBuilder> getClazz()

Specified by:

getClazz in class BaseClientBuilder<BlobClientBuilder>