SpecializedBlobClientBuilder (Azure SDK for Java Reference Documentation)

java.lang.Object
- com.azure.storage.blob.specialized.SpecializedBlobClientBuilder

```
public final class SpecializedBlobClientBuilder
extends Object
```
This class provides a fluent builder API to help aid the configuration and instantiation of specialized Storage Blob clients, AppendBlobClient, AppendBlobAsyncClient, BlockBlobClient, BlockBlobAsyncClient, PageBlobClient, and PageBlobAsyncClient. These clients are used to perform operations that are specific to the blob type.

See Also:

AppendBlobClient, AppendBlobAsyncClient, BlockBlobClient, BlockBlobAsyncClient, PageBlobClient, PageBlobAsyncClient

Constructor Summary

Constructors
Constructor and Description

SpecializedBlobClientBuilder()

Constructors
Constructor and Description
`SpecializedBlobClientBuilder()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SpecializedBlobClientBuilder`	`addPolicy(HttpPipelinePolicy pipelinePolicy)` Adds a pipeline policy to apply on each request sent.
`SpecializedBlobClientBuilder`	`blobAsyncClient(BlobAsyncClientBase blobAsyncClient)` Configures the builder based on the `BlobAsyncClientBase`.
`SpecializedBlobClientBuilder`	`blobClient(BlobClientBase blobClient)` Configures the builder based on the `BlobClientBase`.
`SpecializedBlobClientBuilder`	`blobName(String blobName)` Sets the name of the blob.
`AppendBlobAsyncClient`	`buildAppendBlobAsyncClient()` Creates a `AppendBlobAsyncClient` based on options set in the Builder.
`AppendBlobClient`	`buildAppendBlobClient()` Creates a `AppendBlobClient` based on options set in the Builder.
`BlockBlobAsyncClient`	`buildBlockBlobAsyncClient()` Creates a `BlockBlobAsyncClient` based on options set in the Builder.
`BlockBlobClient`	`buildBlockBlobClient()` Creates a `BlockBlobClient` based on options set in the Builder.
`PageBlobAsyncClient`	`buildPageBlobAsyncClient()` Creates a `PageBlobAsyncClient` based on options set in the Builder.
`PageBlobClient`	`buildPageBlobClient()` Creates a `PageBlobClient` based on options set in the Builder.
`SpecializedBlobClientBuilder`	`configuration(Configuration configuration)` Sets the configuration object used to retrieve environment configuration values during building of the client.
`SpecializedBlobClientBuilder`	`connectionString(String connectionString)` Sets the connection string to connect to the service.
`SpecializedBlobClientBuilder`	`containerAsyncClient(BlobContainerAsyncClient blobContainerAsyncClient, String blobName)` Configures the builder based on the `BlobContainerAsyncClient` and appends the blob name to the container's URL.
`SpecializedBlobClientBuilder`	`containerClient(BlobContainerClient blobContainerClient, String blobName)` Configures the builder based on the `BlobContainerClient` and appends the blob name to the container's URL.
`SpecializedBlobClientBuilder`	`containerName(String containerName)` Sets the name of the container that contains the blob.
`SpecializedBlobClientBuilder`	`credential(StorageSharedKeyCredential credential)` Sets the `StorageSharedKeyCredential` used to authorize requests sent to the service.
`SpecializedBlobClientBuilder`	`credential(TokenCredential credential)` Sets the `TokenCredential` used to authorize requests sent to the service.
`SpecializedBlobClientBuilder`	`customerProvidedKey(CustomerProvidedKey customerProvidedKey)` Sets the `customer provided key` that is used to encrypt blob contents on the server.
`SpecializedBlobClientBuilder`	`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.
`SpecializedBlobClientBuilder`	`httpClient(HttpClient httpClient)` Sets the `HttpClient` to use for sending a receiving requests to and from the service.
`SpecializedBlobClientBuilder`	`httpLogOptions(HttpLogOptions logOptions)` Sets the `HttpLogOptions` for service requests.
`SpecializedBlobClientBuilder`	`pipeline(HttpPipeline httpPipeline)` Sets the `HttpPipeline` to use for the service client.
`SpecializedBlobClientBuilder`	`retryOptions(RequestRetryOptions retryOptions)` Sets the request retry options for all the requests made through the client.
`SpecializedBlobClientBuilder`	`sasToken(String sasToken)` Sets the SAS token used to authorize requests sent to the service.
`SpecializedBlobClientBuilder`	`serviceVersion(BlobServiceVersion version)` Sets the `BlobServiceVersion` that is used when making API requests.
`SpecializedBlobClientBuilder`	`setAnonymousAccess()` Clears the credential used to authorize the request.
`SpecializedBlobClientBuilder`	`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
  - SpecializedBlobClientBuilder
