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.

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.

Constructor Summary

Constructors

Constructor and Description
PageBlobURL(java.net.URL url, com.microsoft.rest.v2.http.HttpPipeline pipeline) Creates a new PageBlobURL object.

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<com.microsoft.rest.v2.RestResponse<PageBlobPutPageHeaders,java.lang.Void>>	clearPages(PageRange pageRange, BlobAccessConditions accessConditions) Frees the specified pages from the page blob.
io.reactivex.Single<com.microsoft.rest.v2.RestResponse<BlobPutHeaders,java.lang.Void>>	create(long size, java.lang.Long sequenceNumber, BlobHTTPHeaders headers, Metadata metadata, BlobAccessConditions accessConditions) Creates a page blob of the specified length.
io.reactivex.Single<com.microsoft.rest.v2.RestResponse<PageBlobGetPageRangesHeaders,PageList>>	getPageRanges(BlobRange blobRange, BlobAccessConditions accessConditions) Returns the list of valid page ranges for a page blob or snapshot of a page blob.
io.reactivex.Single<com.microsoft.rest.v2.RestResponse<PageBlobGetPageRangesHeaders,PageList>>	getPageRangesDiff(BlobRange blobRange, java.lang.String prevSnapshot, BlobAccessConditions accessConditions) Gets the collection of page ranges that differ between a specified snapshot and this page blob.
io.reactivex.Single<com.microsoft.rest.v2.RestResponse<PageBlobPutPageHeaders,java.lang.Void>>	putPages(PageRange pageRange, io.reactivex.Flowable<java.nio.ByteBuffer> body, BlobAccessConditions accessConditions) Writes 1 or more pages to the page blob.
io.reactivex.Single<com.microsoft.rest.v2.RestResponse<BlobSetPropertiesHeaders,java.lang.Void>>	resize(long size, BlobAccessConditions accessConditions) Resizes the page blob to the specified size (which must be a multiple of 512).
io.reactivex.Single<com.microsoft.rest.v2.RestResponse<BlobSetPropertiesHeaders,java.lang.Void>>	setSequenceNumber(SequenceNumberActionType action, java.lang.Long sequenceNumber, BlobHTTPHeaders headers, BlobAccessConditions accessConditions) Sets the page blob's sequence number.
io.reactivex.Single<com.microsoft.rest.v2.RestResponse<PageBlobIncrementalCopyHeaders,java.lang.Void>>	startIncrementalCopy(java.net.URL source, java.lang.String snapshot, BlobAccessConditions accessConditions) Begins an operation to start an incremental copy from one page blob's snapshot to this page blob.
PageBlobURL	withPipeline(com.microsoft.rest.v2.http.HttpPipeline pipeline) Creates a new PageBlobURL with the given pipeline.
PageBlobURL	withSnapshot(java.lang.String snapshot) Creates a new PageBlobURL with the given snapshot.

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

abortCopy, acquireLease, breakLease, changeLease, createSnapshot, delete, getBlob, getPropertiesAndMetadata, releaseLease, renewLease, setMetadata, setProperties, startCopy, toAppendBlobURL, toBlockBlobURL, toPageBlobURL

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

createPipeline, toString, toURL

Methods inherited from class java.lang.Object

equals, 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(java.net.URL url,
                   com.microsoft.rest.v2.http.HttpPipeline pipeline)

Creates a new PageBlobURL object.

Parameters:

url - A java.net.URL to a page blob.

pipeline - A HttpPipeline for sending requests.

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(java.lang.String snapshot)
                         throws java.net.MalformedURLException,
                                java.net.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:

java.net.MalformedURLException

java.net.UnknownHostException

create

