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 Details

    • BlobBeginCopyOptions

      public BlobBeginCopyOptions(String sourceUrl)
      Creates a new instance of BlobBeginCopyOptions.
      Parameters:
      sourceUrl - The source URL to copy from. URLs outside of Azure may only be copied to block blobs.
      Throws:
      NullPointerException - If sourceUrl is null.

  • Method Details

    • getSourceUrl

      public String getSourceUrl()
      Gets the source URL.
      Returns:
      The source URL.

    • getMetadata

      public Map<String,String> getMetadata()
      Gets the metadata to associate with the destination blob.
      Returns:
      The metadata to associate with the destination blob.

    • setMetadata

      public BlobBeginCopyOptions setMetadata(Map<String,String> metadata)
      Sets the metadata to associate with the destination blob.
      Parameters:
      metadata - The metadata to associate with the destination blob.
      Returns:
      The updated options

    • getTags

      public Map<String,String> getTags()
      Gets the tags to associate with the blob.
      Returns:
      The tags to associate with the blob.

    • setTags

      public BlobBeginCopyOptions setTags(Map<String,String> tags)
      Sets the tags to associate with the blob.
      Parameters:
      tags - The tags to associate with the blob.
      Returns:
      The updated options.

    • getTier

      public AccessTier getTier()
      Gets the AccessTier for the destination blob.
      Returns:
      AccessTier for the destination blob.

    • setTier

      public BlobBeginCopyOptions setTier(AccessTier tier)
      Sets the AccessTier for the destination blob.
      Parameters:
      tier - AccessTier for the destination blob.
      Returns:
      The updated options.

    • getRehydratePriority

      public RehydratePriority getRehydratePriority()
      Gets the RehydratePriority for rehydrating the blob.
      Returns:
      RehydratePriority for rehydrating the blob.

    • setRehydratePriority

      public BlobBeginCopyOptions setRehydratePriority(RehydratePriority rehydratePriority)
      Sets the RehydratePriority for rehydrating the blob.
      Parameters:
      rehydratePriority - RehydratePriority for rehydrating the blob.
      Returns:
      The updated options.

    • getSourceRequestConditions

      public BlobBeginCopySourceRequestConditions getSourceRequestConditions()
      Gets the BlobBeginCopySourceRequestConditions for the source.
      Returns:
      BlobBeginCopySourceRequestConditions for the source.

    • setSourceRequestConditions

      public BlobBeginCopyOptions setSourceRequestConditions(BlobBeginCopySourceRequestConditions sourceRequestConditions)
      Sets the BlobBeginCopySourceRequestConditions for the source.
      Parameters:
      sourceRequestConditions - BlobBeginCopySourceRequestConditions for the source.
      Returns:
      The updated options.

    • getDestinationRequestConditions

      public BlobRequestConditions getDestinationRequestConditions()
      Gets the BlobRequestConditions for the destination.
      Returns:
      BlobRequestConditions for the destination.

    • setDestinationRequestConditions

      public BlobBeginCopyOptions setDestinationRequestConditions(BlobRequestConditions destinationRequestConditions)
      Sets the BlobRequestConditions for the destination.
      Parameters:
      destinationRequestConditions - BlobRequestConditions for the destination
      Returns:
      The updated options.

    • getPollInterval

      public Duration 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

      public BlobBeginCopyOptions setPollInterval(Duration pollInterval)
      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

      public Boolean 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

      public BlobBeginCopyOptions setSealDestination(Boolean sealDestination)
      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

      public BlobImmutabilityPolicy getImmutabilityPolicy()
      Gets the BlobImmutabilityPolicy for the destination blob.
      Returns:
      BlobImmutabilityPolicy

    • setImmutabilityPolicy

      public BlobBeginCopyOptions setImmutabilityPolicy(BlobImmutabilityPolicy immutabilityPolicy)
      Sets the BlobImmutabilityPolicy 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

      public Boolean isLegalHold()
      Gets if a legal hold should be placed on the blob.
      Returns:
      If a legal hold should be placed on the blob.

    • setLegalHold

      public BlobBeginCopyOptions setLegalHold(Boolean legalHold)
      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.