SpecializedBlobClientBuilder Class
- java.
lang. Object - com.
azure. storage. blob. specialized. SpecializedBlobClientBuilder
- com.
Implements
public final class SpecializedBlobClientBuilder
implements TokenCredentialTrait<SpecializedBlobClientBuilder>, ConnectionStringTrait<SpecializedBlobClientBuilder>, AzureNamedKeyCredentialTrait<SpecializedBlobClientBuilder>, AzureSasCredentialTrait<SpecializedBlobClientBuilder>, HttpTrait<SpecializedBlobClientBuilder>, ConfigurationTrait<SpecializedBlobClientBuilder>, EndpointTrait<SpecializedBlobClientBuilder>
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.
Constructor Summary
| Constructor | Description | |
|---|---|---|
| SpecializedBlobClientBuilder() | ||
Method Summary
Methods inherited from java.lang.Object
Constructor Details
SpecializedBlobClientBuilder
public SpecializedBlobClientBuilder()
Method Details
addPolicy
public SpecializedBlobClientBuilder addPolicy(HttpPipelinePolicy pipelinePolicy)
Adds a HttpPipelinePolicy 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 no HttpPipeline 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 an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.
Parameters:
Returns:
audience
public SpecializedBlobClientBuilder audience(BlobAudience audience)
Sets the Audience to use for authentication with Azure Active Directory (AAD). The audience is not considered when using a shared key.
Parameters:
Returns:
blobAsyncClient
public SpecializedBlobClientBuilder blobAsyncClient(BlobAsyncClientBase blobAsyncClient)
Configures the builder based on the BlobAsyncClientBase.
Parameters:
BlobAsyncClientBase used to configure this builder.
Returns:
blobClient
public SpecializedBlobClientBuilder blobClient(BlobClientBase blobClient)
Configures the builder based on the BlobClientBase.
Parameters:
BlobClientBase used to configure this builder.
Returns:
blobName
public SpecializedBlobClientBuilder blobName(String blobName)
Sets the name of the blob.
Parameters:
Returns:
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:
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 appendBlock(InputStream data, long length), only use this when the blob is known to be an append blob.
Returns:
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(Flux<ByteBuffer> data, long length) and block blob specific operations such as stage block and commitBlockList(List<String> base64BlockIds), only use this when the blob is known to be a block blob.
Returns:
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(InputStream data, long length) and block blob specific operations such as stageBlock(String base64BlockId, InputStream data, long length) and commitBlockList(List<String> base64BlockIds), only use this when the blob is known to be a block blob.
Returns:
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 clearPages(PageRange pageRange), only use this when the blob is known to be a page blob.
Returns:
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 uploadPages(PageRange pageRange, InputStream body) and clearPages(PageRange pageRange), only use this when the blob is known to be a page blob.
Returns:
clientOptions
public SpecializedBlobClientBuilder clientOptions(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 the HttpClientOptions class (a subclass of the ClientOptions 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 no HttpPipeline 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 an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.
Parameters:
Returns:
configuration
public SpecializedBlobClientBuilder configuration(Configuration configuration)
Sets the configuration object used to retrieve environment configuration values during building of the client.
Parameters:
Returns:
connectionString
public SpecializedBlobClientBuilder connectionString(String connectionString)
Sets the connection string to connect to the service.
Parameters:
Returns:
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:
ContainerAsyncClient used to configure this builder.
Returns:
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:
ContainerClient used to configure this builder.
Returns:
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:
null or empty the root container, $root,
will be used.
Returns:
credential
public SpecializedBlobClientBuilder credential(AzureNamedKeyCredential credential)
Sets the AzureNamedKeyCredential used to authorize requests sent to the service.
Parameters:
Returns:
credential
public SpecializedBlobClientBuilder credential(AzureSasCredential credential)
Sets the AzureSasCredential used to authorize requests sent to the service.
Parameters:
Returns:
credential
public SpecializedBlobClientBuilder credential(TokenCredential credential)
Sets the TokenCredential 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 the TokenCredential type.
Parameters:
Returns:
credential
public SpecializedBlobClientBuilder credential(StorageSharedKeyCredential credential)
Sets the StorageSharedKeyCredential used to authorize requests sent to the service.
Parameters:
Returns:
customerProvidedKey
public SpecializedBlobClientBuilder customerProvidedKey(CustomerProvidedKey customerProvidedKey)
Sets the CustomerProvidedKey that is used to encrypt blob contents on the server.
Parameters:
Returns:
encryptionScope
public SpecializedBlobClientBuilder encryptionScope(String encryptionScope)
Sets the encryption scope that is used to encrypt blob contents on the server.
Parameters:
Returns:
endpoint
public SpecializedBlobClientBuilder endpoint(String endpoint)
Sets the service endpoint, additionally parses it for information (SAS token, container name, blob name)
Parameters:
Returns:
getDefaultHttpLogOptions
public static HttpLogOptions getDefaultHttpLogOptions()
Gets the default Storage allowlist log headers and query parameters.
Returns:
httpClient
public SpecializedBlobClientBuilder httpClient(HttpClient httpClient)
Sets the HttpClient 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 no HttpPipeline 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 an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.
Parameters:
Returns:
httpLogOptions
public SpecializedBlobClientBuilder httpLogOptions(HttpLogOptions logOptions)
Sets the HttpLogOptions to use when sending and receiving requests to and from the service. If a logLevel is not provided, default value of HttpLogDetailLevel#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 no HttpPipeline 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 an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.
Parameters:
Returns:
pipeline
public SpecializedBlobClientBuilder pipeline(HttpPipeline httpPipeline)
Sets the HttpPipeline 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 no HttpPipeline 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 an HttpPipeline 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(String endpoint) is not ignored when pipeline is set.
Parameters:
Returns:
retryOptions
public SpecializedBlobClientBuilder retryOptions(RetryOptions retryOptions)
Sets the RetryOptions 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 no HttpPipeline 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 an HttpPipeline 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 retryOptions). Consider using retryOptions(RequestRetryOptions retryOptions) to also set storage specific options.
Parameters:
Returns:
retryOptions
public SpecializedBlobClientBuilder retryOptions(RequestRetryOptions retryOptions)
Sets the request retry options for all the requests made through the client. Setting this is mutually exclusive with using retryOptions(RetryOptions retryOptions).
Parameters:
Returns:
sasToken
public SpecializedBlobClientBuilder sasToken(String sasToken)
Sets the SAS token used to authorize requests sent to the service.
Parameters:
Returns:
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:
Returns:
setAnonymousAccess
public SpecializedBlobClientBuilder setAnonymousAccess()
Clears the credential used to authorize the request.
This is for blobs that are publicly accessible.
Returns:
snapshot
public SpecializedBlobClientBuilder snapshot(String snapshot)
Sets the snapshot identifier of the blob.
Parameters:
Returns:
versionId
public SpecializedBlobClientBuilder versionId(String versionId)
Sets the version identifier of the blob.
Parameters:
null to interact with the latest blob version.
Returns:
Applies to
Azure SDK for Java
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for