Package com.azure.storage.blob

Class 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 Detail

    • Method Detail

      • 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.
        Throws:
        IllegalStateException - If multiple credentials have been specified.

      • 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

      • 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

      • blobContainerEncryptionScope

        public BlobContainerClientBuilder blobContainerEncryptionScope​(BlobContainerEncryptionScope blobContainerEncryptionScope)
        Sets the encryption scope 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

      • credential

        public BlobContainerClientBuilder credential​(com.azure.core.credential.TokenCredential credential)
        Sets the TokenCredential used to authorize requests sent to the service.
        Parameters:
        credential - TokenCredential.
        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. This string should only be the query parameters (with or without a leading '?') and not a full url.
        Returns:
        the updated BlobContainerClientBuilder
        Throws:
        NullPointerException - If sasToken is null.

      • credential

        public BlobContainerClientBuilder credential​(com.azure.core.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
        Throws:
        NullPointerException - If credential 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​(com.azure.core.http.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​(com.azure.core.http.policy.HttpPipelinePolicy pipelinePolicy)
        Adds a pipeline policy to apply on each request sent. The policy will be added after the retry policy. If the method is called multiple times, all policies will be added and their order preserved.
        Parameters:
        pipelinePolicy - a pipeline policy
        Returns:
        the updated BlobContainerClientBuilder object
        Throws:
        NullPointerException - If pipelinePolicy is null.

      • httpLogOptions

        public BlobContainerClientBuilder httpLogOptions​(com.azure.core.http.policy.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 com.azure.core.http.policy.HttpLogOptions getDefaultHttpLogOptions()
        Gets the default Storage allowlist log headers and query parameters.
        Returns:
        the default http log options.

      • configuration

        public BlobContainerClientBuilder configuration​(com.azure.core.util.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

      • clientOptions

        public BlobContainerClientBuilder clientOptions​(com.azure.core.util.ClientOptions clientOptions)
        Sets the client options for all the requests made through the client.
        Parameters:
        clientOptions - ClientOptions.
        Returns:
        the updated BlobContainerClientBuilder object
        Throws:
        NullPointerException - If clientOptions is null.

      • pipeline

        public BlobContainerClientBuilder pipeline​(com.azure.core.http.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 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