Package com.azure.storage.blob.options

Class BlobCopyFromUrlOptions

java.lang.Object
com.azure.storage.blob.options.BlobCopyFromUrlOptions
public class BlobCopyFromUrlOptions extends Object
Extended options that may be passed when copying a blob.

  • Constructor Details

    • BlobCopyFromUrlOptions

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

  • Method Details

    • getCopySource

      public String getCopySource()
      Gets the source URL to copy from.
      Returns:
      The source URL to copy from. URLs outside of Azure may only be copied to block blobs.

    • 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 BlobCopyFromUrlOptions 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 BlobCopyFromUrlOptions 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 BlobCopyFromUrlOptions setTier(AccessTier tier)
      Sets the AccessTier for the destination blob.
      Parameters:
      tier - AccessTier for the destination blob.
      Returns:
      The updated options.

    • getSourceRequestConditions

      public com.azure.core.http.RequestConditions getSourceRequestConditions()
      Gets the RequestConditions for the source.
      Returns:
      RequestConditions for the source.

    • setSourceRequestConditions

      public BlobCopyFromUrlOptions setSourceRequestConditions(com.azure.core.http.RequestConditions sourceRequestConditions)
      Sets the RequestConditions for the source.
      Parameters:
      sourceRequestConditions - RequestConditions for the source.
      Returns:
      The updated options.

    • getDestinationRequestConditions

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

    • setDestinationRequestConditions

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

    • getSourceAuthorization

      public com.azure.core.http.HttpAuthorization getSourceAuthorization()
      Gets "Authorization" header for accessing source URL. Currently only "Bearer" authentication is accepted by Storage.
      Returns:
      auth header for access to source.

    • setSourceAuthorization

      public BlobCopyFromUrlOptions setSourceAuthorization(com.azure.core.http.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.

    • getImmutabilityPolicy

      public BlobImmutabilityPolicy getImmutabilityPolicy()
      Gets the BlobImmutabilityPolicy.
      Returns:
      BlobImmutabilityPolicy

    • setImmutabilityPolicy

      public BlobCopyFromUrlOptions setImmutabilityPolicy(BlobImmutabilityPolicy immutabilityPolicy)
      Sets the BlobImmutabilityPolicy.

      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.

    • hasLegalHold

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

    • setLegalHold

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

    • getCopySourceTagsMode

      public BlobCopySourceTagsMode getCopySourceTagsMode()
      Gets the copy source tags mode.
      Returns:
      The copy source tags mode.

    • 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.

    • getSourceShareTokenIntent

      public FileShareTokenIntent getSourceShareTokenIntent()
      Optional, only applicable (but required) when the source is Azure Storage Files and using token authentication. Gets the intent of the request.
      Returns:
      the FileShareTokenIntent for the file share.

    • setSourceShareTokenIntent

      public BlobCopyFromUrlOptions setSourceShareTokenIntent(FileShareTokenIntent sourceShareTokenIntent)
      Optional, only applicable (but required) when the source is Azure Storage Files and using token authentication. Sets the intent of the request.
      Parameters:
      sourceShareTokenIntent - Used to indicate the intent of the request.
      Returns:
      The updated options.