com.microsoft.azure.storage.blob

Class PageBlobURL

java.lang.Object

com.microsoft.azure.storage.blob.StorageURL

com.microsoft.azure.storage.blob.BlobURL

com.microsoft.azure.storage.blob.PageBlobURL

public final class PageBlobURL
extends BlobURL

Represents a URL to a page blob. It may be obtained by direct construction or via the create method on a ContainerURL object. This class does not hold any state about a particular blob but is instead a convenient way of sending off appropriate requests to the resource on the service. 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.

Fields inherited from class com.microsoft.azure.storage.blob.StorageURL

storageClient

Constructor Summary

Constructors

Constructor and Description
PageBlobURL(URL url, com.microsoft.rest.v2.http.HttpPipeline pipeline) Creates a PageBlobURL object pointing to the account specified by the URL and using the provided pipeline to make HTTP requests.

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<PageBlobClearPagesResponse>	clearPages(PageRange pageRange, PageBlobAccessConditions pageBlobAccessConditions, com.microsoft.rest.v2.Context context) Frees the specified pages from the page blob.
io.reactivex.Single<PageBlobCopyIncrementalResponse>	copyIncremental(URL source, String snapshot, ModifiedAccessConditions modifiedAccessConditions, com.microsoft.rest.v2.Context context) Begins an operation to start an incremental copy from one page blob's snapshot to this page blob.
io.reactivex.Single<PageBlobCreateResponse>	create(long size, Long sequenceNumber, BlobHTTPHeaders headers, Metadata metadata, BlobAccessConditions accessConditions, com.microsoft.rest.v2.Context context) Creates a page blob of the specified length.
io.reactivex.Single<PageBlobGetPageRangesResponse>	getPageRanges(BlobRange blobRange, BlobAccessConditions accessConditions, com.microsoft.rest.v2.Context context) Returns the list of valid page ranges for a page blob or snapshot of a page blob.
io.reactivex.Single<PageBlobGetPageRangesDiffResponse>	getPageRangesDiff(BlobRange blobRange, String prevSnapshot, BlobAccessConditions accessConditions, com.microsoft.rest.v2.Context context) Gets the collection of page ranges that differ between a specified snapshot and this page blob.
io.reactivex.Single<PageBlobResizeResponse>	resize(long size, BlobAccessConditions accessConditions, com.microsoft.rest.v2.Context context) Resizes the page blob to the specified size (which must be a multiple of 512).
io.reactivex.Single<PageBlobUpdateSequenceNumberResponse>	updateSequenceNumber(SequenceNumberActionType action, Long sequenceNumber, BlobAccessConditions accessConditions, com.microsoft.rest.v2.Context context) Sets the page blob's sequence number.
io.reactivex.Single<PageBlobUploadPagesResponse>	uploadPages(PageRange pageRange, io.reactivex.Flowable<ByteBuffer> body, PageBlobAccessConditions pageBlobAccessConditions, com.microsoft.rest.v2.Context context) Writes 1 or more pages to the page blob.
PageBlobURL	withPipeline(com.microsoft.rest.v2.http.HttpPipeline pipeline) Creates a new PageBlobURL with the given pipeline.
PageBlobURL	withSnapshot(String snapshot) Creates a new PageBlobURL with the given snapshot.

Methods inherited from class com.microsoft.azure.storage.blob.BlobURL

abortCopyFromURL, acquireLease, breakLease, changeLease, createSnapshot, delete, download, getAccountInfo, getProperties, releaseLease, renewLease, setHTTPHeaders, setMetadata, setTier, startCopyFromURL, toAppendBlobURL, toBlockBlobURL, toPageBlobURL, undelete

Methods inherited from class com.microsoft.azure.storage.blob.StorageURL

appendToURLPath, createPipeline, toString, toURL

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, 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

Constructor Detail

PageBlobURL

public PageBlobURL(URL url,
                   com.microsoft.rest.v2.http.HttpPipeline pipeline)

Creates a PageBlobURL object pointing to the account specified by the URL and using the provided pipeline to make HTTP requests.

Parameters:

url - A URL to an Azure Storage page blob.

pipeline - A HttpPipeline which configures the behavior of HTTP exchanges. Please refer to the createPipeline method on StorageURL for more information.

Method Detail

withPipeline

