com.azure.storage.blob

Class BlobClient

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 downloading and 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.

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.

Constructor Summary

Constructors

Modifier	Constructor and 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 to this blob.
BlockBlobClient	getBlockBlobClient() Creates a new BlockBlobClient associated to this blob.
PageBlobClient	getPageBlobClient() Creates a new PageBlobClient associated to this blob.
BlobClient	getSnapshotClient(String snapshot) Creates a new BlobClient linked to the snapshot of this blob resource.
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 accessConditions, Duration timeout) Creates a new block blob, or updates the content of an existing block blob.

Methods inherited from class com.azure.storage.blob.specialized.BlobClientBase

abortCopyFromUrl, abortCopyFromUrlWithResponse, beginCopy, beginCopy, copyFromUrl, copyFromUrlWithResponse, createSnapshot, createSnapshotWithResponse, delete, deleteWithResponse, download, downloadToFile, downloadToFileWithResponse, downloadWithResponse, exists, existsWithResponse, getAccountInfo, getAccountInfoWithResponse, getAccountName, getBlobName, getBlobUrl, getContainerName, getCustomerProvidedKey, getHttpPipeline, getProperties, getPropertiesWithResponse, getServiceVersion, getSnapshotId, isSnapshot, openInputStream, openInputStream, setAccessTier, setAccessTierWithResponse, setHttpHeaders, setHttpHeadersWithResponse, setMetadata, setMetadataWithResponse, undelete, undeleteWithResponse

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BlobClient

protected BlobClient(BlobAsyncClient client)

Protected constructor for use by BlobClientBuilder.

Parameters:

client - the async blob client

Method Detail

getSnapshotClient

public BlobClient getSnapshotClient(String snapshot)

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

Overrides:

getSnapshotClient in class BlobClientBase

Parameters:

snapshot - the identifier for a specific snapshot of this blob

Returns:

a BlobClient used to interact with the specific snapshot.

getAppendBlobClient

public AppendBlobClient getAppendBlobClient()

Creates a new AppendBlobClient associated to this blob.

Returns:

a AppendBlobClient associated to this blob.

getBlockBlobClient

public BlockBlobClient getBlockBlobClient()

Creates a new BlockBlobClient associated to this blob.

Returns:

a BlockBlobClient associated to this blob.

getPageBlobClient

public PageBlobClient getPageBlobClient()

Creates a new PageBlobClient associated to this blob.

Returns:

a PageBlobClient associated to this 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

Throws:

UncheckedIOException - If an I/O error occurs

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

Throws:

UncheckedIOException - If an I/O error occurs

uploadFromFile

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

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

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 accessConditions = new BlobRequestConditions()
    .setLeaseId(leaseId)
    .setIfUnmodifiedSince(OffsetDateTime.now().minusDays(3));
Integer blockSize = 100 * 1024 * 1024; // 100 MB;
ParallelTransferOptions parallelTransferOptions = new ParallelTransferOptions(blockSize, null, null);

try {
    client.uploadFromFile(filePath, parallelTransferOptions, headers, metadata,
        AccessTier.HOT, accessConditions, 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.

tier - AccessTier for the uploaded blob

accessConditions - BlobRequestConditions

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

Throws:

UncheckedIOException - If an I/O error occurs