public io.reactivex.Single<com.microsoft.rest.v2.RestResponse<BlobPutHeaders,java.lang.Void>> create(long size,
                                                                                                     java.lang.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 https://docs.microsoft.com/rest/api/storageservices/put-blob.

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 - A BlobHTTPHeaders object that specifies which properties to set on the blob.

metadata - A Metadata object that specifies key value pairs to set on the blob.

accessConditions - A BlobAccessConditions object that specifies under which conditions the operation should complete.

Returns:

The Single which emits a RestResponse containing the BlobPutHeaders and a Void body if successful.

putPages

public io.reactivex.Single<com.microsoft.rest.v2.RestResponse<PageBlobPutPageHeaders,java.lang.Void>> putPages(PageRange pageRange,
                                                                                                               io.reactivex.Flowable<java.nio.ByteBuffer> body,
                                                                                                               BlobAccessConditions accessConditions)

Writes 1 or more pages to the page blob. The start and end offsets must be a multiple of 512. For more information, see https://docs.microsoft.com/rest/api/storageservices/put-page.

Parameters:

pageRange - A PageRange object. Specifies the range of bytes to be written as a page.

body - A Flowable of ByteBuffer that contains the content of the page.

accessConditions - A BlobAccessConditions object that specifies under which conditions the operation should complete.

Returns:

A Single which emits a RestResponse containing the PageBlobPutPageHeaders and a Void body if successful.

clearPages

public io.reactivex.Single<com.microsoft.rest.v2.RestResponse<PageBlobPutPageHeaders,java.lang.Void>> clearPages(PageRange pageRange,
                                                                                                                 BlobAccessConditions accessConditions)

Frees the specified pages from the page blob. For more information, see https://docs.microsoft.com/rest/api/storageservices/put-page.

Parameters:

pageRange - A PageRange object. Specifies the range of bytes to be written as a page.

accessConditions - A BlobAccessConditions object that specifies under which conditions the operation should complete.

Returns:

A Single which emits a RestResponse containing the PageBlobPutPageHeaders and a Void body if successful.

getPageRanges

public io.reactivex.Single<com.microsoft.rest.v2.RestResponse<PageBlobGetPageRangesHeaders,PageList>> getPageRanges(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 https://docs.microsoft.com/rest/api/storageservices/get-page-ranges.

Parameters:

blobRange - A BlobRange object specifies the range of bytes over which to list ranges, inclusively. If omitted, then all ranges for the blob are returned.

accessConditions - A BlobAccessConditions object that specifies under which conditions the operation should complete.

Returns:

A Single which emits a RestResponse containing the PageBlobGetPageRangesHeaders and a PageList body if successful.

getPageRangesDiff

public io.reactivex.Single<com.microsoft.rest.v2.RestResponse<PageBlobGetPageRangesHeaders,PageList>> getPageRangesDiff(BlobRange blobRange,
                                                                                                                        java.lang.String prevSnapshot,
                                                                                                                        BlobAccessConditions accessConditions)

Gets the collection of page ranges that differ between a specified snapshot and this page blob. For more information, see https://docs.microsoft.com/rest/api/storageservices/get-page-ranges.

Parameters:

blobRange - A PageRange object. Specifies the range of bytes to be written as a page.

prevSnapshot - A String 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 - A BlobAccessConditions object that specifies under which conditions the operation should complete.

Returns:

The Single which emits a RestResponse containing the PageBlobGetPageRangesHeaders and a PageList body if successful.

resize

public io.reactivex.Single<com.microsoft.rest.v2.RestResponse<BlobSetPropertiesHeaders,java.lang.Void>> resize(long size,
                                                                                                               BlobAccessConditions accessConditions)

Resizes the page blob to the specified size (which must be a multiple of 512). For more information, see https://docs.microsoft.com/rest/api/storageservices/set-blob-properties.

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 - A BlobAccessConditions object that specifies under which conditions the operation should complete.

Returns:

The Single which emits a RestResponse containing the BlobSetPropertiesHeaders and a Void body if successful.

setSequenceNumber

public io.reactivex.Single<com.microsoft.rest.v2.RestResponse<BlobSetPropertiesHeaders,java.lang.Void>> setSequenceNumber(SequenceNumberActionType action,
                                                                                                                          java.lang.Long sequenceNumber,
                                                                                                                          BlobHTTPHeaders headers,
                                                                                                                          BlobAccessConditions accessConditions)

Sets the page blob's sequence number.

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.

headers - A BlobHTTPHeaders object that specifies which properties to set on the blob.

accessConditions - A BlobAccessConditions object that specifies under which conditions the operation should complete.

Returns:

The Single which emits a RestResponse containing the BlobSetPropertiesHeaders and a Void body if successful.

startIncrementalCopy

public io.reactivex.Single<com.microsoft.rest.v2.RestResponse<PageBlobIncrementalCopyHeaders,java.lang.Void>> startIncrementalCopy(java.net.URL source,
                                                                                                                                   java.lang.String snapshot,
                                                                                                                                   BlobAccessConditions accessConditions)

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 https://docs.microsoft.com/rest/api/storageservices/incremental-copy-blob and https://docs.microsoft.com/en-us/azure/virtual-machines/windows/incremental-snapshots.

Parameters:

source - A java.net.URL which specifies the name of the source page blob.

snapshot - A String which specifies the snapshot on the copy source.

accessConditions - A BlobAccessConditions object that specifies under which conditions the operation should complete.

Returns:

A Single which emits a RestResponse containing the PageBlobIncrementalCopyHeaders and a Void body if successful.