com.microsoft.azure.storage.blob.PageBlobURL Maven / Gradle / Ivy
Show all versions of azure-storage-blob Show documentation
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
package com.microsoft.azure.storage.blob;
import com.microsoft.azure.storage.blob.models.*;
import com.microsoft.rest.v2.Context;
import com.microsoft.rest.v2.http.HttpPipeline;
import com.microsoft.rest.v2.http.UrlBuilder;
import io.reactivex.Flowable;
import io.reactivex.Single;
import java.net.MalformedURLException;
import java.net.URL;
import java.net.UnknownHostException;
import java.nio.ByteBuffer;
import static com.microsoft.azure.storage.blob.Utility.postProcessResponse;
/**
* Represents a URL to a page blob. It may be obtained by direct construction or via the create method on a
* {@link 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.
*/
public final class PageBlobURL extends BlobURL {
/**
* Indicates the number of bytes in a page.
*/
public static final int PAGE_BYTES = 512;
/**
* Indicates the maximum number of bytes that may be sent in a call to putPage.
*/
public static final int MAX_PUT_PAGES_BYTES = 4 * Constants.MB;
/**
* Creates a {@code PageBlobURL} object pointing to the account specified by the URL and using the provided
* pipeline to make HTTP requests.
*
* @param url
* A {@code URL} to an Azure Storage page blob.
* @param pipeline
* A {@code HttpPipeline} which configures the behavior of HTTP exchanges. Please refer to
* {@link StorageURL#createPipeline(ICredentials, PipelineOptions)} for more information.
*/
public PageBlobURL(URL url, HttpPipeline pipeline) {
super(url, pipeline);
}
private static String pageRangeToString(PageRange pageRange) {
if (pageRange.start() < 0 || pageRange.end() <= 0) {
throw new IllegalArgumentException("PageRange's start and end values must be greater than or equal to " +
"0 if specified.");
}
if (pageRange.start() % PageBlobURL.PAGE_BYTES != 0) {
throw new IllegalArgumentException("PageRange's start value must be a multiple of 512.");
}
if (pageRange.end() % PageBlobURL.PAGE_BYTES != PageBlobURL.PAGE_BYTES - 1) {
throw new IllegalArgumentException("PageRange's end value must be 1 less than a multiple of 512.");
}
if (pageRange.end() <= pageRange.start()) {
throw new IllegalArgumentException("PageRange's End value must be after the start.");
}
return new StringBuilder("bytes=").append(pageRange.start()).append('-').append(pageRange.end()).toString();
}
/**
* Creates a new {@link PageBlobURL} with the given pipeline.
*
* @param pipeline
* A {@link HttpPipeline} object to set.
*
* @return A {@link PageBlobURL} object with the given pipeline.
*/
public PageBlobURL withPipeline(HttpPipeline pipeline) {
try {
return new PageBlobURL(new URL(this.storageClient.url()), pipeline);
} catch (MalformedURLException e) {
throw new RuntimeException(e);
}
}
/**
* Creates a new {@link PageBlobURL} with the given snapshot.
*
* @param snapshot
* A {@code String} of the snapshot id.
*
* @return A {@link PageBlobURL} object with the given pipeline.
*/
public PageBlobURL withSnapshot(String snapshot) throws MalformedURLException, UnknownHostException {
BlobURLParts blobURLParts = URLParser.parse(new URL(this.storageClient.url()));
blobURLParts.withSnapshot(snapshot);
return new PageBlobURL(blobURLParts.toURL(), super.storageClient.httpPipeline());
}
/**
* 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.
*
* @param 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.
*
* @return Emits the successful response.
*
* @apiNote ## 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/master/src/test/java/com/microsoft/azure/storage/Samples.java)
*/
public Single create(long size) {
return this.create(size, null, null, null, null, null);
}
/**
* 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.
*
* @param 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.
* @param 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.
* @param headers
* {@link BlobHTTPHeaders}
* @param metadata
* {@link Metadata}
* @param accessConditions
* {@link BlobAccessConditions}
* @param context
* {@code Context} offers a means of passing arbitrary data (key/value pairs) to an
* {@link com.microsoft.rest.v2.http.HttpPipeline}'s policy objects. Most applications do not need to pass
* arbitrary data to the pipeline and can pass {@code Context.NONE} or {@code null}. Each context object is
* immutable. The {@code withContext} with data method creates a new {@code Context} object that refers to
* its parent, forming a linked list.
*
* @return Emits the successful response.
*
* @apiNote ## 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/master/src/test/java/com/microsoft/azure/storage/Samples.java)
*/
public Single create(long size, Long sequenceNumber, BlobHTTPHeaders headers,
Metadata metadata, BlobAccessConditions accessConditions, Context context) {
accessConditions = accessConditions == null ? new BlobAccessConditions() : accessConditions;
if (size % PageBlobURL.PAGE_BYTES != 0) {
// Throwing is preferred to Single.error because this will error out immediately instead of waiting until
// subscription.
throw new IllegalArgumentException("size must be a multiple of PageBlobURL.PAGE_BYTES.");
}
if (sequenceNumber != null && sequenceNumber < 0) {
// Throwing is preferred to Single.error because this will error out immediately instead of waiting until
// subscription.
throw new IllegalArgumentException("SequenceNumber must be greater than or equal to 0.");
}
metadata = metadata == null ? new Metadata() : metadata;
context = context == null ? Context.NONE : context;
return postProcessResponse(this.storageClient.generatedPageBlobs().createWithRestResponseAsync(
context, 0, size, null, metadata, sequenceNumber, null, headers,
accessConditions.leaseAccessConditions(), accessConditions.modifiedAccessConditions()));
}
/**
* 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
* {@code Flowable} must produce the same data each time it is subscribed to.
*
* @param pageRange
* A {@link 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.
* @param body
* The data to upload. Note that this {@code 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.
*
* @return Emits the successful response.
*
* @apiNote ## 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/master/src/test/java/com/microsoft/azure/storage/Samples.java)
*/
public Single uploadPages(PageRange pageRange, Flowable body) {
return this.uploadPages(pageRange, body, null, null);
}
/**
* 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
* {@code Flowable} must produce the same data each time it is subscribed to.
*
* @param pageRange
* A {@link 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.
* @param body
* The data to upload. Note that this {@code 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.
* @param pageBlobAccessConditions
* {@link PageBlobAccessConditions}
* @param context
* {@code Context} offers a means of passing arbitrary data (key/value pairs) to an
* {@link com.microsoft.rest.v2.http.HttpPipeline}'s policy objects. Most applications do not need to pass
* arbitrary data to the pipeline and can pass {@code Context.NONE} or {@code null}. Each context object is
* immutable. The {@code withContext} with data method creates a new {@code Context} object that refers to
* its parent, forming a linked list.
*
* @return Emits the successful response.
*
* @apiNote ## 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/master/src/test/java/com/microsoft/azure/storage/Samples.java)
*/
public Single uploadPages(PageRange pageRange, Flowable body,
PageBlobAccessConditions pageBlobAccessConditions, Context context) {
pageBlobAccessConditions = pageBlobAccessConditions == null ? new PageBlobAccessConditions() :
pageBlobAccessConditions;
if (pageRange == null) {
// Throwing is preferred to Single.error because this will error out immediately instead of waiting until
// subscription.
throw new IllegalArgumentException("pageRange cannot be null.");
}
String pageRangeStr = pageRangeToString(pageRange);
context = context == null ? Context.NONE : context;
return postProcessResponse(this.storageClient.generatedPageBlobs().uploadPagesWithRestResponseAsync(
context, body, pageRange.end() - pageRange.start() + 1, null, null, pageRangeStr, null,
pageBlobAccessConditions.leaseAccessConditions(),
pageBlobAccessConditions.sequenceNumberAccessConditions(),
pageBlobAccessConditions.modifiedAccessConditions()));
}
/**
* 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.
*
*
* @param range
* A {@link 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.
* @param 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.
* @param sourceOffset
* The source offset to copy from. Pass null or 0 to copy from the beginning of source page blob.
*
* @return Emits the successful response.
*
* @apiNote ## Sample Code \n
* [!code-java[Sample_Code](../azure-storage-java/src/test/java/com/microsoft/azure/storage/Samples.java?name=page_from_url "Sample code for PageBlobURL.uploadPagesFromURL")]
* For more samples, please see the [Samples file](%https://github.com/Azure/azure-storage-java/blob/master/src/test/java/com/microsoft/azure/storage/Samples.java)
*/
public Single uploadPagesFromURL(PageRange range, URL sourceURL, Long sourceOffset) {
return this.uploadPagesFromURL(range, sourceURL, sourceOffset, null, null,
null, null);
}
/**
* 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.
*
*
* @param range
* The destination {@link 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.
* @param 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.
* @param sourceOffset
* The source offset to copy from. Pass null or 0 to copy from the beginning of source blob.
* @param 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.
* @param destAccessConditions
* {@link PageBlobAccessConditions}
* @param sourceAccessConditions
* {@link SourceModifiedAccessConditions}
* @param context
* {@code Context} offers a means of passing arbitrary data (key/value pairs) to an
* {@link com.microsoft.rest.v2.http.HttpPipeline}'s policy objects. Most applications do not need to pass
* arbitrary data to the pipeline and can pass {@code Context.NONE} or {@code null}. Each context object is
* immutable. The {@code withContext} with data method creates a new {@code Context} object that refers to
* its parent, forming a linked list.
*
* @return Emits the successful response.
*
* @apiNote ## Sample Code \n
* [!code-java[Sample_Code](../azure-storage-java/src/test/java/com/microsoft/azure/storage/Samples.java?name=page_from_url "Sample code for PageBlobURL.uploadPagesFromURL")]
* For more samples, please see the [Samples file](%https://github.com/Azure/azure-storage-java/blob/master/src/test/java/com/microsoft/azure/storage/Samples.java)
*/
public Single uploadPagesFromURL(PageRange range, URL sourceURL, Long sourceOffset,
byte[] sourceContentMD5, PageBlobAccessConditions destAccessConditions,
SourceModifiedAccessConditions sourceAccessConditions, Context context) {
if(range == null) {
// Throwing is preferred to Single.error because this will error out immediately instead of waiting until
// subscription.
throw new IllegalArgumentException("range cannot be null.");
}
String rangeString = pageRangeToString(range);
sourceOffset = sourceOffset == null ? 0 : sourceOffset;
String sourceRangeString = pageRangeToString(new PageRange().withStart(sourceOffset).withEnd(sourceOffset + (range.end() - range.start())));
destAccessConditions = destAccessConditions == null ? new PageBlobAccessConditions() : destAccessConditions;
context = context == null ? Context.NONE : context;
return postProcessResponse(this.storageClient.generatedPageBlobs().uploadPagesFromURLWithRestResponseAsync(
context, sourceURL, sourceRangeString, 0, rangeString, sourceContentMD5, null,
null, destAccessConditions.leaseAccessConditions(), destAccessConditions.sequenceNumberAccessConditions(),
destAccessConditions.modifiedAccessConditions(), sourceAccessConditions));
}
/**
* Frees the specified pages from the page blob.
* For more information, see the
* Azure Docs.
*
* @param pageRange
* A {@link 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.
*
* @return Emits the successful response.
*
* @apiNote ## 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/master/src/test/java/com/microsoft/azure/storage/Samples.java)
*/
public Single clearPages(PageRange pageRange) {
return this.clearPages(pageRange, null, null);
}
/**
* Frees the specified pages from the page blob.
* For more information, see the
* Azure Docs.
*
* @param pageRange
* A {@link 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.
* @param context
* {@code Context} offers a means of passing arbitrary data (key/value pairs) to an
* {@link com.microsoft.rest.v2.http.HttpPipeline}'s policy objects. Most applications do not need to pass
* arbitrary data to the pipeline and can pass {@code Context.NONE} or {@code null}. Each context object is
* immutable. The {@code withContext} with data method creates a new {@code Context} object that refers to
* its parent, forming a linked list.
* @param pageBlobAccessConditions
* {@link PageBlobAccessConditions}
*
* @return Emits the successful response.
*
* @apiNote ## 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/master/src/test/java/com/microsoft/azure/storage/Samples.java)
*/
public Single clearPages(PageRange pageRange,
PageBlobAccessConditions pageBlobAccessConditions, Context context) {
pageBlobAccessConditions = pageBlobAccessConditions == null ? new PageBlobAccessConditions() :
pageBlobAccessConditions;
if (pageRange == null) {
// Throwing is preferred to Single.error because this will error out immediately instead of waiting until
// subscription.
throw new IllegalArgumentException("pageRange cannot be null.");
}
String pageRangeStr = pageRangeToString(pageRange);
context = context == null ? Context.NONE : context;
return postProcessResponse(this.storageClient.generatedPageBlobs().clearPagesWithRestResponseAsync(
context, 0, null, pageRangeStr, null, pageBlobAccessConditions.leaseAccessConditions(),
pageBlobAccessConditions.sequenceNumberAccessConditions(),
pageBlobAccessConditions.modifiedAccessConditions()));
}
/**
* Returns the list of valid page ranges for a page blob or snapshot of a page blob.
* For more information, see the Azure Docs.
*
* @param blobRange
* {@link BlobRange}
*
* @return Emits the successful response.
*
* @apiNote ## 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/master/src/test/java/com/microsoft/azure/storage/Samples.java)
*/
public Single getPageRanges(BlobRange blobRange) {
return this.getPageRanges(blobRange, null, null);
}
/**
* Returns the list of valid page ranges for a page blob or snapshot of a page blob.
* For more information, see the Azure Docs.
*
* @param blobRange
* {@link BlobRange}
* @param accessConditions
* {@link BlobAccessConditions}
* @param context
* {@code Context} offers a means of passing arbitrary data (key/value pairs) to an
* {@link com.microsoft.rest.v2.http.HttpPipeline}'s policy objects. Most applications do not need to pass
* arbitrary data to the pipeline and can pass {@code Context.NONE} or {@code null}. Each context object is
* immutable. The {@code withContext} with data method creates a new {@code Context} object that refers to
* its parent, forming a linked list.
*
* @return Emits the successful response.
*
* @apiNote ## 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/master/src/test/java/com/microsoft/azure/storage/Samples.java)
*/
public Single getPageRanges(BlobRange blobRange,
BlobAccessConditions accessConditions, Context context) {
blobRange = blobRange == null ? new BlobRange() : blobRange;
accessConditions = accessConditions == null ? new BlobAccessConditions() : accessConditions;
context = context == null ? Context.NONE : context;
return postProcessResponse(this.storageClient.generatedPageBlobs().getPageRangesWithRestResponseAsync(
context, null, null, blobRange.toHeaderValue(), null, accessConditions.leaseAccessConditions(),
accessConditions.modifiedAccessConditions()));
}
/**
* Gets the collection of page ranges that differ between a specified snapshot and this page blob.
* For more information, see the Azure Docs.
*
* @param blobRange
* {@link BlobRange}
* @param 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.
*
* @return Emits the successful response.
*
* @apiNote ## 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/master/src/test/java/com/microsoft/azure/storage/Samples.java)
*/
public Single getPageRangesDiff(BlobRange blobRange, String prevSnapshot) {
return this.getPageRangesDiff(blobRange, prevSnapshot, null, null);
}
/**
* Gets the collection of page ranges that differ between a specified snapshot and this page blob.
* For more information, see the Azure Docs.
*
* @param blobRange
* {@link BlobRange}
* @param 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.
* @param accessConditions
* {@link BlobAccessConditions}
* @param context
* {@code Context} offers a means of passing arbitrary data (key/value pairs) to an
* {@link com.microsoft.rest.v2.http.HttpPipeline}'s policy objects. Most applications do not need to pass
* arbitrary data to the pipeline and can pass {@code Context.NONE} or {@code null}. Each context object is
* immutable. The {@code withContext} with data method creates a new {@code Context} object that refers to
* its parent, forming a linked list.
*
* @return Emits the successful response.
*
* @apiNote ## 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/master/src/test/java/com/microsoft/azure/storage/Samples.java)
*/
public Single getPageRangesDiff(BlobRange blobRange, String prevSnapshot,
BlobAccessConditions accessConditions, Context context) {
blobRange = blobRange == null ? new BlobRange() : blobRange;
accessConditions = accessConditions == null ? new BlobAccessConditions() : accessConditions;
context = context == null ? Context.NONE : context;
if (prevSnapshot == null) {
throw new IllegalArgumentException("prevSnapshot cannot be null");
}
return postProcessResponse(this.storageClient.generatedPageBlobs().getPageRangesDiffWithRestResponseAsync(
context, null, null, prevSnapshot, blobRange.toHeaderValue(), null,
accessConditions.leaseAccessConditions(), accessConditions.modifiedAccessConditions()));
}
/**
* Resizes the page blob to the specified size (which must be a multiple of 512).
* For more information, see the Azure Docs.
*
* @param 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.
*
* @return Emits the successful response.
*
* @apiNote ## 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/master/src/test/java/com/microsoft/azure/storage/Samples.java)
*/
public Single resize(long size) {
return this.resize(size, null, null);
}
/**
* Resizes the page blob to the specified size (which must be a multiple of 512).
* For more information, see the Azure Docs.
*
* @param 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.
* @param accessConditions
* {@link BlobAccessConditions}
* @param context
* {@code Context} offers a means of passing arbitrary data (key/value pairs) to an
* {@link com.microsoft.rest.v2.http.HttpPipeline}'s policy objects. Most applications do not need to pass
* arbitrary data to the pipeline and can pass {@code Context.NONE} or {@code null}. Each context object is
* immutable. The {@code withContext} with data method creates a new {@code Context} object that refers to
* its parent, forming a linked list.
*
* @return Emits the successful response.
*
* @apiNote ## 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/master/src/test/java/com/microsoft/azure/storage/Samples.java)
*/
public Single resize(long size, BlobAccessConditions accessConditions, Context context) {
if (size % PageBlobURL.PAGE_BYTES != 0) {
// Throwing is preferred to Single.error because this will error out immediately instead of waiting until
// subscription.
throw new IllegalArgumentException("size must be a multiple of PageBlobURL.PAGE_BYTES.");
}
accessConditions = accessConditions == null ? new BlobAccessConditions() : accessConditions;
context = context == null ? Context.NONE : context;
return postProcessResponse(this.storageClient.generatedPageBlobs().resizeWithRestResponseAsync(
context, size, null, null, accessConditions.leaseAccessConditions(),
accessConditions.modifiedAccessConditions()));
}
/**
* Sets the page blob's sequence number.
* For more information, see the Azure Docs.
*
* @param action
* Indicates how the service should modify the blob's sequence number.
* @param 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.
*
* @return Emits the successful response.
*
* @apiNote ## 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/master/src/test/java/com/microsoft/azure/storage/Samples.java)
*/
public Single updateSequenceNumber(SequenceNumberActionType action,
Long sequenceNumber) {
return this.updateSequenceNumber(action, sequenceNumber, null, null);
}
/**
* Sets the page blob's sequence number.
* For more information, see the Azure Docs.
*
* @param action
* Indicates how the service should modify the blob's sequence number.
* @param 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.
* @param accessConditions
* {@link BlobAccessConditions}
* @param context
* {@code Context} offers a means of passing arbitrary data (key/value pairs) to an
* {@link com.microsoft.rest.v2.http.HttpPipeline}'s policy objects. Most applications do not need to pass
* arbitrary data to the pipeline and can pass {@code Context.NONE} or {@code null}. Each context object is
* immutable. The {@code withContext} with data method creates a new {@code Context} object that refers to
* its parent, forming a linked list.
*
* @return Emits the successful response.
*
* @apiNote ## 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/master/src/test/java/com/microsoft/azure/storage/Samples.java)
*/
public Single updateSequenceNumber(SequenceNumberActionType action,
Long sequenceNumber, BlobAccessConditions accessConditions, Context context) {
if (sequenceNumber != null && sequenceNumber < 0) {
// Throwing is preferred to Single.error because this will error out immediately instead of waiting until
// subscription.
throw new IllegalArgumentException("SequenceNumber must be greater than or equal to 0.");
}
accessConditions = accessConditions == null ? new BlobAccessConditions() : accessConditions;
sequenceNumber = action == SequenceNumberActionType.INCREMENT ? null : sequenceNumber;
context = context == null ? Context.NONE : context;
return postProcessResponse(
this.storageClient.generatedPageBlobs().updateSequenceNumberWithRestResponseAsync(context,
action, null, sequenceNumber, null, accessConditions.leaseAccessConditions(),
accessConditions.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.
*
* @param source
* The source page blob.
* @param snapshot
* The snapshot on the copy source.
*
* @return Emits the successful response.
*/
public Single copyIncremental(URL source, String snapshot) {
return this.copyIncremental(source, snapshot, null, null);
}
/**
* 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.
*
* @param source
* The source page blob.
* @param snapshot
* The snapshot on the copy source.
* @param 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.
* @param context
* {@code Context} offers a means of passing arbitrary data (key/value pairs) to an
* {@link com.microsoft.rest.v2.http.HttpPipeline}'s policy objects. Most applications do not need to pass
* arbitrary data to the pipeline and can pass {@code Context.NONE} or {@code null}. Each context object is
* immutable. The {@code withContext} with data method creates a new {@code Context} object that refers to its
* parent, forming a linked list.
*
* @return Emits the successful response.
*/
public Single copyIncremental(URL source, String snapshot,
ModifiedAccessConditions modifiedAccessConditions, Context context) {
context = context == null ? Context.NONE : context;
UrlBuilder builder = UrlBuilder.parse(source);
builder.setQueryParameter(Constants.SNAPSHOT_QUERY_PARAMETER, snapshot);
try {
source = builder.toURL();
} catch (MalformedURLException e) {
// We are parsing a valid url and adding a query parameter. If this fails, we can't recover.
throw new Error(e);
}
return postProcessResponse(this.storageClient.generatedPageBlobs().copyIncrementalWithRestResponseAsync(
context, source, null, null, modifiedAccessConditions));
}
}