Package com.azure.storage.blob.options

Class BlobBeginCopyOptions

java.lang.Object

com.azure.storage.blob.options.BlobBeginCopyOptions

public class BlobBeginCopyOptions
extends Object

Extended options that may be passed when beginning a copy operation.

Constructor Summary

Constructors

Constructor	Description
BlobBeginCopyOptions(String sourceUrl)

Method Summary

Modifier and Type	Method	Description
BlobRequestConditions	getDestinationRequestConditions()
BlobImmutabilityPolicy	getImmutabilityPolicy()
Map<String,String>	getMetadata()
Duration	getPollInterval()
RehydratePriority	getRehydratePriority()
BlobBeginCopySourceRequestConditions	getSourceRequestConditions()
String	getSourceUrl()
Map<String,String>	getTags()
AccessTier	getTier()
Boolean	isLegalHold()
Boolean	isSealDestination()	Only applicable for Append Blobs.
BlobBeginCopyOptions	setDestinationRequestConditions(BlobRequestConditions destinationRequestConditions)
BlobBeginCopyOptions	setImmutabilityPolicy(BlobImmutabilityPolicy immutabilityPolicy)	Note that this parameter is only applicable to a blob within a container that has immutable storage with versioning enabled.
BlobBeginCopyOptions	setLegalHold(Boolean legalHold)	Note that this parameter is only applicable to a blob within a container that has immutable storage with versioning enabled.
BlobBeginCopyOptions	setMetadata(Map<String,String> metadata)
BlobBeginCopyOptions	setPollInterval(Duration pollInterval)
BlobBeginCopyOptions	setRehydratePriority(RehydratePriority rehydratePriority)
BlobBeginCopyOptions	setSealDestination(Boolean sealDestination)	Only applicable for Append Blobs.
BlobBeginCopyOptions	setSourceRequestConditions(BlobBeginCopySourceRequestConditions sourceRequestConditions)
BlobBeginCopyOptions	setTags(Map<String,String> tags)
BlobBeginCopyOptions	setTier(AccessTier tier)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BlobBeginCopyOptions

public BlobBeginCopyOptions(String sourceUrl)

Parameters:

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

Method Detail

getSourceUrl

public String getSourceUrl()

Returns:

The source URL.

getMetadata

public Map<String,String> getMetadata()

Returns:

The metadata to associate with the destination blob.

setMetadata

public BlobBeginCopyOptions setMetadata(Map<String,String> metadata)

Parameters:

metadata - The metadata to associate with the destination blob.

Returns:

The updated options

getTags

public Map<String,String> getTags()

Returns:

The tags to associate with the blob.

setTags

public BlobBeginCopyOptions setTags(Map<String,String> tags)

Parameters:

tags - The tags to associate with the blob.

Returns:

The updated options.

getTier

public AccessTier getTier()

Returns:

AccessTier for the destination blob.

setTier

public BlobBeginCopyOptions setTier(AccessTier tier)

Parameters:

tier - AccessTier for the destination blob.

Returns:

The updated options.

getRehydratePriority

public RehydratePriority getRehydratePriority()

Returns:

RehydratePriority for rehydrating the blob.

setRehydratePriority

public BlobBeginCopyOptions setRehydratePriority(RehydratePriority rehydratePriority)

Parameters:

rehydratePriority - RehydratePriority for rehydrating the blob.

Returns:

The updated options.

getSourceRequestConditions

public BlobBeginCopySourceRequestConditions getSourceRequestConditions()

Returns:

BlobBeginCopySourceRequestConditions for the source.

setSourceRequestConditions

public BlobBeginCopyOptions setSourceRequestConditions(BlobBeginCopySourceRequestConditions sourceRequestConditions)

Parameters:

sourceRequestConditions - BlobBeginCopySourceRequestConditions for the source.

Returns:

The updated options.

getDestinationRequestConditions

public BlobRequestConditions getDestinationRequestConditions()

Returns:

BlobRequestConditions for the destination.

setDestinationRequestConditions

public BlobBeginCopyOptions setDestinationRequestConditions(BlobRequestConditions destinationRequestConditions)

Parameters:

destinationRequestConditions - BlobRequestConditions for the destination

Returns:

The updated options.

getPollInterval

public Duration getPollInterval()

Returns:

Duration between each poll for the copy status. If none is specified, a default of one second is used.

setPollInterval

public BlobBeginCopyOptions setPollInterval(Duration pollInterval)

Parameters:

pollInterval - Duration between each poll for the copy status. If none is specified, a default of one second is used.

Returns:

The updated options.

isSealDestination

public Boolean isSealDestination()

Only applicable for Append Blobs.

Returns:

Whether or not the destination blob should be sealed (marked as read only).

setSealDestination

public BlobBeginCopyOptions setSealDestination(Boolean sealDestination)

Only applicable for Append Blobs.

Parameters:

sealDestination - Whether or not the destination blob should be sealed (marked as read only).

Returns:

The updated options.

getImmutabilityPolicy

public BlobImmutabilityPolicy getImmutabilityPolicy()

Returns:

BlobImmutabilityPolicy

setImmutabilityPolicy

public BlobBeginCopyOptions 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.

isLegalHold

public Boolean isLegalHold()

Returns:

If a legal hold should be placed on the blob.

setLegalHold

public BlobBeginCopyOptions 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.