Package com.azure.storage.blob.specialized

Class SpecializedBlobClientBuilder

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

      • 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

      • encryptionScope

        public SpecializedBlobClientBuilder 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 BlobClientBuilder object

      • credential

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

      • credential

        public SpecializedBlobClientBuilder 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 SpecializedBlobClientBuilder
        Throws:
        NullPointerException - If credential 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

      • 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

      • versionId

        public SpecializedBlobClientBuilder versionId​(String versionId)
        Sets the version identifier of the blob.
        Parameters:
        versionId - Version identifier for the blob, pass null to interact with the latest blob version.
        Returns:
        the updated SpecializedBlobClientBuilder object

      • httpClient

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

      • addPolicy

        public SpecializedBlobClientBuilder 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 SpecializedBlobClientBuilder object
        Throws:
        NullPointerException - If pipelinePolicy is null.

      • httpLogOptions

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

      • pipeline

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

      • clientOptions

        public SpecializedBlobClientBuilder 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 SpecializedBlobClientBuilder object
        Throws:
        NullPointerException - If clientOptions is null.

      • 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 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 SpecializedBlobClientBuilder object