BlobClient Class

Package:

com.azure.storage.blob

Maven Artifact:

com.azure:azure-storage-blob:12.28.1

• java.lang.Object
• • com.azure.storage.blob.specialized.BlobClientBase
  • • com.azure.storage.blob.BlobClient

public class BlobClient
extends BlobClientBase

This class provides a client that contains generic blob operations for Azure Storage Blobs. Operations allowed by the client are uploading and downloading, copying a blob, retrieving and setting metadata, retrieving and setting HTTP headers, and deleting and un-deleting a blob.

This client is instantiated through BlobClientBuilder or retrieved via getBlobClient(String blobName).

For operations on a specific blob type (i.e append, block, or page) use getAppendBlobClient(), getBlockBlobClient(), or getPageBlobClient() to construct a client that allows blob specific operations.

Please refer to the Azure Docs for more information.

Field Summary

Modifier and Type	Field and Description
static final int	BLOB_DEFAULT_HTBB_UPLOAD_BLOCK_SIZE If a blob is known to be greater than 100MB, using a larger block size will trigger some server-side optimizations.
static final int	BLOB_DEFAULT_NUMBER_OF_BUFFERS The number of buffers to use if none is specied on the buffered upload method.
static final int	BLOB_DEFAULT_UPLOAD_BLOCK_SIZE The block size to use if none is specified in parallel operations.

Constructor Summary

Modifier	Constructor	Description
protected	BlobClient(BlobAsyncClient client)	Protected constructor for use by BlobClientBuilder.

Method Summary

Modifier and Type	Method and Description
AppendBlobClient	getAppendBlobClient() Creates a new AppendBlobClient associated with this blob.
BlockBlobClient	getBlockBlobClient() Creates a new BlockBlobClient associated with this blob.
BlobClient	getCustomerProvidedKeyClient(CustomerProvidedKey customerProvidedKey) Creates a new BlobClient with the specified customerProvidedKey.
BlobClient	getEncryptionScopeClient(String encryptionScope) Creates a new BlobClient with the specified encryptionScope.
PageBlobClient	getPageBlobClient() Creates a new PageBlobClient associated with this blob.
BlobClient	getSnapshotClient(String snapshot) Creates a new BlobClient linked to the snapshot of this blob resource.
BlobClient	getVersionClient(String versionId) Creates a new BlobClient linked to the version of this blob resource.
void	upload(BinaryData data) Creates a new blob.
void	upload(BinaryData data, boolean overwrite) Creates a new blob, or updates the content of an existing blob.
void	upload(InputStream data) Creates a new blob.
void	upload(InputStream data, boolean overwrite) Creates a new blob, or updates the content of an existing blob.
void	upload(InputStream data, long length) Creates a new blob.
void	upload(InputStream data, long length, boolean overwrite) Creates a new blob, or updates the content of an existing blob.
void	uploadFromFile(String filePath) Creates a new block blob.
void	uploadFromFile(String filePath, boolean overwrite) Creates a new block blob, or updates the content of an existing block blob.
void	uploadFromFile(String filePath, ParallelTransferOptions parallelTransferOptions, BlobHttpHeaders headers, Map<String,String> metadata, AccessTier tier, BlobRequestConditions requestConditions, Duration timeout) Creates a new block blob, or updates the content of an existing block blob.
Response<BlockBlobItem>	uploadFromFileWithResponse(BlobUploadFromFileOptions options, Duration timeout, Context context) Creates a new block blob, or updates the content of an existing block blob.
Response<BlockBlobItem>	uploadWithResponse(BlobParallelUploadOptions options, Context context) Deprecated Use uploadWithResponse(BlobParallelUploadOptions options, Duration timeout, Context context) Creates a new blob, or updates the content of an existing blob.
Response<BlockBlobItem>	uploadWithResponse(BlobParallelUploadOptions options, Duration timeout, Context context) Creates a new blob, or updates the content of an existing blob.
void	uploadWithResponse(InputStream data, long length, ParallelTransferOptions parallelTransferOptions, BlobHttpHeaders headers, Map<String,String> metadata, AccessTier tier, BlobRequestConditions requestConditions, Duration timeout, Context context) Deprecated See uploadWithResponse(BlobParallelUploadOptions options, Duration timeout, Context context) instead Creates a new blob, or updates the content of an existing blob.

Methods inherited from BlobClientBase

