你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

SpecializedBlobClientBuilder Class

Package:

com.azure.storage.blob.specialized

Maven Artifact:

com.azure:azure-storage-blob:12.28.1

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

Implements

AzureNamedKeyCredentialTrait<SpecializedBlobClientBuilder> AzureSasCredentialTrait<SpecializedBlobClientBuilder> ConfigurationTrait<SpecializedBlobClientBuilder> ConnectionStringTrait<SpecializedBlobClientBuilder> EndpointTrait<SpecializedBlobClientBuilder> HttpTrait<SpecializedBlobClientBuilder> TokenCredentialTrait<SpecializedBlobClientBuilder>

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

Modifier and Type	Method and Description
SpecializedBlobClientBuilder	addPolicy(HttpPipelinePolicy pipelinePolicy) Adds a HttpPipelinePolicy to apply on each request sent.
SpecializedBlobClientBuilder	audience(BlobAudience audience) Sets the Audience to use for authentication with Azure Active Directory (AAD).
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	clientOptions(ClientOptions clientOptions) Allows for setting common properties such as application ID, headers, proxy configuration, etc.
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(AzureNamedKeyCredential credential) Sets the AzureNamedKeyCredential used to authorize requests sent to the service.
SpecializedBlobClientBuilder	credential(AzureSasCredential credential) Sets the AzureSasCredential used to authorize requests sent to the service.
SpecializedBlobClientBuilder	credential(TokenCredential credential) Sets the TokenCredential used to authorize requests sent to the service.
SpecializedBlobClientBuilder	credential(StorageSharedKeyCredential credential) Sets the StorageSharedKeyCredential used to authorize requests sent to the service.
SpecializedBlobClientBuilder	customerProvidedKey(CustomerProvidedKey customerProvidedKey) Sets the CustomerProvidedKey that is used to encrypt blob contents on the server.
SpecializedBlobClientBuilder	encryptionScope(String encryptionScope) Sets the encryption scope 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 allowlist log headers and query parameters.
SpecializedBlobClientBuilder	httpClient(HttpClient httpClient) Sets the HttpClient to use for sending and receiving requests to and from the service.
SpecializedBlobClientBuilder	httpLogOptions(HttpLogOptions logOptions) Sets the HttpLogOptions to use when sending and receiving requests to and from the service.
SpecializedBlobClientBuilder	pipeline(HttpPipeline httpPipeline) Sets the HttpPipeline to use for the service client.
SpecializedBlobClientBuilder	retryOptions(RetryOptions retryOptions) Sets the RetryOptions for all the requests made through the 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.
SpecializedBlobClientBuilder	versionId(String versionId) Sets the version identifier of the blob.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

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:

pipelinePolicy - A HttpPipelinePolicy.

Returns:

the updated SpecializedBlobClientBuilder object

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:

audience - BlobAudience to be used when requesting a token from Azure Active Directory (AAD).

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.

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.

blobName

public SpecializedBlobClientBuilder blobName(String blobName)

Sets the name of the blob.

Parameters:

blobName - Name of the blob.

Returns:

the updated SpecializedBlobClientBuilder object

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.

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:

a AppendBlobClient created from the configurations in this builder.

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:

a BlockBlobAsyncClient created from the configurations in this builder.

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:

a BlockBlobClient created from the configurations in this builder.

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:

a PageBlobAsyncClient created from the configurations in this builder.

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:

a PageBlobClient created from the configurations in this builder.

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:

clientOptions - A configured instance of HttpClientOptions.

Returns:

the updated SpecializedBlobClientBuilder object

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

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

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.

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.

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

credential

public SpecializedBlobClientBuilder credential(AzureNamedKeyCredential credential)

Sets the AzureNamedKeyCredential used to authorize requests sent to the service.

Parameters:

credential - AzureNamedKeyCredential.

Returns:

the updated SpecializedBlobClientBuilder

credential

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

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:

credential - TokenCredential used to authorize requests sent to the service.

Returns:

the updated SpecializedBlobClientBuilder

credential

public SpecializedBlobClientBuilder credential(StorageSharedKeyCredential credential)

Sets the StorageSharedKeyCredential used to authorize requests sent to the service.

Parameters:

credential - StorageSharedKeyCredential.

Returns:

the updated SpecializedBlobClientBuilder

customerProvidedKey

public SpecializedBlobClientBuilder customerProvidedKey(CustomerProvidedKey customerProvidedKey)

Sets the CustomerProvidedKey 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

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

getDefaultHttpLogOptions

public static HttpLogOptions getDefaultHttpLogOptions()

Gets the default Storage allowlist log headers and query parameters.

Returns:

the default http log options.

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:

httpClient - The HttpClient to use for requests.

Returns:

the updated SpecializedBlobClientBuilder object

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:

logOptions - The HttpLogOptions to use when sending and receiving requests to and from the service.

Returns:

the updated SpecializedBlobClientBuilder object

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:

httpPipeline - HttpPipeline to use for sending service requests and receiving responses.

Returns:

the updated SpecializedBlobClientBuilder object

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:

retryOptions - The RetryOptions to use for all the requests made through the client.

Returns:

the updated SpecializedBlobClientBuilder object

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:

retryOptions - RequestRetryOptions.

Returns:

the updated SpecializedBlobClientBuilder object

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

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

setAnonymousAccess

public SpecializedBlobClientBuilder setAnonymousAccess()

Clears the credential used to authorize the request.

This is for blobs that are publicly accessible.

Returns:

the updated SpecializedBlobClientBuilder

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