com.azure.storage.blob.specialized

Class BlobClientBase

java.lang.Object

com.azure.storage.blob.specialized.BlobClientBase

Direct Known Subclasses:

AppendBlobClient, BlobClient, BlockBlobClient, PageBlobClient

public class BlobClientBase
extends Object

This class provides a client that contains all operations that apply to any blob type.

This client offers the ability to download blobs. Note that uploading data is specific to each type of blob. Please refer to the BlockBlobClient, PageBlobClient, or AppendBlobClient for upload options.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BlobClientBase(BlobAsyncClientBase client) Constructor used by SpecializedBlobClientBuilder.

Method Summary

Modifier and Type	Method and Description
void	abortCopyFromUrl(String copyId) Stops a pending copy that was previously started and leaves a destination blob with 0 length and metadata.
com.azure.core.http.rest.Response<Void>	abortCopyFromUrlWithResponse(String copyId, String leaseId, Duration timeout, com.azure.core.util.Context context) Stops a pending copy that was previously started and leaves a destination blob with 0 length and metadata.
com.azure.core.util.polling.SyncPoller<BlobCopyInfo,Void>	beginCopy(String sourceUrl, Duration pollInterval) Copies the data at the source URL to a blob.
com.azure.core.util.polling.SyncPoller<BlobCopyInfo,Void>	beginCopy(String sourceUrl, Map<String,String> metadata, AccessTier tier, RehydratePriority priority, com.azure.core.http.RequestConditions sourceModifiedRequestConditions, BlobRequestConditions destRequestConditions, Duration pollInterval) Copies the data at the source URL to a blob.
String	copyFromUrl(String copySource) Copies the data at the source URL to a blob and waits for the copy to complete before returning a response.
com.azure.core.http.rest.Response<String>	copyFromUrlWithResponse(String copySource, Map<String,String> metadata, AccessTier tier, com.azure.core.http.RequestConditions sourceModifiedRequestConditions, BlobRequestConditions destRequestConditions, Duration timeout, com.azure.core.util.Context context) Copies the data at the source URL to a blob and waits for the copy to complete before returning a response.
BlobClientBase	createSnapshot() Creates a read-only snapshot of the blob.
com.azure.core.http.rest.Response<BlobClientBase>	createSnapshotWithResponse(Map<String,String> metadata, BlobRequestConditions requestConditions, Duration timeout, com.azure.core.util.Context context) Creates a read-only snapshot of the blob.
void	delete() Deletes the specified blob or snapshot.
com.azure.core.http.rest.Response<Void>	deleteWithResponse(DeleteSnapshotsOptionType deleteBlobSnapshotOptions, BlobRequestConditions requestConditions, Duration timeout, com.azure.core.util.Context context) Deletes the specified blob or snapshot.
void	download(OutputStream stream) Downloads the entire blob into an output stream.
BlobProperties	downloadToFile(String filePath) Downloads the entire blob into a file specified by the path.
BlobProperties	downloadToFile(String filePath, boolean overwrite) Downloads the entire blob into a file specified by the path.
com.azure.core.http.rest.Response<BlobProperties>	downloadToFileWithResponse(String filePath, BlobRange range, ParallelTransferOptions parallelTransferOptions, DownloadRetryOptions downloadRetryOptions, BlobRequestConditions requestConditions, boolean rangeGetContentMd5, Duration timeout, com.azure.core.util.Context context) Downloads the entire blob into a file specified by the path.
com.azure.core.http.rest.Response<BlobProperties>	downloadToFileWithResponse(String filePath, BlobRange range, ParallelTransferOptions parallelTransferOptions, DownloadRetryOptions downloadRetryOptions, BlobRequestConditions requestConditions, boolean rangeGetContentMd5, Set<OpenOption> openOptions, Duration timeout, com.azure.core.util.Context context) Downloads the entire blob into a file specified by the path.
BlobDownloadResponse	downloadWithResponse(OutputStream stream, BlobRange range, DownloadRetryOptions options, BlobRequestConditions requestConditions, boolean getRangeContentMd5, Duration timeout, com.azure.core.util.Context context) Downloads a range of bytes from a blob into an output stream.
Boolean	exists() Gets if the container this client represents exists in the cloud.
com.azure.core.http.rest.Response<Boolean>	existsWithResponse(Duration timeout, com.azure.core.util.Context context) Gets if the container this client represents exists in the cloud.
String	generateSas(BlobServiceSasSignatureValues blobServiceSasSignatureValues) Generates a service SAS for the blob using the specified BlobServiceSasSignatureValues Note : The client must be authenticated via StorageSharedKeyCredential
String	generateUserDelegationSas(BlobServiceSasSignatureValues blobServiceSasSignatureValues, UserDelegationKey userDelegationKey) Generates a user delegation SAS for the blob using the specified BlobServiceSasSignatureValues.
StorageAccountInfo	getAccountInfo() Returns the sku name and account kind for the account.
com.azure.core.http.rest.Response<StorageAccountInfo>	getAccountInfoWithResponse(Duration timeout, com.azure.core.util.Context context) Returns the sku name and account kind for the account.
String	getAccountName() Get associated account name.
String	getBlobName() Decodes and gets the blob name.
String	getBlobUrl() Gets the URL of the blob represented by this client.
String	getContainerName() Get the container name.
CpkInfo	getCustomerProvidedKey() Gets the CpkInfo used to encrypt this blob's content on the server.
com.azure.core.http.HttpPipeline	getHttpPipeline() Gets the HttpPipeline powering this client.
BlobProperties	getProperties() Returns the blob's metadata and properties.
com.azure.core.http.rest.Response<BlobProperties>	getPropertiesWithResponse(BlobRequestConditions requestConditions, Duration timeout, com.azure.core.util.Context context) Returns the blob's metadata and properties.
BlobServiceVersion	getServiceVersion() Gets the service version the client is using.
BlobClientBase	getSnapshotClient(String snapshot) Creates a new BlobClientBase linked to the snapshot of this blob resource.
String	getSnapshotId() Gets the snapshotId for a blob resource
boolean	isSnapshot() Determines if a blob is a snapshot
BlobInputStream	openInputStream() Opens a blob input stream to download the blob.
BlobInputStream	openInputStream(BlobRange range, BlobRequestConditions requestConditions) Opens a blob input stream to download the specified range of the blob.
void	setAccessTier(AccessTier tier) Sets the tier on a blob.
com.azure.core.http.rest.Response<Void>	setAccessTierWithResponse(AccessTier tier, RehydratePriority priority, String leaseId, Duration timeout, com.azure.core.util.Context context) Sets the tier on a blob.
void	setHttpHeaders(BlobHttpHeaders headers) Changes a blob's HTTP header properties.
com.azure.core.http.rest.Response<Void>	setHttpHeadersWithResponse(BlobHttpHeaders headers, BlobRequestConditions requestConditions, Duration timeout, com.azure.core.util.Context context) Changes a blob's HTTP header properties.
void	setMetadata(Map<String,String> metadata) Changes a blob's metadata.
com.azure.core.http.rest.Response<Void>	setMetadataWithResponse(Map<String,String> metadata, BlobRequestConditions requestConditions, Duration timeout, com.azure.core.util.Context context) Changes a blob's metadata.
void	undelete() Undelete restores the content and metadata of a soft-deleted blob and/or any associated soft-deleted snapshots.
com.azure.core.http.rest.Response<Void>	undeleteWithResponse(Duration timeout, com.azure.core.util.Context context) Undelete restores the content and metadata of a soft-deleted blob and/or any associated soft-deleted snapshots.

