BlobClientBuilder (Azure SDK for Java Reference Documentation)

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

```
public final class BlobClientBuilder
extends Object
```
This class provides a fluent builder API to help aid the configuration and instantiation of BlobClients and BlobAsyncClients, 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

Constructors
Constructor and Description

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

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BlobClientBuilder`	`addPolicy(HttpPipelinePolicy pipelinePolicy)` Adds a pipeline policy to apply on each request sent.
`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`	`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(StorageSharedKeyCredential credential)` Sets the `StorageSharedKeyCredential` used to authorize requests sent to the service.
`BlobClientBuilder`	`credential(TokenCredential credential)` Sets the `TokenCredential` used to authorize requests sent to the service.
`BlobClientBuilder`	`customerProvidedKey(CustomerProvidedKey customerProvidedKey)` Sets the `customer provided key` 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 whitelist log headers and query parameters.
`BlobClientBuilder`	`httpClient(HttpClient httpClient)` Sets the `HttpClient` to use for sending a receiving requests to and from the service.
`BlobClientBuilder`	`httpLogOptions(HttpLogOptions logOptions)` Sets the `HttpLogOptions` for service requests.
`BlobClientBuilder`	`pipeline(HttpPipeline httpPipeline)` Sets the `HttpPipeline` to use for the service 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.

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 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 or blobName is null.
  - customerProvidedKey
```
public BlobClientBuilder 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 BlobClientBuilder object
  - credential
```
public BlobClientBuilder 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 BlobClientBuilder
    
    Throws:
    
    NullPointerException - If credential is null.
  - credential
```
public BlobClientBuilder 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 BlobClientBuilder
    
    Throws:
    
    NullPointerException - If credential is null.
  - 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.
    
    Returns:
    
    the updated BlobClientBuilder
    
    Throws:
    
    NullPointerException - If sasToken is null.
  - setAnonymousAccess
```
public BlobClientBuilder setAnonymousAccess()
```
    Clears the credential used to authorize the request.
    This is for blobs that are publicly accessible.
    
    Returns:
    
    the updated BlobClientBuilder
  - 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
    
    Throws:
    
    IllegalArgumentException - If connectionString in invalid.
  - 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.
    
    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 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
  - blobName
```
public BlobClientBuilder blobName(String blobName)
```
    Sets the name of the blob.
    
    Parameters:
    
    blobName - Name of the blob.
    
    Returns:
    
    the updated BlobClientBuilder object
    
    Throws:
    
    NullPointerException - If blobName is null
  - 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
  - httpClient
```
public BlobClientBuilder 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 BlobClientBuilder object
  - addPolicy
```
public BlobClientBuilder addPolicy(HttpPipelinePolicy pipelinePolicy)
```
    Adds a pipeline policy to apply on each request sent.
    
    Parameters:
    
    pipelinePolicy - a pipeline policy
    
    Returns:
    
    the updated BlobClientBuilder object
    
    Throws:
    
    NullPointerException - If pipelinePolicy is null.
  - httpLogOptions
```
public BlobClientBuilder 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 BlobClientBuilder 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 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
  - retryOptions
```
public BlobClientBuilder 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 BlobClientBuilder object
    
    Throws:
    
    NullPointerException - If retryOptions is null.
  - pipeline
```
public BlobClientBuilder 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 BlobClientBuilder object
  - 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 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 BlobClientBuilder object

Class BlobClientBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BlobClientBuilder

Method Detail

buildClient

buildAsyncClient

customerProvidedKey

credential

credential

sasToken

setAnonymousAccess

connectionString

endpoint

containerName

blobName

snapshot

httpClient

addPolicy

httpLogOptions

getDefaultHttpLogOptions

configuration

retryOptions

pipeline

serviceVersion