BlobCopyFromUrlOptions Class

Package:

com.azure.storage.blob.options

Maven Artifact:

com.azure:azure-storage-blob:12.28.1

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

public class BlobCopyFromUrlOptions

Extended options that may be passed when copying a blob.

Constructor Summary

Constructor	Description
BlobCopyFromUrlOptions(String copySource)

Method Summary

Modifier and Type	Method and Description
String	getCopySource()
BlobCopySourceTagsMode	getCopySourceTagsMode()
BlobRequestConditions	getDestinationRequestConditions()
BlobImmutabilityPolicy	getImmutabilityPolicy()
Map<String,String>	getMetadata()
HttpAuthorization	getSourceAuthorization()
RequestConditions	getSourceRequestConditions()
Map<String,String>	getTags()
AccessTier	getTier()
Boolean	hasLegalHold()
BlobCopyFromUrlOptions	setCopySourceTagsMode(BlobCopySourceTagsMode copySourceTags) Sets the copy source tags mode
BlobCopyFromUrlOptions	setDestinationRequestConditions(BlobRequestConditions destinationRequestConditions)
BlobCopyFromUrlOptions	setImmutabilityPolicy(BlobImmutabilityPolicy immutabilityPolicy) Note that this parameter is only applicable to a blob within a container that has immutable storage with versioning enabled.
BlobCopyFromUrlOptions	setLegalHold(Boolean legalHold) Note that this parameter is only applicable to a blob within a container that has immutable storage with versioning enabled.
BlobCopyFromUrlOptions	setMetadata(Map<String,String> metadata)
BlobCopyFromUrlOptions	setSourceAuthorization(HttpAuthorization sourceAuthorization) Sets "Authorization" header for accessing source URL.
BlobCopyFromUrlOptions	setSourceRequestConditions(RequestConditions sourceRequestConditions)
BlobCopyFromUrlOptions	setTags(Map<String,String> tags)
BlobCopyFromUrlOptions	setTier(AccessTier tier)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

BlobCopyFromUrlOptions

public BlobCopyFromUrlOptions(String copySource)

Parameters:

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

Method Details

getCopySource

public String getCopySource()

Returns:

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

getCopySourceTagsMode

public BlobCopySourceTagsMode getCopySourceTagsMode()

Returns:

The copy source tags mode.

getDestinationRequestConditions

public BlobRequestConditions getDestinationRequestConditions()

Returns:

BlobRequestConditions for the destination.

getImmutabilityPolicy

public BlobImmutabilityPolicy getImmutabilityPolicy()

Returns:

BlobImmutabilityPolicy

getMetadata

public Map getMetadata()

Returns:

The metadata to associate with the destination blob.

getSourceAuthorization

public HttpAuthorization getSourceAuthorization()

Returns:

auth header for access to source.

getSourceRequestConditions

public RequestConditions getSourceRequestConditions()

Returns:

RequestConditions for the source.

getTags

public Map getTags()

Returns:

The tags to associate with the blob.

getTier

public AccessTier getTier()

Returns:

AccessTier for the destination blob.

hasLegalHold

public Boolean hasLegalHold()

Returns:

If a legal hold should be placed on the blob.

setCopySourceTagsMode

public BlobCopyFromUrlOptions 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 BlobCopyFromUrlOptions setDestinationRequestConditions(BlobRequestConditions destinationRequestConditions)

Parameters:

destinationRequestConditions - BlobRequestConditions for the destination.

Returns:

The updated options.

setImmutabilityPolicy

public BlobCopyFromUrlOptions setImmutabilityPolicy(BlobImmutabilityPolicy immutabilityPolicy)

Note that this parameter is only applicable to a blob within a container that has immutable storage with versioning enabled.

Parameters:

immutabilityPolicy - BlobImmutabilityPolicy

Returns:

The updated options.

setLegalHold

public BlobCopyFromUrlOptions setLegalHold(Boolean legalHold)

Note that this parameter is only applicable to a blob within a container that has immutable storage with versioning enabled.

Parameters:

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

Returns:

The updated options.

setMetadata

public BlobCopyFromUrlOptions setMetadata(Map metadata)

Parameters:

metadata - The metadata to associate with the destination blob.

Returns:

The updated options

setSourceAuthorization

public BlobCopyFromUrlOptions 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 BlobCopyFromUrlOptions setSourceRequestConditions(RequestConditions sourceRequestConditions)

Parameters:

sourceRequestConditions - RequestConditions for the source.

Returns:

The updated options.

setTags

public BlobCopyFromUrlOptions setTags(Map tags)

Parameters:

tags - The tags to associate with the blob.

Returns:

The updated options.

setTier

public BlobCopyFromUrlOptions setTier(AccessTier tier)

Parameters:

tier - AccessTier for the destination blob.

Returns:

The updated options.