Methods inherited from class java.lang.Object

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

Constructor Detail

BlobClientBase

protected BlobClientBase(BlobAsyncClientBase client)

Constructor used by SpecializedBlobClientBuilder.

Parameters:

client - the async blob client

Method Detail

getSnapshotClient

public BlobClientBase getSnapshotClient(String snapshot)

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

Parameters:

snapshot - the identifier for a specific snapshot of this blob

Returns:

a BlobClientBase used to interact with the specific snapshot.

getBlobUrl

public String getBlobUrl()

Gets the URL of the blob represented by this client.

Returns:

the URL.

getAccountName

public String getAccountName()

Get associated account name.

Returns:

account name associated with this storage resource.

getContainerName

public final String getContainerName()

Get the container name.

Code Samples

String containerName = client.getContainerName();
System.out.println("The name of the blob is " + containerName);

Returns:

The name of the container.

getBlobName

public final String getBlobName()

Decodes and gets the blob name.

Code Samples

String blobName = client.getBlobName();
System.out.println("The name of the blob is " + blobName);

Returns:

The decoded name of the blob.

getHttpPipeline

public com.azure.core.http.HttpPipeline getHttpPipeline()

Gets the HttpPipeline powering this client.

Returns:

The pipeline.

getCustomerProvidedKey