abortCopyFromUrl abortCopyFromUrlWithResponse beginCopy beginCopy beginCopy copyFromUrl copyFromUrlWithResponse copyFromUrlWithResponse createSnapshot createSnapshotWithResponse delete deleteIfExists deleteIfExistsWithResponse deleteImmutabilityPolicy deleteImmutabilityPolicyWithResponse deleteWithResponse download downloadContent downloadContentWithResponse downloadContentWithResponse downloadStream downloadStreamWithResponse downloadToFile downloadToFile downloadToFileWithResponse downloadToFileWithResponse downloadToFileWithResponse downloadWithResponse exists existsWithResponse generateSas generateSas generateSas generateUserDelegationSas generateUserDelegationSas generateUserDelegationSas getAccountInfo getAccountInfoWithResponse getAccountName getAccountUrl getBlobName getBlobUrl getContainerClient getContainerName getCustomerProvidedKey getCustomerProvidedKeyClient getEncryptionScope getEncryptionScopeClient getHttpPipeline getProperties getPropertiesWithResponse getServiceVersion getSnapshotClient getSnapshotId getTags getTagsWithResponse getVersionClient getVersionId isSnapshot openInputStream openInputStream openInputStream openInputStream openQueryInputStream openQueryInputStreamWithResponse openSeekableByteChannelRead query queryWithResponse setAccessTier setAccessTierWithResponse setAccessTierWithResponse setHttpHeaders setHttpHeadersWithResponse setImmutabilityPolicy setImmutabilityPolicyWithResponse setLegalHold setLegalHoldWithResponse setMetadata setMetadataWithResponse setTags setTagsWithResponse undelete undeleteWithResponse

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Details

BLOB_DEFAULT_HTBB_UPLOAD_BLOCK_SIZE

public static final int BLOB_DEFAULT_HTBB_UPLOAD_BLOCK_SIZE

If a blob is known to be greater than 100MB, using a larger block size will trigger some server-side optimizations. If the block size is not set and the size of the blob is known to be greater than 100MB, this value will be used.

BLOB_DEFAULT_NUMBER_OF_BUFFERS

public static final int BLOB_DEFAULT_NUMBER_OF_BUFFERS

The number of buffers to use if none is specied on the buffered upload method.

BLOB_DEFAULT_UPLOAD_BLOCK_SIZE

public static final int BLOB_DEFAULT_UPLOAD_BLOCK_SIZE

The block size to use if none is specified in parallel operations.

Constructor Details

BlobClient

protected BlobClient(BlobAsyncClient client)

Protected constructor for use by BlobClientBuilder.

Parameters:

client - the async blob client

Method Details

getAppendBlobClient

public AppendBlobClient getAppendBlobClient()

Creates a new AppendBlobClient associated with this blob.

Returns:

A AppendBlobClient associated with this blob.

getBlockBlobClient

public BlockBlobClient getBlockBlobClient()

Creates a new BlockBlobClient associated with this blob.

Returns:

A BlockBlobClient associated with this blob.

getCustomerProvidedKeyClient

public BlobClient getCustomerProvidedKeyClient(CustomerProvidedKey customerProvidedKey)

Creates a new BlobClient with the specified customerProvidedKey.

Overrides:

BlobClient.getCustomerProvidedKeyClient(CustomerProvidedKey customerProvidedKey)

Parameters:

customerProvidedKey - the CustomerProvidedKey for the blob, pass null to use no customer provided key.

Returns:

a BlobClient with the specified customerProvidedKey.

getEncryptionScopeClient

public BlobClient getEncryptionScopeClient(String encryptionScope)

Creates a new BlobClient with the specified encryptionScope.

Overrides:

BlobClient.getEncryptionScopeClient(String encryptionScope)

Parameters:

encryptionScope - the encryption scope for the blob, pass null to use no encryption scope.

Returns:

a BlobClient with the specified encryptionScope.

getPageBlobClient

public PageBlobClient getPageBlobClient()

Creates a new PageBlobClient associated with this blob.

Returns:

A PageBlobClient associated with this blob.

getSnapshotClient

public BlobClient getSnapshotClient(String snapshot)

Creates a new BlobClient linked to the snapshot of this blob resource.

Overrides:

BlobClient.getSnapshotClient(String snapshot)

Parameters:

snapshot - the identifier for a specific snapshot of this blob

Returns:

A BlobClient used to interact with the specific snapshot.

getVersionClient

public BlobClient getVersionClient(String versionId)

Creates a new BlobClient linked to the version of this blob resource.

Overrides:

BlobClient.getVersionClient(String versionId)

Parameters:

versionId - the identifier for a specific version of this blob, pass null to interact with the latest blob version.

Returns:

