BlobUploadFromUrlOptions Class

  • Reference
Package:
com.azure.storage.blob.options
Maven Artifact:
com.azure:azure-storage-blob:12.28.1
  • java.lang.Object
    • com.azure.storage.blob.options.BlobUploadFromUrlOptions

public class BlobUploadFromUrlOptions

Extended options that may be passed when uploading a Block Blob from URL.

Constructor Summary

Constructor Description
BlobUploadFromUrlOptions(String sourceUrl)

Method Summary

Modifier and Type Method and Description
byte[] getContentMd5()
BlobCopySourceTagsMode getCopySourceTagsMode()
BlobRequestConditions getDestinationRequestConditions()
BlobHttpHeaders getHeaders()
HttpAuthorization getSourceAuthorization()
BlobRequestConditions getSourceRequestConditions()
String getSourceUrl()
Map<String,String> getTags()
AccessTier getTier()
Boolean isCopySourceBlobProperties()

Optional, default is true.
BlobUploadFromUrlOptions setContentMd5(byte[] contentMd5)
BlobUploadFromUrlOptions setCopySourceBlobProperties(Boolean copySourceBlobProperties)

Optional, default is true.
BlobUploadFromUrlOptions setCopySourceTagsMode(BlobCopySourceTagsMode copySourceTags)

Sets the copy source tags mode
BlobUploadFromUrlOptions setDestinationRequestConditions(BlobRequestConditions destinationRequestConditions)
BlobUploadFromUrlOptions setHeaders(BlobHttpHeaders headers)
BlobUploadFromUrlOptions setSourceAuthorization(HttpAuthorization sourceAuthorization)

Sets "Authorization" header for accessing source URL.
BlobUploadFromUrlOptions setSourceRequestConditions(BlobRequestConditions sourceRequestConditions)
BlobUploadFromUrlOptions setTags(Map<String,String> tags)
BlobUploadFromUrlOptions setTier(AccessTier tier)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

BlobUploadFromUrlOptions

public BlobUploadFromUrlOptions(String sourceUrl)

Parameters:

sourceUrl - The source URL to upload from.

Method Details

getContentMd5

public byte[] getContentMd5()

Returns:

An MD5 hash of the content. This hash is used to verify the integrity of the content 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.

getCopySourceTagsMode

public BlobCopySourceTagsMode getCopySourceTagsMode()

Returns:

The copy source tags mode.

getDestinationRequestConditions

public BlobRequestConditions getDestinationRequestConditions()

Returns:

getHeaders

public BlobHttpHeaders getHeaders()

Returns:

getSourceAuthorization

public HttpAuthorization getSourceAuthorization()

Returns:

auth header for access to source.

getSourceRequestConditions

public BlobRequestConditions getSourceRequestConditions()

Returns:

getSourceUrl

public String getSourceUrl()

Returns:

The source URL to upload from.

getTags

public Map getTags()

Returns:

The tags to associate with the blob.

getTier

public AccessTier getTier()

Returns:

isCopySourceBlobProperties

public Boolean isCopySourceBlobProperties()

Optional, default is true. Indicates if properties from the source blob should be copied.

Returns:

Whether properties from the source blob should be copied.

setContentMd5

public BlobUploadFromUrlOptions setContentMd5(byte[] contentMd5)

Parameters:

contentMd5 - An MD5 hash of the block content. This hash is used to verify the integrity of the block 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.

Returns:

The updated options

setCopySourceBlobProperties

public BlobUploadFromUrlOptions setCopySourceBlobProperties(Boolean copySourceBlobProperties)

Optional, default is true. Indicates if properties from the source blob should be copied.

Parameters:

copySourceBlobProperties - Whether properties from the source blob should be copied.

Returns:

The updated options.

setCopySourceTagsMode

public BlobUploadFromUrlOptions setCopySourceTagsMode(BlobCopySourceTagsMode copySourceTags)

Sets the copy source tags mode

Parameters:

copySourceTags - Indicates if a legal hold should be placed on the blob.

Returns:

The updated options.

setDestinationRequestConditions

public BlobUploadFromUrlOptions setDestinationRequestConditions(BlobRequestConditions destinationRequestConditions)

Parameters:

destinationRequestConditions - BlobRequestConditions

Returns:

The updated options.

setHeaders

public BlobUploadFromUrlOptions setHeaders(BlobHttpHeaders headers)

Parameters:

headers - BlobHttpHeaders

Returns:

The updated options

setSourceAuthorization

public BlobUploadFromUrlOptions setSourceAuthorization(HttpAuthorization sourceAuthorization)

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

Parameters:

sourceAuthorization - auth header for access to source.

Returns:

The updated options.

setSourceRequestConditions

public BlobUploadFromUrlOptions setSourceRequestConditions(BlobRequestConditions sourceRequestConditions)

Parameters:

sourceRequestConditions - BlobRequestConditions

Returns:

The updated options.

setTags

public BlobUploadFromUrlOptions setTags(Map tags)

Parameters:

tags - The tags to associate with the blob.

Returns:

The updated options.

setTier

public BlobUploadFromUrlOptions setTier(AccessTier tier)

Parameters:

tier - AccessTier

Returns:

The updated options.

Applies to