public CpkInfo getCustomerProvidedKey()

Gets the CpkInfo used to encrypt this blob's content on the server.

Returns:

the customer provided key used for encryption.

getServiceVersion

public BlobServiceVersion getServiceVersion()

Gets the service version the client is using.

Returns:

the service version the client is using.

getSnapshotId

public String getSnapshotId()

Gets the snapshotId for a blob resource

Returns:

A string that represents the snapshotId of the snapshot blob

isSnapshot

public boolean isSnapshot()

Determines if a blob is a snapshot

Returns:

A boolean that indicates if a blob is a snapshot

openInputStream

public final BlobInputStream openInputStream()

Opens a blob input stream to download the blob.

Returns:

An InputStream object that represents the stream to use for reading from the blob.

Throws:

BlobStorageException - If a storage service error occurred.

openInputStream

public final BlobInputStream openInputStream(BlobRange range,
                                             BlobRequestConditions requestConditions)

Opens a blob input stream to download the specified range of the blob.

Parameters:

range - BlobRange

requestConditions - An BlobRequestConditions object that represents the access conditions for the blob.

Returns:

An InputStream object that represents the stream to use for reading from the blob.

Throws:

BlobStorageException - If a storage service error occurred.

exists

public Boolean exists()

Gets if the container this client represents exists in the cloud.

Code Samples

System.out.printf("Exists? %b%n", client.exists());

Returns:

true if the container exists, false if it doesn't

existsWithResponse

public com.azure.core.http.rest.Response<Boolean> existsWithResponse(Duration timeout,
                                                                     com.azure.core.util.Context context)

Gets if the container this client represents exists in the cloud.

Code Samples

System.out.printf("Exists? %b%n", client.existsWithResponse(timeout, new Context(key2, value2)).getValue());

Parameters:

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:

true if the container exists, false if it doesn't

beginCopy

public com.azure.core.util.polling.SyncPoller<BlobCopyInfo,Void> beginCopy(String sourceUrl,
                                                                           Duration pollInterval)

Copies the data at the source URL to a blob.

Code Samples

final SyncPoller<BlobCopyInfo, Void> poller = client.beginCopy(url, Duration.ofSeconds(2));
PollResponse<BlobCopyInfo> pollResponse = poller.poll();
System.out.printf("Copy identifier: %s%n", pollResponse.getValue().getCopyId());

For more information, see the Azure Docs

Parameters:

sourceUrl - The source URL to copy from. URLs outside of Azure may only be copied to block blobs.

pollInterval - Duration between each poll for the copy status. If none is specified, a default of one second is used.

Returns:

A SyncPoller to poll the progress of blob copy operation.

beginCopy

public com.azure.core.util.polling.SyncPoller<BlobCopyInfo,Void> beginCopy(String sourceUrl,
                                                                           Map<String,String> metadata,
                                                                           AccessTier tier,
                                                                           RehydratePriority priority,
                                                                           com.azure.core.http.RequestConditions sourceModifiedRequestConditions,
                                                                           BlobRequestConditions destRequestConditions,
                                                                           Duration pollInterval)

Copies the data at the source URL to a blob.

Code Samples

Map<String, String> metadata = Collections.singletonMap("metadata", "value");
RequestConditions modifiedRequestConditions = new RequestConditions()
    .setIfUnmodifiedSince(OffsetDateTime.now().minusDays(7));
BlobRequestConditions blobRequestConditions = new BlobRequestConditions().setLeaseId(leaseId);
SyncPoller<BlobCopyInfo, Void> poller = client.beginCopy(url, metadata, AccessTier.HOT,
    RehydratePriority.STANDARD, modifiedRequestConditions, blobRequestConditions, Duration.ofSeconds(2));

PollResponse<BlobCopyInfo> response = poller.waitUntil(LongRunningOperationStatus.SUCCESSFULLY_COMPLETED);
System.out.printf("Copy identifier: %s%n", response.getValue().getCopyId());

For more information, see the Azure Docs

Parameters:

sourceUrl - The source URL to copy from. URLs outside of Azure may only be copied to block blobs.

metadata - Metadata to associate with the destination blob.

tier - AccessTier for the destination blob.

