com.azure.storage.blob

Class PageBlobAsyncClient

java.lang.Object

com.azure.storage.blob.BlobAsyncClient

com.azure.storage.blob.PageBlobAsyncClient

public final class PageBlobAsyncClient
extends BlobAsyncClient

Client to a page blob. It may only be instantiated through a BlobClientBuilder, via the method BlobAsyncClient.asPageBlobAsyncClient(), or via the method ContainerAsyncClient.getPageBlobAsyncClient(String). This class does not hold any state about a particular blob, but is instead a convenient way of sending appropriate requests to the resource on the service.

This client contains operations on a blob. Operations on a container are available on ContainerAsyncClient, and operations on the service are available on BlobServiceAsyncClient.

Please refer to the Azure Docs for more information.

Note this client is an async client that returns reactive responses from Spring Reactor Core project (https://projectreactor.io/). Calling the methods in this client will NOT start the actual network operation, until .subscribe() is called on the reactive response. You can simply convert one of these responses to a CompletableFuture object through Mono.toFuture().

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_PUT_PAGES_BYTES Indicates the maximum number of bytes that may be sent in a call to putPage.
static int	PAGE_BYTES Indicates the number of bytes in a page.

Fields inherited from class com.azure.storage.blob.BlobAsyncClient

cpk, snapshot

Method Summary

Modifier and Type	Method and Description
reactor.core.publisher.Mono<PageBlobItem>	clearPages(PageRange pageRange) Frees the specified pages from the page blob.
reactor.core.publisher.Mono<Response<PageBlobItem>>	clearPagesWithResponse(PageRange pageRange, PageBlobAccessConditions pageBlobAccessConditions) Frees the specified pages from the page blob.
reactor.core.publisher.Mono<CopyStatusType>	copyIncremental(URL source, String snapshot) Begins an operation to start an incremental copy from one page blob's snapshot to this page blob.
reactor.core.publisher.Mono<Response<CopyStatusType>>	copyIncrementalWithResponse(URL source, String snapshot, ModifiedAccessConditions modifiedAccessConditions) Begins an operation to start an incremental copy from one page blob's snapshot to this page blob.
reactor.core.publisher.Mono<Response<PageBlobItem>>	createWithResponse(long size, Long sequenceNumber, BlobHTTPHeaders headers, Metadata metadata, BlobAccessConditions accessConditions) Creates a page blob of the specified length.
reactor.core.publisher.Mono<PageList>	getPageRanges(BlobRange blobRange) Returns the list of valid page ranges for a page blob or snapshot of a page blob.
reactor.core.publisher.Mono<PageList>	getPageRangesDiff(BlobRange blobRange, String prevSnapshot) Gets the collection of page ranges that differ between a specified snapshot and this page blob.
reactor.core.publisher.Mono<Response<PageList>>	getPageRangesDiffWithResponse(BlobRange blobRange, String prevSnapshot, BlobAccessConditions accessConditions) Gets the collection of page ranges that differ between a specified snapshot and this page blob.
reactor.core.publisher.Mono<Response<PageList>>	getPageRangesWithResponse(BlobRange blobRange, BlobAccessConditions accessConditions) Returns the list of valid page ranges for a page blob or snapshot of a page blob.
reactor.core.publisher.Mono<PageBlobItem>	resize(long size) Resizes the page blob to the specified size (which must be a multiple of 512).
reactor.core.publisher.Mono<Response<PageBlobItem>>	resizeWithResponse(long size, BlobAccessConditions accessConditions) Resizes the page blob to the specified size (which must be a multiple of 512).
reactor.core.publisher.Mono<PageBlobItem>	setCreate(long size) Creates a page blob of the specified length.
reactor.core.publisher.Mono<PageBlobItem>	updateSequenceNumber(SequenceNumberActionType action, Long sequenceNumber) Sets the page blob's sequence number.
reactor.core.publisher.Mono<Response<PageBlobItem>>	updateSequenceNumberWithResponse(SequenceNumberActionType action, Long sequenceNumber, BlobAccessConditions accessConditions) Sets the page blob's sequence number.
reactor.core.publisher.Mono<PageBlobItem>	uploadPages(PageRange pageRange, reactor.core.publisher.Flux<ByteBuffer> body) Writes 1 or more pages to the page blob.
reactor.core.publisher.Mono<PageBlobItem>	uploadPagesFromURL(PageRange range, URL sourceURL, Long sourceOffset) Writes 1 or more pages from the source page blob to this page blob.
reactor.core.publisher.Mono<Response<PageBlobItem>>	uploadPagesFromURLWithResponse(PageRange range, URL sourceURL, Long sourceOffset, byte[] sourceContentMD5, PageBlobAccessConditions destAccessConditions, SourceModifiedAccessConditions sourceAccessConditions) Writes 1 or more pages from the source page blob to this page blob.
reactor.core.publisher.Mono<Response<PageBlobItem>>	uploadPagesWithResponse(PageRange pageRange, reactor.core.publisher.Flux<ByteBuffer> body, PageBlobAccessConditions pageBlobAccessConditions) Writes 1 or more pages to the page blob.

Methods inherited from class com.azure.storage.blob.BlobAsyncClient

abortCopyFromURL, abortCopyFromURLWithResponse, asAppendBlobAsyncClient, asBlockBlobAsyncClient, asPageBlobAsyncClient, copyFromURL, copyFromURLWithResponse, createSnapshot, createSnapshotWithResponse, delete, deleteWithResponse, download, downloadToFile, downloadToFile, downloadWithResponse, exists, existsWithResponse, generateSAS, generateSAS, generateSAS, generateSAS, generateUserDelegationSAS, generateUserDelegationSAS, generateUserDelegationSAS, getAccountInfo, getAccountInfoWithResponse, getBlobUrl, getContainerAsyncClient, getHttpPipeline, getProperties, getPropertiesWithResponse, getSnapshotClient, getSnapshotId, isSnapshot, setHTTPHeaders, setHTTPHeadersWithResponse, setMetadata, setMetadataWithResponse, setTier, setTierWithResponse, startCopyFromURL, startCopyFromURLWithResponse, undelete, undeleteWithResponse

Methods inherited from class java.lang.Object

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

Field Detail

PAGE_BYTES

public static final int PAGE_BYTES

Indicates the number of bytes in a page.

See Also:

Constant Field Values

MAX_PUT_PAGES_BYTES

public static final int MAX_PUT_PAGES_BYTES

Indicates the maximum number of bytes that may be sent in a call to putPage.

See Also:

Constant Field Values

Method Detail

setCreate

public reactor.core.publisher.Mono<PageBlobItem> setCreate(long size)

Creates a page blob of the specified length. Call PutPage to upload data data to a page blob. For more information, see the Azure Docs.

Parameters:

size - Specifies the maximum size for the page blob, up to 8 TB. The page blob size must be aligned to a 512-byte boundary.

Returns:

A reactive response containing the information of the created page blob.

createWithResponse

public reactor.core.publisher.Mono<Response<PageBlobItem>> createWithResponse(long size,
                                                                              Long sequenceNumber,
                                                                              BlobHTTPHeaders headers,
                                                                              Metadata metadata,
                                                                              BlobAccessConditions accessConditions)

Creates a page blob of the specified length. Call PutPage to upload data data to a page blob. For more information, see the Azure Docs.

Parameters:

size - Specifies the maximum size for the page blob, up to 8 TB. The page blob size must be aligned to a 512-byte boundary.

sequenceNumber - A user-controlled value that you can use to track requests. The value of the sequence number must be between 0 and 2^63 - 1.The default value is 0.

headers - BlobHTTPHeaders

metadata - Metadata

accessConditions - BlobAccessConditions

Returns:

A reactive response containing the information of the created page blob.

Throws:

IllegalArgumentException - If size isn't a multiple of PageBlobAsyncClient.PAGE_BYTES or sequenceNumber isn't null and is less than 0.

uploadPages

public reactor.core.publisher.Mono<PageBlobItem> uploadPages(PageRange pageRange,
                                                             reactor.core.publisher.Flux<ByteBuffer> body)

Writes 1 or more pages to the page blob. The start and end offsets must be a multiple of 512. For more information, see the Azure Docs.

Note that the data passed must be replayable if retries are enabled (the default). In other words, the Flux must produce the same data each time it is subscribed to.

Parameters:

pageRange - A PageRange object. Given that pages must be aligned with 512-byte boundaries, the start offset must be a modulus of 512 and the end offset must be a modulus of 512 - 1. Examples of valid byte ranges are 0-511, 512-1023, etc.

body - The data to upload. Note that this Flux must be replayable if retries are enabled (the default). In other words, the Flowable must produce the same data each time it is subscribed to.

Returns:

A reactive response containing the information of the uploaded pages.

uploadPagesWithResponse

public reactor.core.publisher.Mono<Response<PageBlobItem>> uploadPagesWithResponse(PageRange pageRange,
                                                                                   reactor.core.publisher.Flux<ByteBuffer> body,
                                                                                   PageBlobAccessConditions pageBlobAccessConditions)

Writes 1 or more pages to the page blob. The start and end offsets must be a multiple of 512. For more information, see the Azure Docs.

Note that the data passed must be replayable if retries are enabled (the default). In other words, the Flux must produce the same data each time it is subscribed to.

Parameters:

pageRange - A PageRange object. Given that pages must be aligned with 512-byte boundaries, the start offset must be a modulus of 512 and the end offset must be a modulus of 512 - 1. Examples of valid byte ranges are 0-511, 512-1023, etc.

body - The data to upload. Note that this Flux must be replayable if retries are enabled (the default). In other words, the Flowable must produce the same data each time it is subscribed to.

pageBlobAccessConditions - PageBlobAccessConditions

Returns:

A reactive response containing the information of the uploaded pages.

Throws:

IllegalArgumentException - If pageRange is null

uploadPagesFromURL

public reactor.core.publisher.Mono<PageBlobItem> uploadPagesFromURL(PageRange range,
                                                                    URL sourceURL,
                                                                    Long sourceOffset)

Writes 1 or more pages from the source page blob to this page blob. The start and end offsets must be a multiple of 512. For more information, see the Azure Docs.

Parameters:

range - A PageRange object. Given that pages must be aligned with 512-byte boundaries, the start offset must be a modulus of 512 and the end offset must be a modulus of 512 - 1. Examples of valid byte ranges are 0-511, 512-1023, etc.

sourceURL - The url to the blob that will be the source of the copy. A source blob in the same storage account can be authenticated via Shared Key. However, if the source is a blob in another account, the source blob must either be public or must be authenticated via a shared access signature. If the source blob is public, no authentication is required to perform the operation.

sourceOffset - The source offset to copy from. Pass null or 0 to copy from the beginning of source page blob.

Returns:

A reactive response containing the information of the uploaded pages.

uploadPagesFromURLWithResponse

public reactor.core.publisher.Mono<Response<PageBlobItem>> uploadPagesFromURLWithResponse(PageRange range,
                                                                                          URL sourceURL,
                                                                                          Long sourceOffset,
                                                                                          byte[] sourceContentMD5,
                                                                                          PageBlobAccessConditions destAccessConditions,
                                                                                          SourceModifiedAccessConditions sourceAccessConditions)

Writes 1 or more pages from the source page blob to this page blob. The start and end offsets must be a multiple of 512. For more information, see the Azure Docs.

Parameters:

range - The destination PageRange range. Given that pages must be aligned with 512-byte boundaries, the start offset must be a modulus of 512 and the end offset must be a modulus of 512 - 1. Examples of valid byte ranges are 0-511, 512-1023, etc.

sourceURL - The url to the blob that will be the source of the copy. A source blob in the same storage account can be authenticated via Shared Key. However, if the source is a blob in another account, the source blob must either be public or must be authenticated via a shared access signature. If the source blob is public, no authentication is required to perform the operation.

sourceOffset - The source offset to copy from. Pass null or 0 to copy from the beginning of source blob.

sourceContentMD5 - An MD5 hash of the block content from the source blob. If specified, the service will calculate the MD5 of the received data and fail the request if it does not match the provided MD5.

destAccessConditions - PageBlobAccessConditions

sourceAccessConditions - SourceModifiedAccessConditions

Returns:

A reactive response containing the information of the uploaded pages.

Throws:

IllegalArgumentException - If range is null

clearPages

public reactor.core.publisher.Mono<PageBlobItem> clearPages(PageRange pageRange)

Frees the specified pages from the page blob. For more information, see the Azure Docs.

Parameters:

pageRange - A PageRange object. Given that pages must be aligned with 512-byte boundaries, the start offset must be a modulus of 512 and the end offset must be a modulus of 512 - 1. Examples of valid byte ranges are 0-511, 512-1023, etc.

Returns:

A reactive response containing the information of the cleared pages.

clearPagesWithResponse

public reactor.core.publisher.Mono<Response<PageBlobItem>> clearPagesWithResponse(PageRange pageRange,
                                                                                  PageBlobAccessConditions pageBlobAccessConditions)

Frees the specified pages from the page blob. For more information, see the Azure Docs.

Parameters:

pageRange - A PageRange object. Given that pages must be aligned with 512-byte boundaries, the start offset must be a modulus of 512 and the end offset must be a modulus of 512 - 1. Examples of valid byte ranges are 0-511, 512-1023, etc.

pageBlobAccessConditions - PageBlobAccessConditions

Returns:

A reactive response containing the information of the cleared pages.

Throws:

IllegalArgumentException - If pageRange is null

getPageRanges

public reactor.core.publisher.Mono<PageList> getPageRanges(BlobRange blobRange)

Returns the list of valid page ranges for a page blob or snapshot of a page blob. For more information, see the Azure Docs.

Parameters:

blobRange - BlobRange

Returns:

A reactive response containing the information of the cleared pages.

getPageRangesWithResponse

public reactor.core.publisher.Mono<Response<PageList>> getPageRangesWithResponse(BlobRange blobRange,
                                                                                 BlobAccessConditions accessConditions)

Returns the list of valid page ranges for a page blob or snapshot of a page blob. For more information, see the Azure Docs.

Parameters:

blobRange - BlobRange

accessConditions - BlobAccessConditions

Returns:

A reactive response emitting all the page ranges.

getPageRangesDiff

public reactor.core.publisher.Mono<PageList> getPageRangesDiff(BlobRange blobRange,
                                                               String prevSnapshot)

Gets the collection of page ranges that differ between a specified snapshot and this page blob. For more information, see the Azure Docs.

Parameters:

blobRange - BlobRange

prevSnapshot - Specifies that the response will contain only pages that were changed between target blob and previous snapshot. Changed pages include both updated and cleared pages. The target blob may be a snapshot, as long as the snapshot specified by prevsnapshot is the older of the two.

Returns:

A reactive response emitting all the different page ranges.

getPageRangesDiffWithResponse

public reactor.core.publisher.Mono<Response<PageList>> getPageRangesDiffWithResponse(BlobRange blobRange,
                                                                                     String prevSnapshot,
                                                                                     BlobAccessConditions accessConditions)

Gets the collection of page ranges that differ between a specified snapshot and this page blob. For more information, see the Azure Docs.

Parameters:

blobRange - BlobRange

prevSnapshot - Specifies that the response will contain only pages that were changed between target blob and previous snapshot. Changed pages include both updated and cleared pages. The target blob may be a snapshot, as long as the snapshot specified by prevsnapshot is the older of the two.

accessConditions - BlobAccessConditions

Returns:

A reactive response emitting all the different page ranges.

Throws:

IllegalArgumentException - If prevSnapshot is null

resize

public reactor.core.publisher.Mono<PageBlobItem> resize(long size)

Resizes the page blob to the specified size (which must be a multiple of 512). For more information, see the Azure Docs.

Parameters:

size - Resizes a page blob to the specified size. If the specified value is less than the current size of the blob, then all pages above the specified value are cleared.

Returns:

A reactive response emitting the resized page blob.

resizeWithResponse

public reactor.core.publisher.Mono<Response<PageBlobItem>> resizeWithResponse(long size,
                                                                              BlobAccessConditions accessConditions)

Resizes the page blob to the specified size (which must be a multiple of 512). For more information, see the Azure Docs.

Parameters:

size - Resizes a page blob to the specified size. If the specified value is less than the current size of the blob, then all pages above the specified value are cleared.

accessConditions - BlobAccessConditions

Returns:

A reactive response emitting the resized page blob.

Throws:

IllegalArgumentException - If size isn't a multiple of PageBlobAsyncClient.PAGE_BYTES

updateSequenceNumber

public reactor.core.publisher.Mono<PageBlobItem> updateSequenceNumber(SequenceNumberActionType action,
                                                                      Long sequenceNumber)

Sets the page blob's sequence number. For more information, see the Azure Docs.

Parameters:

action - Indicates how the service should modify the blob's sequence number.

sequenceNumber - The blob's sequence number. The sequence number is a user-controlled property that you can use to track requests and manage concurrency issues.

Returns:

A reactive response emitting the updated page blob.

updateSequenceNumberWithResponse

public reactor.core.publisher.Mono<Response<PageBlobItem>> updateSequenceNumberWithResponse(SequenceNumberActionType action,
                                                                                            Long sequenceNumber,
                                                                                            BlobAccessConditions accessConditions)

Sets the page blob's sequence number. For more information, see the Azure Docs.

Parameters:

action - Indicates how the service should modify the blob's sequence number.

sequenceNumber - The blob's sequence number. The sequence number is a user-controlled property that you can use to track requests and manage concurrency issues.

accessConditions - BlobAccessConditions

Returns:

A reactive response emitting the updated page blob.

Throws:

IllegalArgumentException - If sequenceNumber isn't null and is less than 0

copyIncremental

public reactor.core.publisher.Mono<CopyStatusType> copyIncremental(URL source,
                                                                   String snapshot)

Begins an operation to start an incremental copy from one page blob's snapshot to this page blob. The snapshot is copied such that only the differential changes between the previously copied snapshot are transferred to the destination. The copied snapshots are complete copies of the original snapshot and can be read or copied from as usual. For more information, see the Azure Docs here and here.

Parameters:

source - The source page blob.

snapshot - The snapshot on the copy source.

Returns:

A reactive response emitting the copy status.

copyIncrementalWithResponse

public reactor.core.publisher.Mono<Response<CopyStatusType>> copyIncrementalWithResponse(URL source,
                                                                                         String snapshot,
                                                                                         ModifiedAccessConditions modifiedAccessConditions)

Begins an operation to start an incremental copy from one page blob's snapshot to this page blob. The snapshot is copied such that only the differential changes between the previously copied snapshot are transferred to the destination. The copied snapshots are complete copies of the original snapshot and can be read or copied from as usual. For more information, see the Azure Docs here and here.

Parameters:

source - The source page blob.

snapshot - The snapshot on the copy source.

modifiedAccessConditions - 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.

Returns:

A reactive response emitting the copy status.

Throws:

Error - If source and snapshot form a malformed URL.