PageBlobUploadPagesFromUrlOptions Class

Package:

com.azure.storage.blob.options

Maven Artifact:

com.azure:azure-storage-blob:12.34.0

• java.lang.Object
• • com.azure.storage.blob.options.PageBlobUploadPagesFromUrlOptions

public final class PageBlobUploadPagesFromUrlOptions

Extended options that may be passed when uploading a page range from a source URL.

Constructor Summary

Constructor	Description
PageBlobUploadPagesFromUrlOptions(PageRange range, String sourceUrl)	Creates a new instance of PageBlobUploadPagesFromUrlOptions.

Method Summary

Modifier and Type	Method and Description
PageBlobRequestConditions	getDestinationRequestConditions() Gets PageBlobRequestConditions for writing to destination.
PageRange	getRange() Gets the destination page range.
HttpAuthorization	getSourceAuthorization() Gets "Authorization" header for accessing source URL.
byte[]	getSourceContentMd5() Gets the content MD5 of source content to copy.
CustomerProvidedKey	getSourceCustomerProvidedKey() Gets the optional CustomerProvidedKey used for encrypting the source blob.
Long	getSourceOffset() Gets the offset at source to copy from.
BlobRequestConditions	getSourceRequestConditions() Gets BlobRequestConditions for accessing source content.
FileShareTokenIntent	getSourceShareTokenIntent() Optional, only applicable (but required) when the source is Azure Storage Files and using token authentication.
String	getSourceUrl() Gets the source URL to copy from.
PageBlobUploadPagesFromUrlOptions	setDestinationRequestConditions(PageBlobRequestConditions destinationRequestConditions) Sets PageBlobRequestConditions for writing to destination.
PageBlobUploadPagesFromUrlOptions	setSourceAuthorization(HttpAuthorization sourceAuthorization) Sets "Authorization" header for accessing source URL.
PageBlobUploadPagesFromUrlOptions	setSourceContentMd5(byte[] sourceContentMd5) Sets the content MD5 of source content to copy.
PageBlobUploadPagesFromUrlOptions	setSourceCustomerProvidedKey(CustomerProvidedKey sourceCustomerProvidedKey) Sets the optional CustomerProvidedKey used for encrypting the source blob.
PageBlobUploadPagesFromUrlOptions	setSourceOffset(Long sourceOffset) Sets the offset at source to copy from.
PageBlobUploadPagesFromUrlOptions	setSourceRequestConditions(BlobRequestConditions sourceRequestConditions) Sets BlobRequestConditions for accessing source content.
PageBlobUploadPagesFromUrlOptions	setSourceShareTokenIntent(FileShareTokenIntent sourceShareTokenIntent) Optional, only applicable (but required) when the source is Azure Storage Files and using token authentication.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

PageBlobUploadPagesFromUrlOptions

public PageBlobUploadPagesFromUrlOptions(PageRange range, String sourceUrl)

Creates a new instance of PageBlobUploadPagesFromUrlOptions.

Parameters:

range - The destination page range. Pages must be aligned to 512 byte blocks.

sourceUrl - The source URL to copy from. URLs outside of Azure may only be copied to block blobs.

Method Details

getDestinationRequestConditions

public PageBlobRequestConditions getDestinationRequestConditions()

Gets PageBlobRequestConditions for writing to destination.

Returns:

PageBlobRequestConditions for writing to destination.

getRange

public PageRange getRange()

Gets the destination page range.

Returns:

The destination page range.

getSourceAuthorization

public HttpAuthorization getSourceAuthorization()

Gets "Authorization" header for accessing source URL. Currently only "Bearer" authentication is accepted by Storage.

Returns:

auth header for accessing source content.

getSourceContentMd5

public byte[] getSourceContentMd5()

Gets the content MD5 of source content to copy.

Returns:

Content MD5 of source content to copy.

getSourceCustomerProvidedKey

public CustomerProvidedKey getSourceCustomerProvidedKey()

Gets the optional CustomerProvidedKey used for encrypting the source blob. Applicable only for service version 2026-02-06 or later.

Returns:

the CustomerProvidedKey used for encrypting the source blob.

getSourceOffset

public Long getSourceOffset()

Gets the offset at source to copy from.

Returns:

Offset at source to copy from.

getSourceRequestConditions

public BlobRequestConditions getSourceRequestConditions()

Gets BlobRequestConditions for accessing source content.

Returns:

BlobRequestConditions for accessing source content.

getSourceShareTokenIntent

public FileShareTokenIntent getSourceShareTokenIntent()

Optional, only applicable (but required) when the source is Azure Storage Files and using token authentication. Gets the intent of the request.

Returns:

the FileShareTokenIntent for the file share.

getSourceUrl

public String getSourceUrl()

Gets the source URL to copy from.

Returns:

the source URL to copy from.

setDestinationRequestConditions

public PageBlobUploadPagesFromUrlOptions setDestinationRequestConditions(PageBlobRequestConditions destinationRequestConditions)

Sets PageBlobRequestConditions for writing to destination.

Parameters:

destinationRequestConditions - PageBlobRequestConditions for writing to destination.

Returns:

The updated options.

setSourceAuthorization

public PageBlobUploadPagesFromUrlOptions setSourceAuthorization(HttpAuthorization sourceAuthorization)

Sets "Authorization" header for accessing source URL. Currently only "Bearer" authentication is accepted by Storage.

Parameters:

sourceAuthorization - auth header for accessing source content.

Returns:

The updated options.

setSourceContentMd5

public PageBlobUploadPagesFromUrlOptions setSourceContentMd5(byte[] sourceContentMd5)

Sets the content MD5 of source content to copy.

Parameters:

sourceContentMd5 - Content MD5 of source content to copy.

Returns:

The updated options.

setSourceCustomerProvidedKey

public PageBlobUploadPagesFromUrlOptions setSourceCustomerProvidedKey(CustomerProvidedKey sourceCustomerProvidedKey)

Sets the optional CustomerProvidedKey used for encrypting the source blob. Applicable only for service version 2026-02-06 or later.

Parameters:

sourceCustomerProvidedKey - The CustomerProvidedKey used for encrypting the source blob.

Returns:

The updated options.

setSourceOffset

public PageBlobUploadPagesFromUrlOptions setSourceOffset(Long sourceOffset)

Sets the offset at source to copy from.

Parameters:

sourceOffset - Offset at source to copy from.

Returns:

The updated options.

setSourceRequestConditions

public PageBlobUploadPagesFromUrlOptions setSourceRequestConditions(BlobRequestConditions sourceRequestConditions)

Sets BlobRequestConditions for accessing source content.

Parameters:

sourceRequestConditions - BlobRequestConditions for accessing source content.

Returns:

The updated options.

setSourceShareTokenIntent

public PageBlobUploadPagesFromUrlOptions setSourceShareTokenIntent(FileShareTokenIntent sourceShareTokenIntent)

Optional, only applicable (but required) when the source is Azure Storage Files and using token authentication. Sets the intent of the request.

Parameters:

sourceShareTokenIntent - Used to indicate the intent of the request.

Returns:

The updated options.