priority - RehydratePriority for rehydrating the blob.

sourceModifiedRequestConditions - RequestConditions against the source. Standard HTTP Access conditions related to the modification of data. ETag and LastModifiedTime are used to construct conditions related to when the blob was changed relative to the given request. The request will fail if the specified condition is not satisfied.

destRequestConditions - BlobRequestConditions against the destination.

pollInterval - Duration between each poll for the copy status. If none is specified, a default of one second is used.

Returns:

A SyncPoller to poll the progress of blob copy operation.

abortCopyFromUrl

public void abortCopyFromUrl(String copyId)

Stops a pending copy that was previously started and leaves a destination blob with 0 length and metadata.

Code Samples

client.abortCopyFromUrl(copyId);
System.out.println("Aborted copy completed.");

For more information, see the Azure Docs

Parameters:

copyId - The id of the copy operation to abort.

abortCopyFromUrlWithResponse

public com.azure.core.http.rest.Response<Void> abortCopyFromUrlWithResponse(String copyId,
                                                                            String leaseId,
                                                                            Duration timeout,
                                                                            com.azure.core.util.Context context)

Stops a pending copy that was previously started and leaves a destination blob with 0 length and metadata.

Code Samples

System.out.printf("Aborted copy completed with status %d%n",
    client.abortCopyFromUrlWithResponse(copyId, leaseId, timeout,
        new Context(key2, value2)).getStatusCode());

For more information, see the Azure Docs

Parameters:

copyId - The id of the copy operation to abort.

leaseId - The lease ID the active lease on the blob must match.

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:

A response containing status code and HTTP headers.

copyFromUrl

public String copyFromUrl(String copySource)

Copies the data at the source URL to a blob and waits for the copy to complete before returning a response.

Code Samples

System.out.printf("Copy identifier: %s%n", client.copyFromUrl(url));

For more information, see the Azure Docs

Parameters:

copySource - The source URL to copy from.

Returns:

The copy ID for the long running operation.

Throws:

IllegalArgumentException - If copySource is a malformed URL.

copyFromUrlWithResponse

public com.azure.core.http.rest.Response<String> copyFromUrlWithResponse(String copySource,
                                                                         Map<String,String> metadata,
                                                                         AccessTier tier,
                                                                         com.azure.core.http.RequestConditions sourceModifiedRequestConditions,
                                                                         BlobRequestConditions destRequestConditions,
                                                                         Duration timeout,
                                                                         com.azure.core.util.Context context)

Copies the data at the source URL to a blob and waits for the copy to complete before returning a response.

Code Samples

Map<String, String> metadata = Collections.singletonMap("metadata", "value");
RequestConditions modifiedRequestConditions = new RequestConditions()
    .setIfUnmodifiedSince(OffsetDateTime.now().minusDays(7));
BlobRequestConditions blobRequestConditions = new BlobRequestConditions().setLeaseId(leaseId);

System.out.printf("Copy identifier: %s%n",
    client.copyFromUrlWithResponse(url, metadata, AccessTier.HOT, modifiedRequestConditions,
        blobRequestConditions, timeout,
        new Context(key1, value1)).getValue());

For more information, see the Azure Docs

Parameters:

copySource - The source URL to copy from. URLs outside of Azure may only be copied to block blobs.

metadata - Metadata to associate with the destination blob.

tier - AccessTier for the destination blob.

sourceModifiedRequestConditions - RequestConditions against the source. Standard HTTP Access conditions related to the modification of data. ETag and LastModifiedTime are used to construct conditions related to when the blob was changed relative to the given request. The request will fail if the specified condition is not satisfied.

destRequestConditions - BlobRequestConditions against the destination.

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:

The copy ID for the long running operation.

Throws:

IllegalArgumentException - If copySource is a malformed URL.

download

public void download(OutputStream stream)

Downloads the entire blob into an output stream. Uploading data must be done from the BlockBlobClient, PageBlobClient, or AppendBlobClient.

Code Samples

client.download(new ByteArrayOutputStream());
System.out.println("Download completed.");

For more information, see the Azure Docs

Parameters:

stream - A non-null OutputStream instance where the downloaded data will be written.

Throws:

UncheckedIOException - If an I/O error occurs.

NullPointerException - if stream is null

downloadWithResponse