```
public SpecializedBlobClientBuilder()
```
- Method Detail
  - buildAppendBlobClient
```
public AppendBlobClient buildAppendBlobClient()
```
    Creates a AppendBlobClient based on options set in the Builder. AppendBlobClients are used to perform append blob specific operations such as append block, only use this when the blob is known to be an append blob.
    
    Returns:
    
    a AppendBlobClient created from the configurations in this builder.
    
    Throws:
    
    NullPointerException - If endpoint, containerName, or blobName is null.
  - buildAppendBlobAsyncClient
```
public AppendBlobAsyncClient buildAppendBlobAsyncClient()
```
    Creates a AppendBlobAsyncClient based on options set in the Builder. AppendBlobAsyncClients are used to perform append blob specific operations such as append blob, only use this when the blob is known to be an append blob.
    
    Returns:
    
    a AppendBlobAsyncClient created from the configurations in this builder.
    
    Throws:
    
    NullPointerException - If endpoint, containerName, or blobName is null.
  - buildBlockBlobClient
```
public BlockBlobClient buildBlockBlobClient()
```
    Creates a BlockBlobClient based on options set in the Builder. BlockBlobClients are used to perform generic upload operations such as upload from file and block blob specific operations such as stage block and BlockBlobClient.commitBlockList(List), only use this when the blob is known to be a block blob.
    
    Returns:
    
    a BlockBlobClient created from the configurations in this builder.
    
    Throws:
    
    NullPointerException - If endpoint, containerName, or blobName is null.
  - buildBlockBlobAsyncClient
```
public BlockBlobAsyncClient buildBlockBlobAsyncClient()
```
    Creates a BlockBlobAsyncClient based on options set in the Builder. BlockBlobAsyncClients are used to perform generic upload operations such as upload from file and block blob specific operations such as stage block and commit block list, only use this when the blob is known to be a block blob.
    
    Returns:
    
    a BlockBlobAsyncClient created from the configurations in this builder.
    
    Throws:
    
    NullPointerException - If endpoint, containerName, or blobName is null.
  - buildPageBlobClient
```
public PageBlobClient buildPageBlobClient()
```
    Creates a PageBlobClient based on options set in the Builder. PageBlobClients are used to perform page blob specific operations such as upload pages and clear pages, only use this when the blob is known to be a page blob.
    
    Returns:
    
    a PageBlobClient created from the configurations in this builder.
    
    Throws:
    
    NullPointerException - If endpoint, containerName, or blobName is null.
  - buildPageBlobAsyncClient
```
public PageBlobAsyncClient buildPageBlobAsyncClient()
```
    Creates a PageBlobAsyncClient based on options set in the Builder. PageBlobAsyncClients are used to perform page blob specific operations such as upload pages and clear pages, only use this when the blob is known to be a page blob.
    
    Returns:
    
    a PageBlobAsyncClient created from the configurations in this builder.
    
    Throws:
    
    NullPointerException - If endpoint, containerName, or blobName is null.
  - blobClient
```
public SpecializedBlobClientBuilder blobClient(BlobClientBase blobClient)
```
    Configures the builder based on the BlobClientBase.
    
    Parameters:
    
    blobClient - The BlobClientBase used to configure this builder.
    
    Returns:
    
    the updated SpecializedBlobClientBuilder object.
  - blobAsyncClient
```
public SpecializedBlobClientBuilder blobAsyncClient(BlobAsyncClientBase blobAsyncClient)
```
    Configures the builder based on the BlobAsyncClientBase.
    
    Parameters:
    
    blobAsyncClient - The BlobAsyncClientBase used to configure this builder.
    
    Returns:
    
    the updated SpecializedBlobClientBuilder object.
  - containerClient
```
public SpecializedBlobClientBuilder containerClient(BlobContainerClient blobContainerClient,
                                                    String blobName)
```
    Configures the builder based on the BlobContainerClient and appends the blob name to the container's URL.
    
    Parameters:
    
    blobContainerClient - The ContainerClient used to configure this builder.
    
    blobName - Name of the blob.
    
    Returns:
    
    the updated SpecializedBlobClientBuilder object.
  - containerAsyncClient
```
public SpecializedBlobClientBuilder containerAsyncClient(BlobContainerAsyncClient blobContainerAsyncClient,
                                                         String blobName)
```
    Configures the builder based on the BlobContainerAsyncClient and appends the blob name to the container's URL.
    
    Parameters:
    
    blobContainerAsyncClient - The ContainerAsyncClient used to configure this builder.
    
    blobName - Name of the blob.
    
    Returns:
    
    the updated SpecializedBlobClientBuilder object.
  - endpoint