A BlobClient used to interact with the specific version.

upload

public void upload(BinaryData data)

Creates a new blob. By default this method will not overwrite an existing blob.

Parameters:

data - The data to write to the blob.

upload

public void upload(BinaryData data, boolean overwrite)

Creates a new blob, or updates the content of an existing blob.

Parameters:

data - The data to write to the blob.

overwrite - Whether or not to overwrite, should data exist on the blob.

upload

public void upload(InputStream data)

Creates a new blob. By default this method will not overwrite an existing blob.

Parameters:

data - The data to write to the blob. The data must be markable. This is in order to support retries. If the data is not markable, consider opening a BlobOutputStream and writing to the returned stream. Alternatively, consider wrapping your data source in a BufferedInputStream to add mark support.

upload

public void upload(InputStream data, boolean overwrite)

Creates a new blob, or updates the content of an existing blob.

Parameters:

data - The data to write to the blob. The data must be markable. This is in order to support retries. If the data is not markable, consider opening a BlobOutputStream and writing to the returned stream. Alternatively, consider wrapping your data source in a BufferedInputStream to add mark support.

overwrite - Whether or not to overwrite, should data exist on the blob.

upload

public void upload(InputStream data, long length)

Creates a new blob. By default this method will not overwrite an existing blob.

Parameters:

data - The data to write to the blob. The data must be markable. This is in order to support retries. If the data is not markable, consider opening a BlobOutputStream and writing to the returned stream. Alternatively, consider wrapping your data source in a BufferedInputStream to add mark support.

length - The exact length of the data. It is important that this value match precisely the length of the data provided in the InputStream.

upload

public void upload(InputStream data, long length, boolean overwrite)

Creates a new blob, or updates the content of an existing blob.

Parameters:

data - The data to write to the blob. The data must be markable. This is in order to support retries. If the data is not markable, consider opening a BlobOutputStream and writing to the returned stream. Alternatively, consider wrapping your data source in a BufferedInputStream to add mark support.

length - The exact length of the data. It is important that this value match precisely the length of the data provided in the InputStream.

overwrite - Whether or not to overwrite, should data exist on the blob.

uploadFromFile

public void uploadFromFile(String filePath)

Creates a new block blob. By default this method will not overwrite an existing blob.

Code Samples

try {
     client.uploadFromFile(filePath);
     System.out.println("Upload from file succeeded");
 } catch (UncheckedIOException ex) {
     System.err.printf("Failed to upload from file %s%n", ex.getMessage());
 }

Parameters:

filePath - Path of the file to upload

uploadFromFile

public void uploadFromFile(String filePath, boolean overwrite)

Creates a new block blob, or updates the content of an existing block blob.

Code Samples

try {
     boolean overwrite = false;
     client.uploadFromFile(filePath, overwrite);
     System.out.println("Upload from file succeeded");
 } catch (UncheckedIOException ex) {
     System.err.printf("Failed to upload from file %s%n", ex.getMessage());
 }

Parameters:

filePath - Path of the file to upload

overwrite - Whether or not to overwrite, should the blob already exist

uploadFromFile

public void uploadFromFile(String filePath, ParallelTransferOptions parallelTransferOptions, BlobHttpHeaders headers, Map metadata, AccessTier tier, BlobRequestConditions requestConditions, Duration timeout)

Creates a new block blob, or updates the content of an existing block blob.

To avoid overwriting, pass "*" to setIfNoneMatch(String ifNoneMatch).

Code Samples

BlobHttpHeaders headers = new BlobHttpHeaders()
     .setContentMd5("data".getBytes(StandardCharsets.UTF_8))
     .setContentLanguage("en-US")
     .setContentType("binary");

 Map<String, String> metadata = Collections.singletonMap("metadata", "value");
 BlobRequestConditions requestConditions = new BlobRequestConditions()
     .setLeaseId(leaseId)
     .setIfUnmodifiedSince(OffsetDateTime.now().minusDays(3));
 Long blockSize = 100L * 1024L * 1024L; // 100 MB;
 ParallelTransferOptions parallelTransferOptions = new ParallelTransferOptions().setBlockSizeLong(blockSize);

 try {
     client.uploadFromFile(filePath, parallelTransferOptions, headers, metadata,
         AccessTier.HOT, requestConditions, timeout);
     System.out.println("Upload from file succeeded");
 } catch (UncheckedIOException ex) {
     System.err.printf("Failed to upload from file %s%n", ex.getMessage());
 }

Parameters:

filePath - Path of the file to upload

