Package com.azure.storage.file.share.options

Class ShareFileCopyOptions

java.lang.Object
com.azure.storage.file.share.options.ShareFileCopyOptions
public final class ShareFileCopyOptions extends Object
Extended options that may be passed when copying a share.

  • Constructor Details

    • ShareFileCopyOptions

      public ShareFileCopyOptions()

  • Method Details

    • getFilePermission

      public String getFilePermission()
      Returns:
      The file's permission key.

    • setFilePermission

      public ShareFileCopyOptions setFilePermission(String filePermissionKey)
      Sets the file permission key.
      Parameters:
      filePermissionKey - The file permission key.
      Returns:
      the updated options.

    • getSmbProperties

      public FileSmbProperties getSmbProperties()
      Returns:
      Optional SMB properties to set on the destination file or directory. The only properties that are considered are file attributes, file creation time, file last write time, and file permission key. The rest are ignored.

    • setSmbProperties

      public ShareFileCopyOptions setSmbProperties(FileSmbProperties smbProperties)
      Parameters:
      smbProperties - Optional SMB properties to set on the destination file or directory. The only properties that are considered are file attributes, file creation time, file last write time, and file permission key. The rest are ignored.
      Returns:
      The updated options.

    • getPermissionCopyModeType

      public PermissionCopyModeType getPermissionCopyModeType()
      Returns:
      the option to copy file security descriptor from source file or to set it using the value which is defined by the header value of FilePermission or FilePermissionKey.

    • setPermissionCopyModeType

      public ShareFileCopyOptions setPermissionCopyModeType(PermissionCopyModeType copyModeType)
      Parameters:
      copyModeType - specified option to copy file security descriptor from source file or to set it using the value which is defined by the header value of FilePermission or FilePermissionKey.
      Returns:
      The updated options.

    • isIgnoreReadOnly

      public Boolean isIgnoreReadOnly()
      Returns:
      Optional boolean specifying to overwrite the target file if it already exists and has read-only attribute set.

    • setIgnoreReadOnly

      public ShareFileCopyOptions setIgnoreReadOnly(Boolean ignoreReadOnly)
      Parameters:
      ignoreReadOnly - Optional boolean specifying to overwrite the target file if it already exists and has read-only attribute set.
      Returns:
      The updated options.

    • isArchiveAttributeSet

      public Boolean isArchiveAttributeSet()
      Returns:
      Optional boolean Specifying to set archive attribute on a target file. True means archive attribute will be set on a target file despite attribute overrides or a source file state.

    • setArchiveAttribute

      public ShareFileCopyOptions setArchiveAttribute(Boolean archiveAttribute)
      Parameters:
      archiveAttribute - Optional boolean Specifying to set archive attribute on a target file. True means archive attribute will be set on a target file despite attribute overrides or a source file state.
      Returns:
      The updated options.

    • getMetadata

      public Map<String,String> getMetadata()
      Returns:
      Metadata to associate with the share

    • setMetadata

      public ShareFileCopyOptions setMetadata(Map<String,String> metadata)
      Parameters:
      metadata - Metadata to associate with the share. If there is leading or trailing whitespace in any metadata key or value, it must be removed or encoded.
      Returns:
      The updated options.

    • getDestinationRequestConditions

      public ShareRequestConditions getDestinationRequestConditions()
      Gets the ShareRequestConditions.
      Returns:
      ShareRequestConditions

    • setDestinationRequestConditions

      public ShareFileCopyOptions setDestinationRequestConditions(ShareRequestConditions requestConditions)
      Sets the ShareRequestConditions to add conditions on copying the file.
      Parameters:
      requestConditions - ShareRequestConditions
      Returns:
      The updated options.

    • getSmbPropertiesToCopy

      public CopyableFileSmbPropertiesList getSmbPropertiesToCopy()
      Returns:
      SMB properties to copy from the source file.

    • setSmbPropertiesToCopy

      public ShareFileCopyOptions setSmbPropertiesToCopy(CopyableFileSmbPropertiesList smbProperties)
      Parameters:
      smbProperties - list of SMB properties to copy from the source file.
      Returns:
      The updated options.