PageBlobClient.java
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
package com.azure.storage.blob.specialized;
import com.azure.core.annotation.ServiceClient;
import com.azure.core.exception.UnexpectedLengthException;
import com.azure.core.http.RequestConditions;
import com.azure.core.http.rest.Response;
import com.azure.core.util.Context;
import com.azure.storage.blob.BlobClient;
import com.azure.storage.blob.implementation.util.ModelHelper;
import com.azure.storage.blob.models.BlobHttpHeaders;
import com.azure.storage.blob.models.BlobRange;
import com.azure.storage.blob.models.BlobRequestConditions;
import com.azure.storage.blob.models.BlobStorageException;
import com.azure.storage.blob.models.CopyStatusType;
import com.azure.storage.blob.options.PageBlobCopyIncrementalOptions;
import com.azure.storage.blob.options.PageBlobCreateOptions;
import com.azure.storage.blob.models.PageBlobItem;
import com.azure.storage.blob.models.PageBlobRequestConditions;
import com.azure.storage.blob.models.PageList;
import com.azure.storage.blob.models.PageRange;
import com.azure.storage.blob.models.SequenceNumberActionType;
import com.azure.storage.common.Utility;
import com.azure.storage.common.implementation.Constants;
import com.azure.storage.common.implementation.StorageImplUtils;
import reactor.core.publisher.Flux;
import reactor.core.publisher.Mono;
import reactor.core.scheduler.Schedulers;
import java.io.InputStream;
import java.net.URL;
import java.nio.ByteBuffer;
import java.time.Duration;
import java.util.Map;
import java.util.Objects;
/**
* Client to a page blob. It may only be instantiated through a {@link SpecializedBlobClientBuilder} or via the method
* {@link BlobClient#getPageBlobClient()}. 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.
*
* <p>
* Please refer to the <a href=https://docs.microsoft.com/en-us/rest/api/storageservices/understanding-block-blobs--append-blobs--and-page-blobs>Azure
* Docs</a> for more information.
*/
@ServiceClient(builder = SpecializedBlobClientBuilder.class)
public final class PageBlobClient extends BlobClientBase {
private final PageBlobAsyncClient pageBlobAsyncClient;
/**
* Indicates the number of bytes in a page.
*/
public static final int PAGE_BYTES = PageBlobAsyncClient.PAGE_BYTES;
/**
* Indicates the maximum number of bytes that may be sent in a call to putPage.
*/
public static final int MAX_PUT_PAGES_BYTES = PageBlobAsyncClient.MAX_PUT_PAGES_BYTES;
/**
* Package-private constructor for use by {@link SpecializedBlobClientBuilder}.
*
* @param pageBlobAsyncClient the async page blob client
*/
PageBlobClient(PageBlobAsyncClient pageBlobAsyncClient) {
super(pageBlobAsyncClient);
this.pageBlobAsyncClient = pageBlobAsyncClient;
}
/**
* 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.
*
* @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 A {@link BlobOutputStream} object used to write data to the blob.
* @throws BlobStorageException If a storage service error occurred.
*/
public BlobOutputStream getBlobOutputStream(PageRange pageRange) {
return getBlobOutputStream(pageRange, null);
}
/**
* 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.
*
* @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 requestConditions A {@link BlobRequestConditions} object that represents the access conditions for the
* blob.
* @return A {@link BlobOutputStream} object used to write data to the blob.
* @throws BlobStorageException If a storage service error occurred.
*/
public BlobOutputStream getBlobOutputStream(PageRange pageRange, BlobRequestConditions requestConditions) {
return BlobOutputStream.pageBlobOutputStream(pageBlobAsyncClient, pageRange, requestConditions);
}
/**
* Creates a page blob of the specified length. By default this method will not overwrite an existing blob.
* Call PutPage to upload data data to a page blob. For more information, see the
* <a href="https://docs.microsoft.com/rest/api/storageservices/put-blob">Azure Docs</a>.
*
* <p><strong>Code Samples</strong></p>
*
* {@codesnippet com.azure.storage.blob.PageBlobClient.create#long}
*
* @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 The information of the created page blob.
*/
public PageBlobItem create(long size) {
return create(size, false);
}
/**
* Creates a page blob of the specified length. Call PutPage to upload data data to a page blob. For more
* information, see the
* <a href="https://docs.microsoft.com/rest/api/storageservices/put-blob">Azure Docs</a>.
*
* <p><strong>Code Samples</strong></p>
*
* {@codesnippet com.azure.storage.blob.PageBlobClient.create#long-boolean}
*
* @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 overwrite Whether or not to overwrite, should data exist on the blob.
* @return The information of the created page blob.
*/
public PageBlobItem create(long size, boolean overwrite) {
BlobRequestConditions blobRequestConditions = new BlobRequestConditions();
if (!overwrite) {
blobRequestConditions.setIfNoneMatch(Constants.HeaderConstants.ETAG_WILDCARD);
}
return createWithResponse(size, null, null, null, blobRequestConditions, null, Context.NONE).getValue();
}
/**
* Creates a page blob of the specified length. Call PutPage to upload data data to a page blob. For more
* information, see the
* <a href="https://docs.microsoft.com/rest/api/storageservices/put-blob">Azure Docs</a>.
* <p>
* To avoid overwriting, pass "*" to {@link BlobRequestConditions#setIfNoneMatch(String)}.
*
* <p><strong>Code Samples</strong></p>
*
* {@codesnippet com.azure.storage.blob.specialized.PageBlobClient.createWithResponse#long-Long-BlobHttpHeaders-Map-BlobRequestConditions-Duration-Context}
*
* @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 Metadata to associate with the blob. If there is leading or trailing whitespace in any
* metadata key or value, it must be removed or encoded.
* @param requestConditions {@link BlobRequestConditions}
* @param timeout An optional timeout value beyond which a {@link RuntimeException} will be raised.
* @param context Additional context that is passed through the Http pipeline during the service call.
* @return The information of the created page blob.
*/
public Response<PageBlobItem> createWithResponse(long size, Long sequenceNumber, BlobHttpHeaders headers,
Map<String, String> metadata, BlobRequestConditions requestConditions, Duration timeout, Context context) {
return this.createWithResponse(new PageBlobCreateOptions(size).setSequenceNumber(sequenceNumber)
.setHeaders(headers).setMetadata(metadata).setRequestConditions(requestConditions), timeout,
context);
}
/**
* Creates a page blob of the specified length. Call PutPage to upload data data to a page blob. For more
* information, see the
* <a href="https://docs.microsoft.com/rest/api/storageservices/put-blob">Azure Docs</a>.
* <p>
* To avoid overwriting, pass "*" to {@link BlobRequestConditions#setIfNoneMatch(String)}.
*
* <p><strong>Code Samples</strong></p>
*
* {@codesnippet com.azure.storage.blob.specialized.PageBlobClient.createWithResponse#PageBlobCreateOptions-Duration-Context}
*
* @param options {@link PageBlobCreateOptions}
* @param timeout An optional timeout value beyond which a {@link RuntimeException} will be raised.
* @param context Additional context that is passed through the Http pipeline during the service call.
* @return The information of the created page blob.
*/
public Response<PageBlobItem> createWithResponse(PageBlobCreateOptions options, Duration timeout, Context context) {
Mono<Response<PageBlobItem>> response = pageBlobAsyncClient.createWithResponse(options, context);
return StorageImplUtils.blockWithOptionalTimeout(response, timeout);
}
/**
* Writes one or more pages to the page blob. The write size must be a multiple of 512. For more information, see
* the <a href="https://docs.microsoft.com/rest/api/storageservices/put-page">Azure Docs</a>.
* <p>
* Note that the data passed must be replayable if retries are enabled (the default). In other words, the
* {@code Flux} must produce the same data each time it is subscribed to.
*
* <p><strong>Code Samples</strong></p>
*
* {@codesnippet com.azure.storage.blob.specialized.PageBlobClient.uploadPages#PageRange-InputStream}
*
* @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. The data must be markable. This is in order to support retries. If
* the data is not markable, consider using {@link #getBlobOutputStream(PageRange)} and writing to the returned
* OutputStream. Alternatively, consider wrapping your data source in a {@link java.io.BufferedInputStream} to add
* mark support.
* @return The information of the uploaded pages.
*/
public PageBlobItem uploadPages(PageRange pageRange, InputStream body) {
return uploadPagesWithResponse(pageRange, body, null, null, null, Context.NONE).getValue();
}
/**
* Writes one or more pages to the page blob. The write size must be a multiple of 512. For more information, see
* the <a href="https://docs.microsoft.com/rest/api/storageservices/put-page">Azure Docs</a>.
* <p>
* Note that the data passed must be replayable if retries are enabled (the default). In other words, the
* {@code Flux} must produce the same data each time it is subscribed to.
*
* <p><strong>Code Samples</strong></p>
*
* {@codesnippet com.azure.storage.blob.specialized.PageBlobClient.uploadPagesWithResponse#PageRange-InputStream-byte-PageBlobRequestConditions-Duration-Context}
*
* @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. The data must be markable. This is in order to support retries. If
* the data is not markable, consider using {@link #getBlobOutputStream(PageRange)} and writing to the returned
* OutputStream. Alternatively, consider wrapping your data source in a {@link java.io.BufferedInputStream} to add
* mark support.
* @param contentMd5 An MD5 hash of the page content. This hash is used to verify the integrity of the page during
* transport. When this header is specified, the storage service compares the hash of the content that has arrived
* with this header value. Note that this MD5 hash is not stored with the blob. If the two hashes do not match, the
* operation will fail.
* @param pageBlobRequestConditions {@link PageBlobRequestConditions}
* @param timeout An optional timeout value beyond which a {@link RuntimeException} will be raised.
* @param context Additional context that is passed through the Http pipeline during the service call.
* @return The information of the uploaded pages.
* @throws UnexpectedLengthException when the length of data does not match the input {@code length}.
* @throws NullPointerException if the input data is null.
*/
public Response<PageBlobItem> uploadPagesWithResponse(PageRange pageRange, InputStream body, byte[] contentMd5,
PageBlobRequestConditions pageBlobRequestConditions, Duration timeout, Context context) {
Objects.requireNonNull(body, "'body' cannot be null.");
final long length = pageRange.getEnd() - pageRange.getStart() + 1;
Flux<ByteBuffer> fbb = Utility.convertStreamToByteBuffer(body, length, PAGE_BYTES, true);
Mono<Response<PageBlobItem>> response = pageBlobAsyncClient.uploadPagesWithResponse(pageRange,
fbb.subscribeOn(Schedulers.elastic()), contentMd5, pageBlobRequestConditions, context);
return StorageImplUtils.blockWithOptionalTimeout(response, timeout);
}
/**
* Writes one or more pages from the source page blob to this page blob. The write size must be a multiple of 512.
* For more information, see the
* <a href="https://docs.microsoft.com/rest/api/storageservices/put-page">Azure Docs</a>.
*
* <p><strong>Code Samples</strong></p>
*
* {@codesnippet com.azure.storage.blob.specialized.PageBlobClient.uploadPagesFromUrl#PageRange-String-Long}
*
* @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 The information of the uploaded pages.
* @throws IllegalArgumentException If {@code sourceUrl} is a malformed {@link URL}.
*/
public PageBlobItem uploadPagesFromUrl(PageRange range, String sourceUrl, Long sourceOffset) {
return uploadPagesFromUrlWithResponse(range, sourceUrl, sourceOffset, null, null, null, null, Context.NONE)
.getValue();
}
/**
* Writes one or more pages from the source page blob to this page blob. The write size must be a multiple of 512.
* For more information, see the
* <a href="https://docs.microsoft.com/rest/api/storageservices/put-page">Azure Docs</a>.
*
* <p><strong>Code Samples</strong></p>
*
* {@codesnippet com.azure.storage.blob.specialized.PageBlobClient.uploadPagesFromUrlWithResponse#PageRange-String-Long-byte-PageBlobRequestConditions-BlobRequestConditions-Duration-Context}
*
* @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 destRequestConditions {@link PageBlobRequestConditions}
* @param sourceRequestConditions {@link BlobRequestConditions}
* @param timeout An optional timeout value beyond which a {@link RuntimeException} will be raised.
* @param context Additional context that is passed through the Http pipeline during the service call.
* @return The information of the uploaded pages.
* @throws IllegalArgumentException If {@code sourceUrl} is a malformed {@link URL}.
*/
public Response<PageBlobItem> uploadPagesFromUrlWithResponse(PageRange range, String sourceUrl, Long sourceOffset,
byte[] sourceContentMd5, PageBlobRequestConditions destRequestConditions,
BlobRequestConditions sourceRequestConditions, Duration timeout, Context context) {
Mono<Response<PageBlobItem>> response = pageBlobAsyncClient.uploadPagesFromUrlWithResponse(range, sourceUrl,
sourceOffset, sourceContentMd5, destRequestConditions, sourceRequestConditions, context);
return StorageImplUtils.blockWithOptionalTimeout(response, timeout);
}
/**
* Frees the specified pages from the page blob. The size of the range must be a multiple of 512. For more
* information, see the <a href="https://docs.microsoft.com/rest/api/storageservices/put-page">Azure Docs</a>.
*
* <p><strong>Code Samples</strong></p>
*
* {@codesnippet com.azure.storage.blob.specialized.PageBlobClient.clearPages#PageRange}
*
* @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 The information of the cleared pages.
*/
public PageBlobItem clearPages(PageRange pageRange) {
return clearPagesWithResponse(pageRange, null, null, Context.NONE).getValue();
}
/**
* Frees the specified pages from the page blob. The size of the range must be a multiple of 512. For more
* information, see the <a href="https://docs.microsoft.com/rest/api/storageservices/put-page">Azure Docs</a>.
*
* <p><strong>Code Samples</strong></p>
*
* {@codesnippet com.azure.storage.blob.specialized.PageBlobClient.clearPagesWithResponse#PageRange-PageBlobRequestConditions-Duration-Context}
*
* @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 timeout An optional timeout value beyond which a {@link RuntimeException} will be raised.
* @param pageBlobRequestConditions {@link PageBlobRequestConditions}
* @param context Additional context that is passed through the Http pipeline during the service call.
* @return The information of the cleared pages.
*/
public Response<PageBlobItem> clearPagesWithResponse(PageRange pageRange,
PageBlobRequestConditions pageBlobRequestConditions, Duration timeout, Context context) {
Mono<Response<PageBlobItem>> response = pageBlobAsyncClient.clearPagesWithResponse(pageRange,
pageBlobRequestConditions, context);
return StorageImplUtils.blockWithOptionalTimeout(response, timeout);
}
/**
* Returns the list of valid page ranges for a page blob or snapshot of a page blob. For more information, see the
* <a href="https://docs.microsoft.com/rest/api/storageservices/get-page-ranges">Azure Docs</a>.
*
* <p><strong>Code Samples</strong></p>
*
* {@codesnippet com.azure.storage.blob.specialized.PageBlobClient.getPageRanges#BlobRange}
*
* @param blobRange {@link BlobRange}
* @return The information of the cleared pages.
*/
public PageList getPageRanges(BlobRange blobRange) {
return getPageRangesWithResponse(blobRange, null, null, Context.NONE).getValue();
}
/**
* Returns the list of valid page ranges for a page blob or snapshot of a page blob. For more information, see the
* <a href="https://docs.microsoft.com/rest/api/storageservices/get-page-ranges">Azure Docs</a>.
*
* <p><strong>Code Samples</strong></p>
*
* {@codesnippet com.azure.storage.blob.specialized.PageBlobClient.getPageRangesWithResponse#BlobRange-BlobRequestConditions-Duration-Context}
*
* @param blobRange {@link BlobRange}
* @param requestConditions {@link BlobRequestConditions}
* @param timeout An optional timeout value beyond which a {@link RuntimeException} will be raised.
* @param context Additional context that is passed through the Http pipeline during the service call.
* @return All the page ranges.
*/
public Response<PageList> getPageRangesWithResponse(BlobRange blobRange, BlobRequestConditions requestConditions,
Duration timeout, Context context) {
return StorageImplUtils.blockWithOptionalTimeout(pageBlobAsyncClient
.getPageRangesWithResponse(blobRange, requestConditions, context), timeout);
}
/**
* Gets the collection of page ranges that differ between a specified snapshot and this page blob. For more
* information, see the <a href="https://docs.microsoft.com/rest/api/storageservices/get-page-ranges">Azure
* Docs</a>.
*
* <p><strong>Code Samples</strong></p>
*
* {@codesnippet com.azure.storage.blob.specialized.PageBlobClient.getPageRangesDiff#BlobRange-String}
*
* @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 All the different page ranges.
*/
public PageList getPageRangesDiff(BlobRange blobRange, String prevSnapshot) {
return getPageRangesDiffWithResponse(blobRange, prevSnapshot, null, null, Context.NONE).getValue();
}
/**
* This API only works for managed disk accounts.
* <p>Gets the collection of page ranges that differ between a specified snapshot and this page blob. For more
* information, see the <a href="https://docs.microsoft.com/rest/api/storageservices/get-page-ranges">Azure
* Docs</a>.</p>
*
* <p><strong>Code Samples</strong></p>
*
* {@codesnippet com.azure.storage.blob.specialized.PageBlobClient.getPageRangesDiffWithResponse#BlobRange-String-BlobRequestConditions-Duration-Context}
*
* @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 requestConditions {@link BlobRequestConditions}
* @param timeout An optional timeout value beyond which a {@link RuntimeException} will be raised.
* @param context Additional context that is passed through the Http pipeline during the service call.
* @return All the different page ranges.
*/
public Response<PageList> getPageRangesDiffWithResponse(BlobRange blobRange, String prevSnapshot,
BlobRequestConditions requestConditions, Duration timeout, Context context) {
return StorageImplUtils.blockWithOptionalTimeout(pageBlobAsyncClient
.getPageRangesDiffWithResponse(blobRange, prevSnapshot, null, requestConditions, context),
timeout);
}
/**
* This API only works for managed disk accounts.
* <p>Gets the collection of page ranges that differ between a specified snapshot and this page blob. For more
* information, see the <a href="https://docs.microsoft.com/rest/api/storageservices/get-page-ranges">Azure
* Docs</a>.</p>
*
* <p><strong>Code Samples</strong></p>
*
* {@codesnippet com.azure.storage.blob.specialized.PageBlobClient.getManagedDiskPageRangesDiff#BlobRange-String}
*
* @param blobRange {@link BlobRange}
* @param prevSnapshotUrl Specifies the URL of a previous snapshot of the target blob. 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 All the different page ranges.
*/
public PageList getManagedDiskPageRangesDiff(BlobRange blobRange, String prevSnapshotUrl) {
return getManagedDiskPageRangesDiffWithResponse(blobRange, prevSnapshotUrl, null, null, Context.NONE)
.getValue();
}
/**
* This API only works for managed disk accounts.
* <p>Gets the collection of page ranges that differ between a specified snapshot and this page blob. For more
* information, see the <a href="https://docs.microsoft.com/rest/api/storageservices/get-page-ranges">Azure
* Docs</a>.</p>
*
* <p><strong>Code Samples</strong></p>
*
* {@codesnippet com.azure.storage.blob.specialized.PageBlobClient.getManagedDiskPageRangesDiffWithResponse#BlobRange-String-BlobRequestConditions-Duration-Context}
*
* @param blobRange {@link BlobRange}
* @param prevSnapshotUrl Specifies the URL of a previous snapshot of the target blob. 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 requestConditions {@link BlobRequestConditions}
* @param timeout An optional timeout value beyond which a {@link RuntimeException} will be raised.
* @param context Additional context that is passed through the Http pipeline during the service call.
* @return All the different page ranges.
*/
public Response<PageList> getManagedDiskPageRangesDiffWithResponse(BlobRange blobRange, String prevSnapshotUrl,
BlobRequestConditions requestConditions, Duration timeout, Context context) {
return StorageImplUtils.blockWithOptionalTimeout(pageBlobAsyncClient
.getPageRangesDiffWithResponse(blobRange, null, prevSnapshotUrl, requestConditions, context),
timeout);
}
/**
* Resizes the page blob to the specified size (which must be a multiple of 512). For more information, see the <a
* href="https://docs.microsoft.com/rest/api/storageservices/set-blob-properties">Azure Docs</a>.
*
* <p><strong>Code Samples</strong></p>
*
* {@codesnippet com.azure.storage.blob.specialized.PageBlobClient.resize#long}
*
* @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 The resized page blob.
*/
public PageBlobItem resize(long size) {
return resizeWithResponse(size, null, null, Context.NONE).getValue();
}
/**
* Resizes the page blob to the specified size (which must be a multiple of 512). For more information, see the <a
* href="https://docs.microsoft.com/rest/api/storageservices/set-blob-properties">Azure Docs</a>.
*
* <p><strong>Code Samples</strong></p>
*
* {@codesnippet com.azure.storage.blob.specialized.PageBlobClient.resizeWithResponse#long-BlobRequestConditions-Duration-Context}
*
* @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 requestConditions {@link BlobRequestConditions}
* @param timeout An optional timeout value beyond which a {@link RuntimeException} will be raised.
* @param context Additional context that is passed through the Http pipeline during the service call.
* @return The resized page blob.
*/
public Response<PageBlobItem> resizeWithResponse(long size, BlobRequestConditions requestConditions,
Duration timeout, Context context) {
Mono<Response<PageBlobItem>> response = pageBlobAsyncClient.resizeWithResponse(size, requestConditions,
context);
return StorageImplUtils.blockWithOptionalTimeout(response, timeout);
}
/**
* Sets the page blob's sequence number. For more information, see the <a href="https://docs.microsoft.com/rest/api/storageservices/set-blob-properties">Azure
* Docs</a>.
*
* <p><strong>Code Samples</strong></p>
*
* {@codesnippet com.azure.storage.blob.specialized.PageBlobClient.updateSequenceNumber#SequenceNumberActionType-Long}
*
* @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 The updated page blob.
*/
public PageBlobItem updateSequenceNumber(SequenceNumberActionType action,
Long sequenceNumber) {
return updateSequenceNumberWithResponse(action, sequenceNumber, null, null, Context.NONE).getValue();
}
/**
* Sets the page blob's sequence number. For more information, see the <a href="https://docs.microsoft.com/rest/api/storageservices/set-blob-properties">Azure
* Docs</a>.
*
* <p><strong>Code Samples</strong></p>
*
* {@codesnippet com.azure.storage.blob.specialized.PageBlobClient.updateSequenceNumberWithResponse#SequenceNumberActionType-Long-BlobRequestConditions-Duration-Context}
*
* @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 requestConditions {@link BlobRequestConditions}
* @param timeout An optional timeout value beyond which a {@link RuntimeException} will be raised.
* @param context Additional context that is passed through the Http pipeline during the service call.
* @return The updated page blob.
*/
public Response<PageBlobItem> updateSequenceNumberWithResponse(SequenceNumberActionType action,
Long sequenceNumber, BlobRequestConditions requestConditions, Duration timeout, Context context) {
Mono<Response<PageBlobItem>> response = pageBlobAsyncClient
.updateSequenceNumberWithResponse(action, sequenceNumber, requestConditions, context);
return StorageImplUtils.blockWithOptionalTimeout(response, timeout);
}
/**
* 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 <a href="https://docs.microsoft.com/rest/api/storageservices/incremental-copy-blob">here</a>
* and
* <a href="https://docs.microsoft.com/en-us/azure/virtual-machines/windows/incremental-snapshots">here</a>.
*
* <p><strong>Code Samples</strong></p>
*
* {@codesnippet com.azure.storage.blob.specialized.PageBlobClient.copyIncremental#String-String}
*
* @param source The source page blob.
* @param snapshot The snapshot on the copy source.
* @return The copy status.
* @throws IllegalArgumentException If {@code source} is a malformed {@link URL}.
*/
public CopyStatusType copyIncremental(String source, String snapshot) {
return copyIncrementalWithResponse(source, snapshot, null, null, Context.NONE).getValue();
}
/**
* 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 <a href="https://docs.microsoft.com/rest/api/storageservices/incremental-copy-blob">here</a>
* and
* <a href="https://docs.microsoft.com/en-us/azure/virtual-machines/windows/incremental-snapshots">here</a>.
*
* <p><strong>Code Samples</strong></p>
*
* {@codesnippet com.azure.storage.blob.specialized.PageBlobClient.copyIncrementalWithResponse#String-String-RequestConditions-Duration-Context}
*
* @param source The source page blob.
* @param snapshot The snapshot on the copy source.
* @param modifiedRequestConditions 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 timeout An optional timeout value beyond which a {@link RuntimeException} will be raised.
* @param context Additional context that is passed through the Http pipeline during the service call.
* @return The copy status.
* @throws IllegalArgumentException If {@code source} is a malformed {@link URL}.
*/
public Response<CopyStatusType> copyIncrementalWithResponse(String source, String snapshot,
RequestConditions modifiedRequestConditions, Duration timeout, Context context) {
return copyIncrementalWithResponse(new PageBlobCopyIncrementalOptions(source, snapshot)
.setRequestConditions(
ModelHelper.populateBlobDestinationRequestConditions(modifiedRequestConditions)),
timeout, 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 <a href="https://docs.microsoft.com/rest/api/storageservices/incremental-copy-blob">here</a>
* and
* <a href="https://docs.microsoft.com/en-us/azure/virtual-machines/windows/incremental-snapshots">here</a>.
*
* <p><strong>Code Samples</strong></p>
*
* {@codesnippet com.azure.storage.blob.specialized.PageBlobClient.copyIncrementalWithResponse#PageBlobCopyIncrementalOptions-Duration-Context}
*
* @param options {@link PageBlobCopyIncrementalOptions}
* @param timeout An optional timeout value beyond which a {@link RuntimeException} will be raised.
* @param context Additional context that is passed through the Http pipeline during the service call.
* @return The copy status.
* @throws IllegalArgumentException If {@code source} is a malformed {@link URL}.
*/
public Response<CopyStatusType> copyIncrementalWithResponse(PageBlobCopyIncrementalOptions options,
Duration timeout, Context context) {
Mono<Response<CopyStatusType>> response = pageBlobAsyncClient.copyIncrementalWithResponse(options, context);
return StorageImplUtils.blockWithOptionalTimeout(response, timeout);
}
}