public BlobDownloadResponse downloadWithResponse(OutputStream stream,
                                                 BlobRange range,
                                                 DownloadRetryOptions options,
                                                 BlobRequestConditions requestConditions,
                                                 boolean getRangeContentMd5,
                                                 Duration timeout,
                                                 com.azure.core.util.Context context)

Downloads a range of bytes from a blob into an output stream. Uploading data must be done from the BlockBlobClient, PageBlobClient, or AppendBlobClient.

Code Samples

BlobRange range = new BlobRange(1024, 2048L);
DownloadRetryOptions options = new DownloadRetryOptions().setMaxRetryRequests(5);

System.out.printf("Download completed with status %d%n",
    client.downloadWithResponse(new ByteArrayOutputStream(), range, options, null, false,
        timeout, new Context(key2, value2)).getStatusCode());

For more information, see the Azure Docs

Parameters:

stream - A non-null OutputStream instance where the downloaded data will be written.

range - BlobRange

options - DownloadRetryOptions

requestConditions - BlobRequestConditions

getRangeContentMd5 - Whether the contentMD5 for the specified blob range should be returned.

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:

A response containing status code and HTTP headers.

Throws:

UncheckedIOException - If an I/O error occurs.

NullPointerException - if stream is null

downloadToFile

public BlobProperties downloadToFile(String filePath)

Downloads the entire blob into a file specified by the path.

The file will be created and must not exist, if the file already exists a FileAlreadyExistsException will be thrown.

Code Samples

client.downloadToFile(file);
System.out.println("Completed download to file");

For more information, see the Azure Docs

Parameters:

filePath - A String representing the filePath where the downloaded data will be written.

Returns:

The blob properties and metadata.

Throws:

UncheckedIOException - If an I/O error occurs

downloadToFile

public BlobProperties downloadToFile(String filePath,
                                     boolean overwrite)

Downloads the entire blob into a file specified by the path.

If overwrite is set to false, the file will be created and must not exist, if the file already exists a FileAlreadyExistsException will be thrown.

Code Samples

boolean overwrite = false; // Default value
client.downloadToFile(file, overwrite);
System.out.println("Completed download to file");

For more information, see the Azure Docs

Parameters:

filePath - A String representing the filePath where the downloaded data will be written.

overwrite - Whether or not to overwrite the file, should the file exist.

Returns:

The blob properties and metadata.

Throws:

UncheckedIOException - If an I/O error occurs

downloadToFileWithResponse

public com.azure.core.http.rest.Response<BlobProperties> downloadToFileWithResponse(String filePath,
                                                                                    BlobRange range,
                                                                                    ParallelTransferOptions parallelTransferOptions,
                                                                                    DownloadRetryOptions downloadRetryOptions,
                                                                                    BlobRequestConditions requestConditions,
                                                                                    boolean rangeGetContentMd5,
                                                                                    Duration timeout,
                                                                                    com.azure.core.util.Context context)

Downloads the entire blob into a file specified by the path.

The file will be created and must not exist, if the file already exists a FileAlreadyExistsException will be thrown.

This method makes an extra HTTP call to get the length of the blob in the beginning. To avoid this extra call, provide the BlobRange parameter.

Code Samples

BlobRange range = new BlobRange(1024, 2048L);
DownloadRetryOptions options = new DownloadRetryOptions().setMaxRetryRequests(5);

client.downloadToFileWithResponse(file, range, new ParallelTransferOptions(4 * Constants.MB, null, null),
    options, null, false, timeout, new Context(key2, value2));
System.out.println("Completed download to file");

For more information, see the Azure Docs

Parameters:

filePath - A String representing the filePath where the downloaded data will be written.

range - BlobRange

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

downloadRetryOptions - DownloadRetryOptions

requestConditions - BlobRequestConditions

rangeGetContentMd5 - Whether the contentMD5 for the specified blob range should be returned.

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:

A response containing the blob properties and metadata.

Throws:

UncheckedIOException - If an I/O error occurs.

downloadToFileWithResponse

public com.azure.core.http.rest.Response<BlobProperties> downloadToFileWithResponse(String filePath,
                                                                                    BlobRange range,
                                                                                    ParallelTransferOptions parallelTransferOptions,
                                                                                    DownloadRetryOptions downloadRetryOptions,
                                                                                    BlobRequestConditions requestConditions,
                                                                                    boolean rangeGetContentMd5,
                                                                                    Set<OpenOption> openOptions,
                                                                                    Duration timeout,
                                                                                    com.azure.core.util.Context context)

