Package com.azure.storage.blob.options
Class BlobBeginCopyOptions
java.lang.Object
com.azure.storage.blob.options.BlobBeginCopyOptions
Extended options that may be passed when beginning a copy operation.
-
Constructor Summary
ConstructorsConstructorDescriptionBlobBeginCopyOptions
(String sourceUrl) Creates a new instance ofBlobBeginCopyOptions
. -
Method Summary
Modifier and TypeMethodDescriptionGets theBlobRequestConditions
for the destination.Gets theBlobImmutabilityPolicy
for the destination blob.Gets the metadata to associate with the destination blob.Gets the duration between each poll for the copy status.Gets theRehydratePriority
for rehydrating the blob.Gets theBlobBeginCopySourceRequestConditions
for the source.Gets the source URL.getTags()
Gets the tags to associate with the blob.getTier()
Gets theAccessTier
for the destination blob.Gets if a legal hold should be placed on the blob.Gets whether the destination blob should be sealed (marked as read only).setDestinationRequestConditions
(BlobRequestConditions destinationRequestConditions) Sets theBlobRequestConditions
for the destination.setImmutabilityPolicy
(BlobImmutabilityPolicy immutabilityPolicy) Sets theBlobImmutabilityPolicy
for the destination blob.setLegalHold
(Boolean legalHold) Sets if a legal hold should be placed on the blob.setMetadata
(Map<String, String> metadata) Sets the metadata to associate with the destination blob.setPollInterval
(Duration pollInterval) Sets the duration between each poll for the copy status.setRehydratePriority
(RehydratePriority rehydratePriority) Sets theRehydratePriority
for rehydrating the blob.setSealDestination
(Boolean sealDestination) Sets whether the destination blob should be sealed (marked as read only).setSourceRequestConditions
(BlobBeginCopySourceRequestConditions sourceRequestConditions) Sets theBlobBeginCopySourceRequestConditions
for the source.Sets the tags to associate with the blob.setTier
(AccessTier tier) Sets theAccessTier
for the destination blob.
-
Constructor Details
-
BlobBeginCopyOptions
Creates a new instance ofBlobBeginCopyOptions
.- Parameters:
sourceUrl
- The source URL to copy from. URLs outside of Azure may only be copied to block blobs.- Throws:
NullPointerException
- IfsourceUrl
is null.
-
-
Method Details
-
getSourceUrl
Gets the source URL.- Returns:
- The source URL.
-
getMetadata
Gets the metadata to associate with the destination blob.- Returns:
- The metadata to associate with the destination blob.
-
setMetadata
Sets the metadata to associate with the destination blob.- Parameters:
metadata
- The metadata to associate with the destination blob.- Returns:
- The updated options
-
getTags
Gets the tags to associate with the blob.- Returns:
- The tags to associate with the blob.
-
setTags
Sets the tags to associate with the blob.- Parameters:
tags
- The tags to associate with the blob.- Returns:
- The updated options.
-
getTier
Gets theAccessTier
for the destination blob.- Returns:
AccessTier
for the destination blob.
-
setTier
Sets theAccessTier
for the destination blob.- Parameters:
tier
-AccessTier
for the destination blob.- Returns:
- The updated options.
-
getRehydratePriority
Gets theRehydratePriority
for rehydrating the blob.- Returns:
RehydratePriority
for rehydrating the blob.
-
setRehydratePriority
Sets theRehydratePriority
for rehydrating the blob.- Parameters:
rehydratePriority
-RehydratePriority
for rehydrating the blob.- Returns:
- The updated options.
-
getSourceRequestConditions
Gets theBlobBeginCopySourceRequestConditions
for the source.- Returns:
BlobBeginCopySourceRequestConditions
for the source.
-
setSourceRequestConditions
public BlobBeginCopyOptions setSourceRequestConditions(BlobBeginCopySourceRequestConditions sourceRequestConditions) Sets theBlobBeginCopySourceRequestConditions
for the source.- Parameters:
sourceRequestConditions
-BlobBeginCopySourceRequestConditions
for the source.- Returns:
- The updated options.
-
getDestinationRequestConditions
Gets theBlobRequestConditions
for the destination.- Returns:
BlobRequestConditions
for the destination.
-
setDestinationRequestConditions
public BlobBeginCopyOptions setDestinationRequestConditions(BlobRequestConditions destinationRequestConditions) Sets theBlobRequestConditions
for the destination.- Parameters:
destinationRequestConditions
-BlobRequestConditions
for the destination- Returns:
- The updated options.
-
getPollInterval
Gets the duration between each poll for the copy status.- Returns:
- Duration between each poll for the copy status. If none is specified, a default of one second is used.
-
setPollInterval
Sets the duration between each poll for the copy status.- 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
Gets whether the destination blob should be sealed (marked as read only).Only applicable for Append Blobs.
- Returns:
- Whether the destination blob should be sealed (marked as read only).
-
setSealDestination
Sets whether the destination blob should be sealed (marked as read only).Only applicable for Append Blobs.
- Parameters:
sealDestination
- Whether the destination blob should be sealed (marked as read only).- Returns:
- The updated options.
-
getImmutabilityPolicy
Gets theBlobImmutabilityPolicy
for the destination blob.- Returns:
BlobImmutabilityPolicy
-
setImmutabilityPolicy
Sets theBlobImmutabilityPolicy
for the destination blob.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
Gets if a legal hold should be placed on the blob.- Returns:
- If a legal hold should be placed on the blob.
-
setLegalHold
Sets if a legal hold should be placed on the blob.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.
-