public PageBlobURL withPipeline(com.microsoft.rest.v2.http.HttpPipeline pipeline)

Creates a new PageBlobURL with the given pipeline.

Overrides:

withPipeline in class BlobURL

Parameters:

pipeline - A HttpPipeline object to set.

Returns:

A PageBlobURL object with the given pipeline.

withSnapshot

public PageBlobURL withSnapshot(String snapshot)
                         throws MalformedURLException,
                                UnknownHostException

Creates a new PageBlobURL with the given snapshot.

Overrides:

withSnapshot in class BlobURL

Parameters:

snapshot - A String of the snapshot id.

Returns:

A PageBlobURL object with the given pipeline.

Throws:

MalformedURLException - Appending the specified snapshot produced an invalid URL.

UnknownHostException - If the url contains an improperly formatted ipaddress or unknown host address.

create

public io.reactivex.Single<PageBlobCreateResponse> create(long size,
                                                          Long sequenceNumber,
                                                          BlobHTTPHeaders headers,
                                                          Metadata metadata,
                                                          BlobAccessConditions accessConditions,
                                                          com.microsoft.rest.v2.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

context - Context offers a means of passing arbitrary data (key/value pairs) to an HttpPipeline's policy objects. Most applications do not need to pass arbitrary data to the pipeline and can pass Context.NONE or null. Each context object is immutable. The withContext with data method creates a new Context object that refers to its parent, forming a linked list.

Returns:

Emits the successful response.

API Note:

## Sample Code \n [!code-java[Sample_Code](../azure-storage-java/src/test/java/com/microsoft/azure/storage/Samples.java?name=page_blob_basic "Sample code for PageBlobURL.create")] \n For more samples, please see the [Samples file](%https://github.com/Azure/azure-storage-java/blob/New-Storage-SDK-V10-Preview/src/test/java/com/microsoft/azure/storage/Samples.java)

uploadPages

public io.reactivex.Single<PageBlobUploadPagesResponse> uploadPages(PageRange pageRange,
                                                                    io.reactivex.Flowable<ByteBuffer> body,
                                                                    PageBlobAccessConditions pageBlobAccessConditions,
                                                                    com.microsoft.rest.v2.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 Flowable 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 Flowable 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

context - Context offers a means of passing arbitrary data (key/value pairs) to an HttpPipeline's policy objects. Most applications do not need to pass arbitrary data to the pipeline and can pass Context.NONE or null. Each context object is immutable. The withContext with data method creates a new Context object that refers to its parent, forming a linked list.

Returns:

Emits the successful response.

API Note:

## Sample Code \n [!code-java[Sample_Code](../azure-storage-java/src/test/java/com/microsoft/azure/storage/Samples.java?name=page_blob_basic "Sample code for PageBlobURL.uploadPages")] \n For more samples, please see the [Samples file](%https://github.com/Azure/azure-storage-java/blob/New-Storage-SDK-V10-Preview/src/test/java/com/microsoft/azure/storage/Samples.java)

clearPages

public io.reactivex.Single<PageBlobClearPagesResponse> clearPages(PageRange pageRange,
                                                                  PageBlobAccessConditions pageBlobAccessConditions,
                                                                  com.microsoft.rest.v2.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.

context - Context offers a means of passing arbitrary data (key/value pairs) to an HttpPipeline's policy objects. Most applications do not need to pass arbitrary data to the pipeline and can pass Context.NONE or null. Each context object is immutable. The withContext with data method creates a new Context object that refers to its parent, forming a linked list.

pageBlobAccessConditions - PageBlobAccessConditions

Returns:

Emits the successful response.

API Note:

## Sample Code \n [!code-java[Sample_Code](../azure-storage-java/src/test/java/com/microsoft/azure/storage/Samples.java?name=page_blob_basic "Sample code for PageBlobURL.clearPages")] \n For more samples, please see the [Samples file](%https://github.com/Azure/azure-storage-java/blob/New-Storage-SDK-V10-Preview/src/test/java/com/microsoft/azure/storage/Samples.java)

getPageRanges

public io.reactivex.Single<PageBlobGetPageRangesResponse> getPageRanges(BlobRange blobRange,
                                                                        BlobAccessConditions accessConditions,
                                                                        com.microsoft.rest.v2.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

context - Context offers a means of passing arbitrary data (key/value pairs) to an HttpPipeline's policy objects. Most applications do not need to pass arbitrary data to the pipeline and can pass Context.NONE or null. Each context object is immutable. The withContext with data method creates a new Context object that refers to its parent, forming a linked list.

Returns:

Emits the successful response.

API Note:

## Sample Code \n [!code-java[Sample_Code](../azure-storage-java/src/test/java/com/microsoft/azure/storage/Samples.java?name=page_blob_basic "Sample code for PageBlobURL.getPageRanges")] \n For more samples, please see the [Samples file](%https://github.com/Azure/azure-storage-java/blob/New-Storage-SDK-V10-Preview/src/test/java/com/microsoft/azure/storage/Samples.java)

getPageRangesDiff

public io.reactivex.Single<PageBlobGetPageRangesDiffResponse> getPageRangesDiff(BlobRange blobRange,
                                                                                String prevSnapshot,
                                                                                BlobAccessConditions accessConditions,
                                                                                com.microsoft.rest.v2.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

context - Context offers a means of passing arbitrary data (key/value pairs) to an HttpPipeline's policy objects. Most applications do not need to pass arbitrary data to the pipeline and can pass Context.NONE or null. Each context object is immutable. The withContext with data method creates a new Context object that refers to its parent, forming a linked list.

Returns:

Emits the successful response.

API Note:

## Sample Code \n [!code-java[Sample_Code](../azure-storage-java/src/test/java/com/microsoft/azure/storage/Samples.java?name=page_diff "Sample code for PageBlobURL.getPageRangesDiff")] \n For more samples, please see the [Samples file](%https://github.com/Azure/azure-storage-java/blob/New-Storage-SDK-V10-Preview/src/test/java/com/microsoft/azure/storage/Samples.java)

resize

public io.reactivex.Single<PageBlobResizeResponse> resize(long size,
                                                          BlobAccessConditions accessConditions,
                                                          com.microsoft.rest.v2.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

context - Context offers a means of passing arbitrary data (key/value pairs) to an HttpPipeline's policy objects. Most applications do not need to pass arbitrary data to the pipeline and can pass Context.NONE or null. Each context object is immutable. The withContext with data method creates a new Context object that refers to its parent, forming a linked list.

Returns:

Emits the successful response.

API Note:

## Sample Code \n [!code-java[Sample_Code](../azure-storage-java/src/test/java/com/microsoft/azure/storage/Samples.java?name=page_blob_basic "Sample code for PageBlobURL.resize")] \n For more samples, please see the [Samples file](%https://github.com/Azure/azure-storage-java/blob/New-Storage-SDK-V10-Preview/src/test/java/com/microsoft/azure/storage/Samples.java)

updateSequenceNumber

public io.reactivex.Single<PageBlobUpdateSequenceNumberResponse> updateSequenceNumber(SequenceNumberActionType action,
                                                                                      Long sequenceNumber,
                                                                                      BlobAccessConditions accessConditions,
                                                                                      com.microsoft.rest.v2.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

context - Context offers a means of passing arbitrary data (key/value pairs) to an HttpPipeline's policy objects. Most applications do not need to pass arbitrary data to the pipeline and can pass Context.NONE or null. Each context object is immutable. The withContext with data method creates a new Context object that refers to its parent, forming a linked list.

Returns:

Emits the successful response.

API Note:

## Sample Code \n [!code-java[Sample_Code](../azure-storage-java/src/test/java/com/microsoft/azure/storage/Samples.java?name=page_blob_basic "Sample code for PageBlobURL.updateSequenceNumber")] \n For more samples, please see the [Samples file](%https://github.com/Azure/azure-storage-java/blob/New-Storage-SDK-V10-Preview/src/test/java/com/microsoft/azure/storage/Samples.java)

copyIncremental

public io.reactivex.Single<PageBlobCopyIncrementalResponse> copyIncremental(URL source,
                                                                            String snapshot,
                                                                            ModifiedAccessConditions modifiedAccessConditions,
                                                                            com.microsoft.rest.v2.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 - ModifiedAccessConditions

context - Context offers a means of passing arbitrary data (key/value pairs) to an HttpPipeline's policy objects. Most applications do not need to pass arbitrary data to the pipeline and can pass Context.NONE or null. Each context object is immutable. The withContext with data method creates a new Context object that refers to its parent, forming a linked list.

Returns:

Emits the successful response.