```
public SpecializedBlobClientBuilder endpoint(String endpoint)
```
    Sets the service endpoint, additionally parses it for information (SAS token, container name, blob name)
    
    Parameters:
    
    endpoint - URL of the service
    
    Returns:
    
    the updated SpecializedBlobClientBuilder object
    
    Throws:
    
    IllegalArgumentException - If endpoint is null or is a malformed URL.
  - customerProvidedKey
```
public SpecializedBlobClientBuilder 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 SpecializedBlobClientBuilder object
  - credential
```
public SpecializedBlobClientBuilder 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 SpecializedBlobClientBuilder
    
    Throws:
    
    NullPointerException - If credential is null.
  - credential
```
public SpecializedBlobClientBuilder 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 SpecializedBlobClientBuilder
    
    Throws:
    
    NullPointerException - If credential is null.
  - sasToken
```
public SpecializedBlobClientBuilder 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 SpecializedBlobClientBuilder
    
    Throws:
    
    NullPointerException - If sasToken is null.
  - setAnonymousAccess
```
public SpecializedBlobClientBuilder setAnonymousAccess()
```
    Clears the credential used to authorize the request.
    This is for blobs that are publicly accessible.
    
    Returns:
    
    the updated SpecializedBlobClientBuilder
  - connectionString
```
public SpecializedBlobClientBuilder connectionString(String connectionString)
```
    Sets the connection string to connect to the service.
    
    Parameters:
    
    connectionString - Connection string of the storage account.
    
    Returns:
    
    the updated SpecializedBlobClientBuilder
    
    Throws:
    
    IllegalArgumentException - If connectionString in invalid.
  - containerName
```
public SpecializedBlobClientBuilder containerName(String containerName)
```
    Sets the name of the container that contains the blob.
    Code Samples
```
BlobClient client = new BlobClientBuilder()
    .endpoint(endpoint)
    .containerName(containerName)
    .buildClient();
```
    Parameters:
    
    containerName - Name of the container. If the value null or empty the root container, $root, will be used.
    
    Returns:
    
    the updated SpecializedBlobClientBuilder object
  - blobName
```
public SpecializedBlobClientBuilder blobName(String blobName)
```
    Sets the name of the blob.
    
    Parameters:
    
    blobName - Name of the blob.
    
    Returns:
    
    the updated SpecializedBlobClientBuilder object
    
    Throws:
    
    NullPointerException - If blobName is null
  - snapshot
```
public SpecializedBlobClientBuilder snapshot(String snapshot)
```
    Sets the snapshot identifier of the blob.
    
    Parameters:
    
    snapshot - Snapshot identifier for the blob.
    
    Returns:
    
    the updated SpecializedBlobClientBuilder object
  - httpClient
```
public SpecializedBlobClientBuilder 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 SpecializedBlobClientBuilder object
  - addPolicy
```
public SpecializedBlobClientBuilder addPolicy(HttpPipelinePolicy pipelinePolicy)
```
    Adds a pipeline policy to apply on each request sent.
    
    Parameters:
    
    pipelinePolicy - a pipeline policy
    
    Returns:
    
    the updated SpecializedBlobClientBuilder object
    
    Throws:
    
    NullPointerException - If pipelinePolicy is null.
  - httpLogOptions
```
public SpecializedBlobClientBuilder 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 SpecializedBlobClientBuilder 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 SpecializedBlobClientBuilder 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 SpecializedBlobClientBuilder object
  - retryOptions
```
public SpecializedBlobClientBuilder 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 SpecializedBlobClientBuilder object
    
    Throws:
    
    NullPointerException - If retryOptions is null.
  - pipeline
```
public SpecializedBlobClientBuilder 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 SpecializedBlobClientBuilder object
  - serviceVersion
```
public SpecializedBlobClientBuilder 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 SpecializedBlobClientBuilder object

Class SpecializedBlobClientBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SpecializedBlobClientBuilder

Method Detail

buildAppendBlobClient

buildAppendBlobAsyncClient

buildBlockBlobClient

buildBlockBlobAsyncClient

buildPageBlobClient

buildPageBlobAsyncClient

blobClient

blobAsyncClient

containerClient

containerAsyncClient

endpoint

customerProvidedKey

credential

credential

sasToken

setAnonymousAccess

connectionString

containerName

blobName

snapshot

httpClient

addPolicy

httpLogOptions

getDefaultHttpLogOptions

configuration

retryOptions

pipeline

serviceVersion