Downloads the entire blob into a file specified by the path.

By default the file will be created and must not exist, if the file already exists a FileAlreadyExistsException will be thrown. To override this behavior, provide appropriate OpenOptions

This method makes an extra HTTP call to get the length of the blob in the beginning. To avoid this extra call, provide the BlobRange parameter.

Code Samples

BlobRange blobRange = new BlobRange(1024, 2048L);
DownloadRetryOptions downloadRetryOptions = new DownloadRetryOptions().setMaxRetryRequests(5);
Set<OpenOption> openOptions = new HashSet<>(Arrays.asList(StandardOpenOption.CREATE_NEW,
    StandardOpenOption.WRITE, StandardOpenOption.READ)); // Default options

client.downloadToFileWithResponse(file, blobRange, new ParallelTransferOptions(4 * Constants.MB, null, null),
    downloadRetryOptions, null, false, openOptions, timeout, new Context(key2, value2));
System.out.println("Completed download to file");

For more information, see the Azure Docs

Parameters:

filePath - A String representing the filePath where the downloaded data will be written.

range - BlobRange

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

downloadRetryOptions - DownloadRetryOptions

requestConditions - BlobRequestConditions

rangeGetContentMd5 - Whether the contentMD5 for the specified blob range should be returned.

openOptions - OpenOptions to use to configure how to open or create the file.

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:

A response containing the blob properties and metadata.

Throws:

UncheckedIOException - If an I/O error occurs.

delete

public void delete()

Deletes the specified blob or snapshot. Note that deleting a blob also deletes all its snapshots.

Code Samples

client.delete();
System.out.println("Delete completed.");

For more information, see the Azure Docs

deleteWithResponse

public com.azure.core.http.rest.Response<Void> deleteWithResponse(DeleteSnapshotsOptionType deleteBlobSnapshotOptions,
                                                                  BlobRequestConditions requestConditions,
                                                                  Duration timeout,
                                                                  com.azure.core.util.Context context)

Deletes the specified blob or snapshot. Note that deleting a blob also deletes all its snapshots.

Code Samples

System.out.printf("Delete completed with status %d%n",
    client.deleteWithResponse(DeleteSnapshotsOptionType.INCLUDE, null, timeout,
        new Context(key1, value1)).getStatusCode());

For more information, see the Azure Docs

Parameters:

deleteBlobSnapshotOptions - Specifies the behavior for deleting the snapshots on this blob. Include will delete the base blob and all snapshots. Only will delete only the snapshots. If a snapshot is being deleted, you must pass null.

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.

Returns:

A response containing status code and HTTP headers.

getProperties

public BlobProperties getProperties()

Returns the blob's metadata and properties.

Code Samples

BlobProperties properties = client.getProperties();
System.out.printf("Type: %s, Size: %d%n", properties.getBlobType(), properties.getBlobSize());

For more information, see the Azure Docs

Returns:

The blob properties and metadata.

getPropertiesWithResponse

public com.azure.core.http.rest.Response<BlobProperties> getPropertiesWithResponse(BlobRequestConditions requestConditions,
                                                                                   Duration timeout,
                                                                                   com.azure.core.util.Context context)

Returns the blob's metadata and properties.

Code Samples

BlobRequestConditions requestConditions = new BlobRequestConditions().setLeaseId(leaseId);

BlobProperties properties = client.getPropertiesWithResponse(requestConditions, timeout,
    new Context(key2, value2)).getValue();
System.out.printf("Type: %s, Size: %d%n", properties.getBlobType(), properties.getBlobSize());

For more information, see the Azure Docs

Parameters:

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.

Returns:

The blob properties and metadata.

setHttpHeaders

public void setHttpHeaders(BlobHttpHeaders headers)

Changes a blob's HTTP header properties. if only one HTTP header is updated, the others will all be erased. In order to preserve existing values, they must be passed alongside the header being changed.

Code Samples

client.setHttpHeaders(new BlobHttpHeaders()
    .setContentLanguage("en-US")
    .setContentType("binary"));
System.out.println("Set HTTP headers completed");

For more information, see the Azure Docs

Parameters:

headers - BlobHttpHeaders

setHttpHeadersWithResponse

