com.azure.storage.blob

Class PageBlobClient

java.lang.Object

com.azure.storage.blob.BlobClient

com.azure.storage.blob.PageBlobClient

public final class PageBlobClient
extends BlobClient

Client to a page blob. It may only be instantiated through a BlobClientBuilder, via the method BlobClient.asPageBlobClient(), or via the method ContainerClient.getPageBlobClient(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 ContainerClient, and operations on the service are available on BlobServiceClient.

Please refer to the Azure Docs for more information.

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.

Method Summary

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

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

abortCopyFromURL, abortCopyFromURLWithResponse, asAppendBlobClient, asBlockBlobClient, asPageBlobClient, copyFromURL, copyFromURLWithResponse, createSnapshot, createSnapshotWithResponse, delete, deleteWithResponse, download, downloadToFile, downloadToFile, downloadWithResponse, exists, existsWithResponse, generateSAS, generateSAS, generateSAS, generateSAS, generateUserDelegationSAS, generateUserDelegationSAS, generateUserDelegationSAS, getAccountInfo, getAccountInfoWithResponse, getBlobUrl, getContainerClient, getHttpPipeline, getProperties, getPropertiesWithResponse, getSnapshotClient, getSnapshotId, isSnapshot, openInputStream, openInputStream, 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

getBlobOutputStream

public BlobOutputStream getBlobOutputStream(long length)

Creates and opens an output stream to write data to the page blob. If the blob already exists on the service, it will be overwritten.

Parameters:

length - A long which represents the length, in bytes, of the stream to create. This value must be a multiple of 512.

Returns:

A BlobOutputStream object used to write data to the blob.

Throws:

StorageException - If a storage service error occurred.

getBlobOutputStream

public BlobOutputStream getBlobOutputStream(long length,
                                            BlobAccessConditions accessConditions)

Creates and opens an output stream to write data to the page blob. If the blob already exists on the service, it will be overwritten.

Parameters:

length - A long which represents the length, in bytes, of the stream to create. This value must be a multiple of 512.

accessConditions - A BlobAccessConditions object that represents the access conditions for the blob.

Returns:

A BlobOutputStream object used to write data to the blob.

Throws:

StorageException - If a storage service error occurred.

setCreate

public 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:

The information of the created page blob.

createWithResponse

public Response<PageBlobItem> createWithResponse(long size,
                                                 Long sequenceNumber,
                                                 BlobHTTPHeaders headers,
                                                 Metadata metadata,
                                                 BlobAccessConditions accessConditions,
                                                 Duration timeout,
                                                 Context context)

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

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 information of the created page blob.

uploadPages

public PageBlobItem uploadPages(PageRange pageRange,
                                InputStream 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.

Returns:

The information of the uploaded pages.

uploadPagesWithResponse

public Response<PageBlobItem> uploadPagesWithResponse(PageRange pageRange,
                                                      InputStream body,
                                                      PageBlobAccessConditions pageBlobAccessConditions,
                                                      Duration timeout,
                                                      Context context)

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.

pageBlobAccessConditions - PageBlobAccessConditions

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 information of the uploaded pages.

Throws:

UnexpectedLengthException - when the length of data does not match the input length.

NullPointerException - if the input data is null.

uploadPagesFromURL

public 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:

The information of the uploaded pages.

uploadPagesFromURLWithResponse

public Response<PageBlobItem> uploadPagesFromURLWithResponse(PageRange range,
                                                             URL sourceURL,
                                                             Long sourceOffset,
                                                             byte[] sourceContentMD5,
                                                             PageBlobAccessConditions destAccessConditions,
                                                             SourceModifiedAccessConditions sourceAccessConditions,
                                                             Duration timeout,
                                                             Context context)

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

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 information of the uploaded pages.

clearPages

public 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:

The information of the cleared pages.

clearPagesWithResponse

public Response<PageBlobItem> clearPagesWithResponse(PageRange pageRange,
                                                     PageBlobAccessConditions pageBlobAccessConditions,
                                                     Duration timeout,
                                                     Context context)

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.

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

pageBlobAccessConditions - PageBlobAccessConditions

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

Returns:

The information of the cleared pages.

getPageRanges

public 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:

The information of the cleared pages.

getPageRangesWithResponse

public Response<PageList> getPageRangesWithResponse(BlobRange blobRange,
                                                    BlobAccessConditions accessConditions,
                                                    Duration timeout,
                                                    Context context)

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

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:

All the page ranges.

getPageRangesDiff

public 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:

All the different page ranges.

getPageRangesDiffWithResponse

public Response<PageList> getPageRangesDiffWithResponse(BlobRange blobRange,
                                                        String prevSnapshot,
                                                        BlobAccessConditions accessConditions,
                                                        Duration timeout,
                                                        Context context)

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

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:

All the different page ranges.

resize

public 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:

The resized page blob.

resizeWithResponse

public Response<PageBlobItem> resizeWithResponse(long size,
                                                 BlobAccessConditions accessConditions,
                                                 Duration timeout,
                                                 Context context)

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

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 resized page blob.

updateSequenceNumber

public 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:

The updated page blob.

updateSequenceNumberWithResponse

public Response<PageBlobItem> updateSequenceNumberWithResponse(SequenceNumberActionType action,
                                                               Long sequenceNumber,
                                                               BlobAccessConditions accessConditions,
                                                               Duration timeout,
                                                               Context context)

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

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 updated page blob.

copyIncremental

public 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:

The copy status.

copyIncrementalWithResponse

public Response<CopyStatusType> copyIncrementalWithResponse(URL source,
                                                            String snapshot,
                                                            ModifiedAccessConditions modifiedAccessConditions,
                                                            Duration timeout,
                                                            Context context)

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.

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