Class BlobClientBuilder
- java.lang.Object
-
- com.azure.storage.blob.BlobClientBuilder
-
- All Implemented Interfaces:
com.azure.core.client.traits.AzureNamedKeyCredentialTrait<BlobClientBuilder>
,com.azure.core.client.traits.AzureSasCredentialTrait<BlobClientBuilder>
,com.azure.core.client.traits.ConfigurationTrait<BlobClientBuilder>
,com.azure.core.client.traits.ConnectionStringTrait<BlobClientBuilder>
,com.azure.core.client.traits.EndpointTrait<BlobClientBuilder>
,com.azure.core.client.traits.HttpTrait<BlobClientBuilder>
,com.azure.core.client.traits.TokenCredentialTrait<BlobClientBuilder>
public final class BlobClientBuilder extends Object implements com.azure.core.client.traits.TokenCredentialTrait<BlobClientBuilder>, com.azure.core.client.traits.ConnectionStringTrait<BlobClientBuilder>, com.azure.core.client.traits.AzureNamedKeyCredentialTrait<BlobClientBuilder>, com.azure.core.client.traits.AzureSasCredentialTrait<BlobClientBuilder>, com.azure.core.client.traits.HttpTrait<BlobClientBuilder>, com.azure.core.client.traits.ConfigurationTrait<BlobClientBuilder>, com.azure.core.client.traits.EndpointTrait<BlobClientBuilder>
This class provides a fluent builder API to help aid the configuration and instantiation ofBlobClients
andBlobAsyncClients
, callbuildClient
andbuildAsyncClient
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 ofhttps://{accountName}.blob.core.windows.net/{containerName}/{blobName}
. - the credential through
.credential()
or.connectionString()
if the container is not publicly accessible.
-
-
Constructor Summary
Constructors Constructor Description BlobClientBuilder()
Creates a builder instance that is able to configure and constructBlobClients
andBlobAsyncClients
.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description BlobClientBuilder
addPolicy(com.azure.core.http.policy.HttpPipelinePolicy pipelinePolicy)
Adds apipeline policy
to apply on each request sent.BlobClientBuilder
blobName(String blobName)
Sets the name of the blob.BlobAsyncClient
buildAsyncClient()
Creates aBlobAsyncClient
based on options set in the builder.BlobClient
buildClient()
Creates aBlobClient
based on options set in the builder.BlobClientBuilder
clientOptions(com.azure.core.util.ClientOptions clientOptions)
Allows for setting common properties such as application ID, headers, proxy configuration, etc.BlobClientBuilder
configuration(com.azure.core.util.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(com.azure.core.credential.AzureNamedKeyCredential credential)
Sets theAzureNamedKeyCredential
used to authorize requests sent to the service.BlobClientBuilder
credential(com.azure.core.credential.AzureSasCredential credential)
Sets theAzureSasCredential
used to authorize requests sent to the service.BlobClientBuilder
credential(com.azure.core.credential.TokenCredential credential)
Sets theTokenCredential
used to authorize requests sent to the service.BlobClientBuilder
credential(StorageSharedKeyCredential credential)
Sets theStorageSharedKeyCredential
used to authorize requests sent to the service.BlobClientBuilder
customerProvidedKey(CustomerProvidedKey customerProvidedKey)
Sets thecustomer provided key
that is used to encrypt blob contents on the server.BlobClientBuilder
encryptionScope(String encryptionScope)
Sets theencryption scope
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 com.azure.core.http.policy.HttpLogOptions
getDefaultHttpLogOptions()
Gets the default Storage allowlist log headers and query parameters.BlobClientBuilder
httpClient(com.azure.core.http.HttpClient httpClient)
Sets theHttpClient
to use for sending and receiving requests to and from the service.BlobClientBuilder
httpLogOptions(com.azure.core.http.policy.HttpLogOptions logOptions)
Sets thelogging configuration
to use when sending and receiving requests to and from the service.BlobClientBuilder
pipeline(com.azure.core.http.HttpPipeline httpPipeline)
Sets theHttpPipeline
to use for the service client.BlobClientBuilder
retryOptions(com.azure.core.http.policy.RetryOptions retryOptions)
Sets theRetryOptions
for all the requests made through the 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 theBlobServiceVersion
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.BlobClientBuilder
versionId(String versionId)
Sets the version identifier of the blob.
-
-
-
Constructor Detail
-
BlobClientBuilder
public BlobClientBuilder()
Creates a builder instance that is able to configure and constructBlobClients
andBlobAsyncClients
.
-
-
Method Detail
-
buildClient
public BlobClient buildClient()
Creates aBlobClient
based on options set in the builder. BlobClients are used to perform generic blob methods such asdownload
andget 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
- Ifendpoint
orblobName
isnull
.IllegalStateException
- If multiple credentials have been specified.IllegalStateException
- If bothretryOptions(RetryOptions)
andretryOptions(RequestRetryOptions)
have been set.
-
buildAsyncClient
public BlobAsyncClient buildAsyncClient()
Creates aBlobAsyncClient
based on options set in the builder. BlobAsyncClients are used to perform generic blob methods such asdownload
andBlobAsyncClientBase.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
- Ifendpoint
orblobName
isnull
.IllegalStateException
- If multiple credentials have been specified.IllegalStateException
- If bothretryOptions(RetryOptions)
andretryOptions(RequestRetryOptions)
have been set.
-
customerProvidedKey
public BlobClientBuilder customerProvidedKey(CustomerProvidedKey customerProvidedKey)
Sets thecustomer provided key
that is used to encrypt blob contents on the server.- Parameters:
customerProvidedKey
-CustomerProvidedKey
- Returns:
- the updated BlobClientBuilder object
-
encryptionScope
public BlobClientBuilder encryptionScope(String encryptionScope)
Sets theencryption 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 BlobClientBuilder credential(StorageSharedKeyCredential credential)
Sets theStorageSharedKeyCredential
used to authorize requests sent to the service.- Parameters:
credential
-StorageSharedKeyCredential
.- Returns:
- the updated BlobClientBuilder
- Throws:
NullPointerException
- Ifcredential
isnull
.
-
credential
public BlobClientBuilder credential(com.azure.core.credential.AzureNamedKeyCredential credential)
Sets theAzureNamedKeyCredential
used to authorize requests sent to the service.- Specified by:
credential
in interfacecom.azure.core.client.traits.AzureNamedKeyCredentialTrait<BlobClientBuilder>
- Parameters:
credential
-AzureNamedKeyCredential
.- Returns:
- the updated BlobClientBuilder
- Throws:
NullPointerException
- Ifcredential
isnull
.
-
credential
public BlobClientBuilder credential(com.azure.core.credential.TokenCredential credential)
Sets theTokenCredential
used to authorize requests sent to the service. Refer to the Azure SDK for Java identity and authentication documentation for more details on proper usage of theTokenCredential
type.- Specified by:
credential
in interfacecom.azure.core.client.traits.TokenCredentialTrait<BlobClientBuilder>
- Parameters:
credential
-TokenCredential
used to authorize requests sent to the service.- Returns:
- the updated BlobClientBuilder
- Throws:
NullPointerException
- Ifcredential
isnull
.
-
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. This string should only be the query parameters (with or without a leading '?') and not a full url.- Returns:
- the updated BlobClientBuilder
- Throws:
NullPointerException
- IfsasToken
isnull
.
-
credential
public BlobClientBuilder credential(com.azure.core.credential.AzureSasCredential credential)
Sets theAzureSasCredential
used to authorize requests sent to the service.- Specified by:
credential
in interfacecom.azure.core.client.traits.AzureSasCredentialTrait<BlobClientBuilder>
- Parameters:
credential
-AzureSasCredential
used to authorize requests sent to the service.- Returns:
- the updated BlobClientBuilder
- Throws:
NullPointerException
- Ifcredential
isnull
.
-
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.- Specified by:
connectionString
in interfacecom.azure.core.client.traits.ConnectionStringTrait<BlobClientBuilder>
- Parameters:
connectionString
- Connection string of the storage account.- Returns:
- the updated BlobClientBuilder
- Throws:
IllegalArgumentException
- IfconnectionString
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 blob name contains special characters, pass in the url encoded version of the 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.- Specified by:
endpoint
in interfacecom.azure.core.client.traits.EndpointTrait<BlobClientBuilder>
- Parameters:
endpoint
- URL of the service- Returns:
- the updated BlobClientBuilder object
- Throws:
IllegalArgumentException
- Ifendpoint
isnull
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 valuenull
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. If the blob name contains special characters, pass in the url encoded version of the blob name.- Returns:
- the updated BlobClientBuilder object
- Throws:
NullPointerException
- IfblobName
isnull
-
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
-
versionId
public BlobClientBuilder versionId(String versionId)
Sets the version identifier of the blob.- Parameters:
versionId
- Version identifier for the blob, passnull
to interact with the latest blob version.- Returns:
- the updated BlobClientBuilder object
-
httpClient
public BlobClientBuilder httpClient(com.azure.core.http.HttpClient httpClient)
Sets theHttpClient
to use for sending and receiving requests to and from the service.Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a
HttpPipeline
is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If noHttpPipeline
is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if anHttpPipeline
is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.- Specified by:
httpClient
in interfacecom.azure.core.client.traits.HttpTrait<BlobClientBuilder>
- Parameters:
httpClient
- TheHttpClient
to use for requests.- Returns:
- the updated BlobClientBuilder object
-
addPolicy
public BlobClientBuilder addPolicy(com.azure.core.http.policy.HttpPipelinePolicy pipelinePolicy)
Adds apipeline policy
to apply on each request sent.Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a
HttpPipeline
is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If noHttpPipeline
is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if anHttpPipeline
is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.- Specified by:
addPolicy
in interfacecom.azure.core.client.traits.HttpTrait<BlobClientBuilder>
- Parameters:
pipelinePolicy
- Apipeline policy
.- Returns:
- the updated BlobClientBuilder object
- Throws:
NullPointerException
- IfpipelinePolicy
isnull
.
-
httpLogOptions
public BlobClientBuilder httpLogOptions(com.azure.core.http.policy.HttpLogOptions logOptions)
Sets thelogging configuration
to use when sending and receiving requests to and from the service. If alogLevel
is not provided, default value ofHttpLogDetailLevel.NONE
is set.Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a
HttpPipeline
is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If noHttpPipeline
is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if anHttpPipeline
is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.- Specified by:
httpLogOptions
in interfacecom.azure.core.client.traits.HttpTrait<BlobClientBuilder>
- Parameters:
logOptions
- Thelogging configuration
to use when sending and receiving requests to and from the service.- Returns:
- the updated BlobClientBuilder object
- Throws:
NullPointerException
- IflogOptions
isnull
.
-
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 BlobClientBuilder configuration(com.azure.core.util.Configuration configuration)
Sets the configuration object used to retrieve environment configuration values during building of the client.- Specified by:
configuration
in interfacecom.azure.core.client.traits.ConfigurationTrait<BlobClientBuilder>
- 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. Setting this is mutually exclusive with usingretryOptions(RetryOptions)
.- Parameters:
retryOptions
-RequestRetryOptions
.- Returns:
- the updated BlobClientBuilder object
-
retryOptions
public BlobClientBuilder retryOptions(com.azure.core.http.policy.RetryOptions retryOptions)
Sets theRetryOptions
for all the requests made through the client.Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a
HttpPipeline
is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If noHttpPipeline
is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if anHttpPipeline
is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.Setting this is mutually exclusive with using
retryOptions(RequestRetryOptions)
. Consider usingretryOptions(RequestRetryOptions)
to also set storage specific options.- Specified by:
retryOptions
in interfacecom.azure.core.client.traits.HttpTrait<BlobClientBuilder>
- Parameters:
retryOptions
- TheRetryOptions
to use for all the requests made through the client.- Returns:
- the updated BlobClientBuilder object
-
clientOptions
public BlobClientBuilder clientOptions(com.azure.core.util.ClientOptions clientOptions)
Allows for setting common properties such as application ID, headers, proxy configuration, etc. Note that it is recommended that this method be called with an instance of theHttpClientOptions
class (a subclass of theClientOptions
base class). The HttpClientOptions subclass provides more configuration options suitable for HTTP clients, which is applicable for any class that implements this HttpTrait interface.Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a
HttpPipeline
is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If noHttpPipeline
is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if anHttpPipeline
is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.- Specified by:
clientOptions
in interfacecom.azure.core.client.traits.HttpTrait<BlobClientBuilder>
- Parameters:
clientOptions
- A configured instance ofHttpClientOptions
.- Returns:
- the updated BlobClientBuilder object
- Throws:
NullPointerException
- IfclientOptions
isnull
.- See Also:
HttpClientOptions
-
pipeline
public BlobClientBuilder pipeline(com.azure.core.http.HttpPipeline httpPipeline)
Sets theHttpPipeline
to use for the service client.Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a
HttpPipeline
is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If noHttpPipeline
is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if anHttpPipeline
is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.The
endpoint
is not ignored whenpipeline
is set.- Specified by:
pipeline
in interfacecom.azure.core.client.traits.HttpTrait<BlobClientBuilder>
- Parameters:
httpPipeline
-HttpPipeline
to use for sending service requests and receiving responses.- Returns:
- the updated BlobClientBuilder object
-
serviceVersion
public BlobClientBuilder serviceVersion(BlobServiceVersion version)
Sets theBlobServiceVersion
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 BlobClientBuilder object
-
-