public com.azure.core.http.rest.Response<Void> setHttpHeadersWithResponse(BlobHttpHeaders headers,
                                                                          BlobRequestConditions requestConditions,
                                                                          Duration timeout,
                                                                          com.azure.core.util.Context context)

Changes a blob's HTTP header properties. if only one HTTP header is updated, the others will all be erased. In order to preserve existing values, they must be passed alongside the header being changed.

Code Samples

BlobRequestConditions requestConditions = new BlobRequestConditions().setLeaseId(leaseId);

System.out.printf("Set HTTP headers completed with status %d%n",
    client.setHttpHeadersWithResponse(new BlobHttpHeaders()
        .setContentLanguage("en-US")
        .setContentType("binary"), requestConditions, timeout, new Context(key1, value1))
        .getStatusCode());

For more information, see the Azure Docs

Parameters:

headers - BlobHttpHeaders

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.

Returns:

A response containing status code and HTTP headers.

setMetadata

public void setMetadata(Map<String,String> metadata)

Changes a blob's metadata. The specified metadata in this method will replace existing metadata. If old values must be preserved, they must be downloaded and included in the call to this method.

Code Samples

client.setMetadata(Collections.singletonMap("metadata", "value"));
System.out.println("Set metadata completed");

For more information, see the Azure Docs

Parameters:

metadata - Metadata to associate with the blob.

setMetadataWithResponse

public com.azure.core.http.rest.Response<Void> setMetadataWithResponse(Map<String,String> metadata,
                                                                       BlobRequestConditions requestConditions,
                                                                       Duration timeout,
                                                                       com.azure.core.util.Context context)

Changes a blob's metadata. The specified metadata in this method will replace existing metadata. If old values must be preserved, they must be downloaded and included in the call to this method.

Code Samples

BlobRequestConditions requestConditions = new BlobRequestConditions().setLeaseId(leaseId);

System.out.printf("Set metadata completed with status %d%n",
    client.setMetadataWithResponse(Collections.singletonMap("metadata", "value"), requestConditions, timeout,
        new Context(key1, value1)).getStatusCode());

For more information, see the Azure Docs

Parameters:

metadata - Metadata to associate with the 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.

Returns:

A response containing status code and HTTP headers.

createSnapshot

public BlobClientBase createSnapshot()

Creates a read-only snapshot of the blob.

Code Samples

System.out.printf("Identifier for the snapshot is %s%n", client.createSnapshot().getSnapshotId());

For more information, see the Azure Docs

Returns:

A response containing a BlobClient which is used to interact with the created snapshot, use BlobClientBase.getSnapshotId() to get the identifier for the snapshot.

createSnapshotWithResponse

public com.azure.core.http.rest.Response<BlobClientBase> createSnapshotWithResponse(Map<String,String> metadata,
                                                                                    BlobRequestConditions requestConditions,
                                                                                    Duration timeout,
                                                                                    com.azure.core.util.Context context)

Creates a read-only snapshot of the blob.

Code Samples

Map<String, String> snapshotMetadata = Collections.singletonMap("metadata", "value");
BlobRequestConditions requestConditions = new BlobRequestConditions().setLeaseId(leaseId);

System.out.printf("Identifier for the snapshot is %s%n",
    client.createSnapshotWithResponse(snapshotMetadata, requestConditions, timeout,
        new Context(key1, value1)).getValue());

For more information, see the Azure Docs

Parameters:

metadata - Metadata to associate with the blob snapshot.

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.

Returns:

A response containing a BlobClient which is used to interact with the created snapshot, use BlobClientBase.getSnapshotId() to get the identifier for the snapshot.

setAccessTier

public void setAccessTier(AccessTier tier)

Sets the tier on a blob. The operation is allowed on a page blob in a premium storage account or a block blob in a blob storage or GPV2 account. A premium page blob's tier determines the allowed size, IOPS, and bandwidth of the blob. A block blob's tier determines the Hot/Cool/Archive storage type. This does not update the blob's etag.

Code Samples

client.setAccessTier(AccessTier.HOT);
System.out.println("Set tier completed.");

For more information, see the Azure Docs

Parameters:

tier - The new tier for the blob.

setAccessTierWithResponse

public com.azure.core.http.rest.Response<Void> setAccessTierWithResponse(AccessTier tier,
                                                                         RehydratePriority priority,
                                                                         String leaseId,
                                                                         Duration timeout,
                                                                         com.azure.core.util.Context context)