parallelTransferOptions - ParallelTransferOptions to use to upload from file. Number of parallel transfers parameter is ignored.

headers - BlobHttpHeaders

metadata - Metadata to associate with the blob. If there is leading or trailing whitespace in any metadata key or value, it must be removed or encoded.

tier - AccessTier for the uploaded blob

requestConditions - BlobRequestConditions

timeout - An optional timeout value beyond which a RuntimeException will be raised.

uploadFromFileWithResponse

public Response uploadFromFileWithResponse(BlobUploadFromFileOptions options, Duration timeout, Context context)

Creates a new block blob, or updates the content of an existing block blob.

To avoid overwriting, pass "*" to setIfNoneMatch(String ifNoneMatch).

Code Samples

BlobHttpHeaders headers = new BlobHttpHeaders()
     .setContentMd5("data".getBytes(StandardCharsets.UTF_8))
     .setContentLanguage("en-US")
     .setContentType("binary");

 Map<String, String> metadata = Collections.singletonMap("metadata", "value");
 Map<String, String> tags = Collections.singletonMap("tag", "value");
 BlobRequestConditions requestConditions = new BlobRequestConditions()
     .setLeaseId(leaseId)
     .setIfUnmodifiedSince(OffsetDateTime.now().minusDays(3));
 Long blockSize = 100 * 1024 * 1024L; // 100 MB;
 ParallelTransferOptions parallelTransferOptions = new ParallelTransferOptions().setBlockSizeLong(blockSize);

 try {
     client.uploadFromFileWithResponse(new BlobUploadFromFileOptions(filePath)
         .setParallelTransferOptions(parallelTransferOptions).setHeaders(headers).setMetadata(metadata)
         .setTags(tags).setTier(AccessTier.HOT).setRequestConditions(requestConditions), timeout,
         new Context(key2, value2));
     System.out.println("Upload from file succeeded");
 } catch (UncheckedIOException ex) {
     System.err.printf("Failed to upload from file %s%n", ex.getMessage());
 }

Parameters:

options - BlobUploadFromFileOptions

timeout - An optional timeout value beyond which a RuntimeException will be raised.

context - Additional context that is passed through the Http pipeline during the service call.

Returns:

Information about the uploaded block blob.

uploadWithResponse

@Deprecated
public Response uploadWithResponse(BlobParallelUploadOptions options, Context context)

Deprecated

Use uploadWithResponse(BlobParallelUploadOptions options, Duration timeout, Context context)

Creates a new blob, or updates the content of an existing blob.

To avoid overwriting, pass "*" to setIfNoneMatch(String ifNoneMatch).

Parameters:

options - BlobParallelUploadOptions

context - Additional context that is passed through the Http pipeline during the service call.

Returns:

Information about the uploaded block blob.

uploadWithResponse

public Response uploadWithResponse(BlobParallelUploadOptions options, Duration timeout, Context context)

Creates a new blob, or updates the content of an existing blob.

To avoid overwriting, pass "*" to setIfNoneMatch(String ifNoneMatch).

Parameters:

options - BlobParallelUploadOptions

timeout - An optional timeout value beyond which a RuntimeException will be raised.

context - Additional context that is passed through the Http pipeline during the service call.

Returns:

Information about the uploaded block blob.

uploadWithResponse

@Deprecated
public void uploadWithResponse(InputStream data, long length, ParallelTransferOptions parallelTransferOptions, BlobHttpHeaders headers, Map metadata, AccessTier tier, BlobRequestConditions requestConditions, Duration timeout, Context context)

Deprecated

See uploadWithResponse(BlobParallelUploadOptions options, Duration timeout, Context context) instead

Creates a new blob, or updates the content of an existing blob.

To avoid overwriting, pass "*" to setIfNoneMatch(String ifNoneMatch).

Parameters:

data - The data to write to the blob. The data must be markable. This is in order to support retries. If the data is not markable, consider opening a BlobOutputStream and writing to the returned stream. Alternatively, consider wrapping your data source in a BufferedInputStream to add mark support.

length - The exact length of the data. It is important that this value match precisely the length of the data provided in the InputStream.

parallelTransferOptions - ParallelTransferOptions used to configure buffered uploading.

headers - BlobHttpHeaders

metadata - Metadata to associate with the blob. If there is leading or trailing whitespace in any metadata key or value, it must be removed or encoded.

tier - AccessTier for the destination blob.

requestConditions - BlobRequestConditions

timeout - An optional timeout value beyond which a RuntimeException will be raised.

context - Additional context that is passed through the Http pipeline during the service call.