BlobBatchAsyncClient Class

Package:

com.azure.storage.blob.batch

Maven Artifact:

com.azure:azure-storage-blob-batch:12.31.0-beta.1

• java.lang.Object
• • com.azure.storage.blob.batch.BlobBatchAsyncClient

public final class BlobBatchAsyncClient

This class provides a client that contains all operations that apply to Azure Storage Blob batching.

This client offers the ability to delete and set access tier on multiple blobs at once and to submit a BlobBatch.

Method Summary

Modifier and Type	Method and Description
PagedFlux<Response<Void>>	deleteBlobs(List<String> blobUrls, DeleteSnapshotsOptionType deleteOptions) Delete multiple blobs in a single request to the service.
BlobBatch	getBlobBatch() Gets a BlobBatch used to configure a batching operation to send to Azure Storage blobs.
PagedFlux<Response<Void>>	setBlobsAccessTier(List<String> blobUrls, AccessTier accessTier) Set access tier on multiple blobs in a single request to the service.
Mono<Void>	submitBatch(BlobBatch batch) Submits a batch operation.
Mono<Response<Void>>	submitBatchWithResponse(BlobBatch batch, boolean throwOnAnyFailure) Submits a batch operation.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

deleteBlobs

public PagedFlux<Response<Void>> deleteBlobs(List<String> blobUrls, DeleteSnapshotsOptionType deleteOptions)

Delete multiple blobs in a single request to the service.

Code samples

List<String> blobUrls = new ArrayList<>();
 blobUrls.add(blobClient1.getBlobUrl());
 blobUrls.add(blobClient2.getBlobUrl());
 blobUrls.add(blobClient3.getBlobUrl());

 batchAsyncClient.deleteBlobs(blobUrls, DeleteSnapshotsOptionType.INCLUDE).subscribe(response ->
         System.out.printf("Deleting blob with URL %s completed with status code %d%n",
             response.getRequest().getUrl(), response.getStatusCode()),
     error -> System.err.printf("Deleting blob failed with exception: %s%n", error.getMessage()));

Parameters:

blobUrls - Urls of the blobs to delete. Blob names must be encoded to UTF-8.

deleteOptions - The deletion option for all blobs.

Returns:

The status of each delete operation.

getBlobBatch

public BlobBatch getBlobBatch()

Gets a BlobBatch used to configure a batching operation to send to Azure Storage blobs.

Returns:

a new BlobBatch instance.

setBlobsAccessTier

public PagedFlux<Response<Void>> setBlobsAccessTier(List<String> blobUrls, AccessTier accessTier)

Set access tier on multiple blobs in a single request to the service.

Code samples

List<String> blobUrls = new ArrayList<>();
 blobUrls.add(blobClient1.getBlobUrl());
 blobUrls.add(blobClient2.getBlobUrl());
 blobUrls.add(blobClient3.getBlobUrl());

 batchAsyncClient.setBlobsAccessTier(blobUrls, AccessTier.HOT).subscribe(response ->
         System.out.printf("Setting blob access tier with URL %s completed with status code %d%n",
             response.getRequest().getUrl(), response.getStatusCode()),
     error -> System.err.printf("Setting blob access tier failed with exception: %s%n", error.getMessage()));

Parameters:

blobUrls - Urls of the blobs to set their access tier. Blob names must be encoded to UTF-8.

accessTier - AccessTier to set on each blob.

Returns:

The status of each set tier operation.

submitBatch

public Mono<Void> submitBatch(BlobBatch batch)

Submits a batch operation.

If any request in a batch fails this will throw a BlobStorageException.

Code samples

BlobBatch batch = batchAsyncClient.getBlobBatch();

 Response<Void> deleteResponse1 = batch.deleteBlob("container", "blob1");
 Response<Void> deleteResponse2 = batch.deleteBlob("container", "blob2", DeleteSnapshotsOptionType.INCLUDE,
     new BlobRequestConditions().setLeaseId("leaseId"));

 batchAsyncClient.submitBatch(batch).subscribe(response -> {
     System.out.println("Batch submission completed successfully.");
     System.out.printf("Delete operation 1 completed with status code: %d%n", deleteResponse1.getStatusCode());
     System.out.printf("Delete operation 2 completed with status code: %d%n", deleteResponse2.getStatusCode());
 }, error -> System.err.printf("Batch submission failed. Error message: %s%n", error.getMessage()));

Parameters:

batch - Batch to submit.

Returns:

An empty response indicating that the batch operation has completed.

submitBatchWithResponse

public Mono<Response<Void>> submitBatchWithResponse(BlobBatch batch, boolean throwOnAnyFailure)

Submits a batch operation.

If throwOnAnyFailure is true a BlobStorageException will be thrown if any request fails.

Code samples

BlobBatch batch = batchAsyncClient.getBlobBatch();

 Response<Void> deleteResponse1 = batch.deleteBlob("container", "blob1");
 Response<Void> deleteResponse2 = batch.deleteBlob("container", "blob2", DeleteSnapshotsOptionType.INCLUDE,
     new BlobRequestConditions().setLeaseId("leaseId"));

 batchAsyncClient.submitBatchWithResponse(batch, true).subscribe(response -> {
     System.out.printf("Batch submission completed with status code: %d%n", response.getStatusCode());
     System.out.printf("Delete operation 1 completed with status code: %d%n", deleteResponse1.getStatusCode());
     System.out.printf("Delete operation 2 completed with status code: %d%n", deleteResponse2.getStatusCode());
 }, error -> System.err.printf("Batch submission failed. Error message: %s%n", error.getMessage()));

Parameters:

batch - Batch to submit.

throwOnAnyFailure - Flag to indicate if an exception should be thrown if any request in the batch fails.

Returns:

A response only containing header and status code information, used to indicate that the batch operation has completed.