Sets the tier on a blob. The operation is allowed on a page blob in a premium storage account or a block blob in a blob storage or GPV2 account. A premium page blob's tier determines the allowed size, IOPS, and bandwidth of the blob. A block blob's tier determines the Hot/Cool/Archive storage type. This does not update the blob's etag.

Code Samples

System.out.printf("Set tier completed with status code %d%n",
    client.setAccessTierWithResponse(AccessTier.HOT, RehydratePriority.STANDARD, leaseId, timeout,
        new Context(key2, value2)).getStatusCode());

For more information, see the Azure Docs

Parameters:

tier - The new tier for the blob.

priority - Optional priority to set for re-hydrating blobs.

leaseId - The lease ID the active lease on the blob must match.

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:

A response containing status code and HTTP headers.

undelete

public void undelete()

Undelete restores the content and metadata of a soft-deleted blob and/or any associated soft-deleted snapshots.

Code Samples

client.undelete();
System.out.println("Undelete completed");

For more information, see the Azure Docs

undeleteWithResponse

public com.azure.core.http.rest.Response<Void> undeleteWithResponse(Duration timeout,
                                                                    com.azure.core.util.Context context)

Undelete restores the content and metadata of a soft-deleted blob and/or any associated soft-deleted snapshots.

Code Samples

System.out.printf("Undelete completed with status %d%n", client.undeleteWithResponse(timeout,
    new Context(key1, value1)).getStatusCode());

For more information, see the Azure Docs

Parameters:

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:

A response containing status code and HTTP headers.

getAccountInfo

public StorageAccountInfo getAccountInfo()

Returns the sku name and account kind for the account.

Code Samples

StorageAccountInfo accountInfo = client.getAccountInfo();
System.out.printf("Account Kind: %s, SKU: %s%n", accountInfo.getAccountKind(), accountInfo.getSkuName());

For more information, see the Azure Docs

Returns:

The sku name and account kind.

getAccountInfoWithResponse

public com.azure.core.http.rest.Response<StorageAccountInfo> getAccountInfoWithResponse(Duration timeout,
                                                                                        com.azure.core.util.Context context)

Returns the sku name and account kind for the account.

Code Samples

StorageAccountInfo accountInfo = client.getAccountInfoWithResponse(timeout, new Context(key1, value1)).getValue();
System.out.printf("Account Kind: %s, SKU: %s%n", accountInfo.getAccountKind(), accountInfo.getSkuName());

For more information, see the Azure Docs

Parameters:

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:

The sku name and account kind.

generateUserDelegationSas

public String generateUserDelegationSas(BlobServiceSasSignatureValues blobServiceSasSignatureValues,
                                        UserDelegationKey userDelegationKey)

Generates a user delegation SAS for the blob using the specified BlobServiceSasSignatureValues.

See BlobServiceSasSignatureValues for more information on how to construct a user delegation SAS.

Code Samples

OffsetDateTime myExpiryTime = OffsetDateTime.now().plusDays(1);
BlobSasPermission myPermission = new BlobSasPermission().setReadPermission(true);

BlobServiceSasSignatureValues myValues = new BlobServiceSasSignatureValues(expiryTime, permission)
    .setStartTime(OffsetDateTime.now());

client.generateUserDelegationSas(values, userDelegationKey);

Parameters:

blobServiceSasSignatureValues - BlobServiceSasSignatureValues

userDelegationKey - A UserDelegationKey object used to sign the SAS values.

Returns:

A String representing all SAS query parameters.

See Also:

for more information on how to get a user delegation key.

generateSas

public String generateSas(BlobServiceSasSignatureValues blobServiceSasSignatureValues)

Generates a service SAS for the blob using the specified BlobServiceSasSignatureValues Note : The client must be authenticated via StorageSharedKeyCredential

See BlobServiceSasSignatureValues for more information on how to construct a service SAS.

Code Samples

OffsetDateTime expiryTime = OffsetDateTime.now().plusDays(1);
BlobSasPermission permission = new BlobSasPermission().setReadPermission(true);

BlobServiceSasSignatureValues values = new BlobServiceSasSignatureValues(expiryTime, permission)
    .setStartTime(OffsetDateTime.now());

client.generateSas(values); // Client must be authenticated via StorageSharedKeyCredential

Parameters:

blobServiceSasSignatureValues - BlobServiceSasSignatureValues

Returns:

A String representing all SAS query parameters.