230 строки
20 KiB
YAML
230 строки
20 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.storage.file.share.options.ShareFileCopyOptions"
|
|
fullName: "com.azure.storage.file.share.options.ShareFileCopyOptions"
|
|
name: "ShareFileCopyOptions"
|
|
nameWithType: "ShareFileCopyOptions"
|
|
summary: "Extended options that may be passed when copying a share."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
methodsRef:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
|
syntax: "public final class **ShareFileCopyOptions**"
|
|
constructors:
|
|
- uid: "com.azure.storage.file.share.options.ShareFileCopyOptions.ShareFileCopyOptions()"
|
|
fullName: "com.azure.storage.file.share.options.ShareFileCopyOptions.ShareFileCopyOptions()"
|
|
name: "ShareFileCopyOptions()"
|
|
nameWithType: "ShareFileCopyOptions.ShareFileCopyOptions()"
|
|
summary: "Creates a new instance of <xref uid=\"com.azure.storage.file.share.options.ShareFileCopyOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ShareFileCopyOptions\"></xref>."
|
|
syntax: "public ShareFileCopyOptions()"
|
|
desc: "Creates a new instance of <xref uid=\"com.azure.storage.file.share.options.ShareFileCopyOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ShareFileCopyOptions\"></xref>."
|
|
methods:
|
|
- uid: "com.azure.storage.file.share.options.ShareFileCopyOptions.getDestinationRequestConditions()"
|
|
fullName: "com.azure.storage.file.share.options.ShareFileCopyOptions.getDestinationRequestConditions()"
|
|
name: "getDestinationRequestConditions()"
|
|
nameWithType: "ShareFileCopyOptions.getDestinationRequestConditions()"
|
|
summary: "Gets the <xref uid=\"com.azure.storage.file.share.models.ShareRequestConditions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ShareRequestConditions\"></xref>."
|
|
syntax: "public ShareRequestConditions getDestinationRequestConditions()"
|
|
desc: "Gets the <xref uid=\"com.azure.storage.file.share.models.ShareRequestConditions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ShareRequestConditions\"></xref>."
|
|
returns:
|
|
description: "<xref uid=\"com.azure.storage.file.share.models.ShareRequestConditions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ShareRequestConditions\"></xref>"
|
|
type: "<xref href=\"com.azure.storage.file.share.models.ShareRequestConditions?alt=com.azure.storage.file.share.models.ShareRequestConditions&text=ShareRequestConditions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.options.ShareFileCopyOptions.getFilePermission()"
|
|
fullName: "com.azure.storage.file.share.options.ShareFileCopyOptions.getFilePermission()"
|
|
name: "getFilePermission()"
|
|
nameWithType: "ShareFileCopyOptions.getFilePermission()"
|
|
summary: "Gets the file permission key."
|
|
syntax: "public String getFilePermission()"
|
|
desc: "Gets the file permission key."
|
|
returns:
|
|
description: "The file's permission key."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.storage.file.share.options.ShareFileCopyOptions.getMetadata()"
|
|
fullName: "com.azure.storage.file.share.options.ShareFileCopyOptions.getMetadata()"
|
|
name: "getMetadata()"
|
|
nameWithType: "ShareFileCopyOptions.getMetadata()"
|
|
summary: "Gets the metadata to associate with the file."
|
|
syntax: "public Map<String,String> getMetadata()"
|
|
desc: "Gets the metadata to associate with the file."
|
|
returns:
|
|
description: "Metadata to associate with the file."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
|
|
- uid: "com.azure.storage.file.share.options.ShareFileCopyOptions.getPermissionCopyModeType()"
|
|
fullName: "com.azure.storage.file.share.options.ShareFileCopyOptions.getPermissionCopyModeType()"
|
|
name: "getPermissionCopyModeType()"
|
|
nameWithType: "ShareFileCopyOptions.getPermissionCopyModeType()"
|
|
summary: "Gets 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 File<wbr>Permission or File<wbr>Permission<wbr>Key."
|
|
syntax: "public PermissionCopyModeType getPermissionCopyModeType()"
|
|
desc: "Gets 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."
|
|
returns:
|
|
description: "the option to copy file security descriptor from source file or to set it using the value which is\n defined by the header value of FilePermission or FilePermissionKey."
|
|
type: "<xref href=\"com.azure.storage.file.share.models.PermissionCopyModeType?alt=com.azure.storage.file.share.models.PermissionCopyModeType&text=PermissionCopyModeType\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.options.ShareFileCopyOptions.getSmbProperties()"
|
|
fullName: "com.azure.storage.file.share.options.ShareFileCopyOptions.getSmbProperties()"
|
|
name: "getSmbProperties()"
|
|
nameWithType: "ShareFileCopyOptions.getSmbProperties()"
|
|
summary: "Gets the SMB properties to set on the destination file."
|
|
syntax: "public FileSmbProperties getSmbProperties()"
|
|
desc: "Gets the SMB properties to set on the destination file."
|
|
returns:
|
|
description: "Optional SMB properties to set on the destination file or directory. The only properties that are\n considered are file attributes, file creation time, file last write time, and file permission key. The rest are\n ignored."
|
|
type: "<xref href=\"com.azure.storage.file.share.FileSmbProperties?alt=com.azure.storage.file.share.FileSmbProperties&text=FileSmbProperties\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.options.ShareFileCopyOptions.getSmbPropertiesToCopy()"
|
|
fullName: "com.azure.storage.file.share.options.ShareFileCopyOptions.getSmbPropertiesToCopy()"
|
|
name: "getSmbPropertiesToCopy()"
|
|
nameWithType: "ShareFileCopyOptions.getSmbPropertiesToCopy()"
|
|
summary: "Gets the SMB properties to copy from the source file."
|
|
syntax: "public CopyableFileSmbPropertiesList getSmbPropertiesToCopy()"
|
|
desc: "Gets the SMB properties to copy from the source file."
|
|
returns:
|
|
description: "SMB properties to copy from the source file."
|
|
type: "<xref href=\"com.azure.storage.file.share.models.CopyableFileSmbPropertiesList?alt=com.azure.storage.file.share.models.CopyableFileSmbPropertiesList&text=CopyableFileSmbPropertiesList\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.options.ShareFileCopyOptions.isArchiveAttributeSet()"
|
|
fullName: "com.azure.storage.file.share.options.ShareFileCopyOptions.isArchiveAttributeSet()"
|
|
name: "isArchiveAttributeSet()"
|
|
nameWithType: "ShareFileCopyOptions.isArchiveAttributeSet()"
|
|
summary: "Gets the optional boolean specifying to set archive attribute on a target file."
|
|
syntax: "public Boolean isArchiveAttributeSet()"
|
|
desc: "Gets the 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:
|
|
description: "Optional boolean specifying to set archive attribute on a target file. True means archive attribute will\n be set on a target file despite attribute overrides or a source file state."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
- uid: "com.azure.storage.file.share.options.ShareFileCopyOptions.isIgnoreReadOnly()"
|
|
fullName: "com.azure.storage.file.share.options.ShareFileCopyOptions.isIgnoreReadOnly()"
|
|
name: "isIgnoreReadOnly()"
|
|
nameWithType: "ShareFileCopyOptions.isIgnoreReadOnly()"
|
|
summary: "Gets the optional boolean specifying to overwrite the target file if it already exists and has read-only attribute set."
|
|
syntax: "public Boolean isIgnoreReadOnly()"
|
|
desc: "Gets the optional boolean specifying to overwrite the target file if it already exists and has read-only attribute set."
|
|
returns:
|
|
description: "Optional boolean specifying to overwrite the target file if it already exists and has read-only attribute\n set."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
- uid: "com.azure.storage.file.share.options.ShareFileCopyOptions.setArchiveAttribute(java.lang.Boolean)"
|
|
fullName: "com.azure.storage.file.share.options.ShareFileCopyOptions.setArchiveAttribute(Boolean archiveAttribute)"
|
|
name: "setArchiveAttribute(Boolean archiveAttribute)"
|
|
nameWithType: "ShareFileCopyOptions.setArchiveAttribute(Boolean archiveAttribute)"
|
|
summary: "Sets the optional boolean specifying to set archive attribute on a target file."
|
|
parameters:
|
|
- description: "Optional boolean Specifying to set archive attribute on a target file. True means archive\n attribute will be set on a target file despite attribute overrides or a source file state."
|
|
name: "archiveAttribute"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
syntax: "public ShareFileCopyOptions setArchiveAttribute(Boolean archiveAttribute)"
|
|
desc: "Sets the 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:
|
|
description: "The updated options."
|
|
type: "<xref href=\"com.azure.storage.file.share.options.ShareFileCopyOptions?alt=com.azure.storage.file.share.options.ShareFileCopyOptions&text=ShareFileCopyOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.options.ShareFileCopyOptions.setDestinationRequestConditions(com.azure.storage.file.share.models.ShareRequestConditions)"
|
|
fullName: "com.azure.storage.file.share.options.ShareFileCopyOptions.setDestinationRequestConditions(ShareRequestConditions requestConditions)"
|
|
name: "setDestinationRequestConditions(ShareRequestConditions requestConditions)"
|
|
nameWithType: "ShareFileCopyOptions.setDestinationRequestConditions(ShareRequestConditions requestConditions)"
|
|
summary: "Sets the <xref uid=\"com.azure.storage.file.share.models.ShareRequestConditions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ShareRequestConditions\"></xref> to add conditions on copying the file."
|
|
parameters:
|
|
- description: "<xref uid=\"com.azure.storage.file.share.models.ShareRequestConditions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ShareRequestConditions\"></xref>"
|
|
name: "requestConditions"
|
|
type: "<xref href=\"com.azure.storage.file.share.models.ShareRequestConditions?alt=com.azure.storage.file.share.models.ShareRequestConditions&text=ShareRequestConditions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ShareFileCopyOptions setDestinationRequestConditions(ShareRequestConditions requestConditions)"
|
|
desc: "Sets the <xref uid=\"com.azure.storage.file.share.models.ShareRequestConditions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ShareRequestConditions\"></xref> to add conditions on copying the file."
|
|
returns:
|
|
description: "The updated options."
|
|
type: "<xref href=\"com.azure.storage.file.share.options.ShareFileCopyOptions?alt=com.azure.storage.file.share.options.ShareFileCopyOptions&text=ShareFileCopyOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.options.ShareFileCopyOptions.setFilePermission(java.lang.String)"
|
|
fullName: "com.azure.storage.file.share.options.ShareFileCopyOptions.setFilePermission(String filePermissionKey)"
|
|
name: "setFilePermission(String filePermissionKey)"
|
|
nameWithType: "ShareFileCopyOptions.setFilePermission(String filePermissionKey)"
|
|
summary: "Sets the file permission key."
|
|
parameters:
|
|
- description: "The file permission key."
|
|
name: "filePermissionKey"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public ShareFileCopyOptions setFilePermission(String filePermissionKey)"
|
|
desc: "Sets the file permission key."
|
|
returns:
|
|
description: "the updated options."
|
|
type: "<xref href=\"com.azure.storage.file.share.options.ShareFileCopyOptions?alt=com.azure.storage.file.share.options.ShareFileCopyOptions&text=ShareFileCopyOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.options.ShareFileCopyOptions.setIgnoreReadOnly(java.lang.Boolean)"
|
|
fullName: "com.azure.storage.file.share.options.ShareFileCopyOptions.setIgnoreReadOnly(Boolean ignoreReadOnly)"
|
|
name: "setIgnoreReadOnly(Boolean ignoreReadOnly)"
|
|
nameWithType: "ShareFileCopyOptions.setIgnoreReadOnly(Boolean ignoreReadOnly)"
|
|
summary: "Sets the optional boolean specifying to overwrite the target file if it already exists and has read-only attribute set."
|
|
parameters:
|
|
- description: "Optional boolean specifying to overwrite the target file if it already exists and has\n read-only attribute set."
|
|
name: "ignoreReadOnly"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
syntax: "public ShareFileCopyOptions setIgnoreReadOnly(Boolean ignoreReadOnly)"
|
|
desc: "Sets the optional boolean specifying to overwrite the target file if it already exists and has read-only attribute set."
|
|
returns:
|
|
description: "The updated options."
|
|
type: "<xref href=\"com.azure.storage.file.share.options.ShareFileCopyOptions?alt=com.azure.storage.file.share.options.ShareFileCopyOptions&text=ShareFileCopyOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.options.ShareFileCopyOptions.setMetadata(java.util.Map<java.lang.String,java.lang.String>)"
|
|
fullName: "com.azure.storage.file.share.options.ShareFileCopyOptions.setMetadata(Map<String,String> metadata)"
|
|
name: "setMetadata(Map<String,String> metadata)"
|
|
nameWithType: "ShareFileCopyOptions.setMetadata(Map<String,String> metadata)"
|
|
summary: "Sets the metadata to associate with the file."
|
|
parameters:
|
|
- description: "Metadata to associate with the file. If there is leading or trailing whitespace in any\n metadata key or value, it must be removed or encoded."
|
|
name: "metadata"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
|
|
syntax: "public ShareFileCopyOptions setMetadata(Map<String,String> metadata)"
|
|
desc: "Sets the metadata to associate with the file."
|
|
returns:
|
|
description: "The updated options."
|
|
type: "<xref href=\"com.azure.storage.file.share.options.ShareFileCopyOptions?alt=com.azure.storage.file.share.options.ShareFileCopyOptions&text=ShareFileCopyOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.options.ShareFileCopyOptions.setPermissionCopyModeType(com.azure.storage.file.share.models.PermissionCopyModeType)"
|
|
fullName: "com.azure.storage.file.share.options.ShareFileCopyOptions.setPermissionCopyModeType(PermissionCopyModeType copyModeType)"
|
|
name: "setPermissionCopyModeType(PermissionCopyModeType copyModeType)"
|
|
nameWithType: "ShareFileCopyOptions.setPermissionCopyModeType(PermissionCopyModeType copyModeType)"
|
|
summary: "Sets 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 File<wbr>Permission or File<wbr>Permission<wbr>Key."
|
|
parameters:
|
|
- description: "specified option to copy file security descriptor from source file or to set it using the\n value which is defined by the header value of FilePermission or FilePermissionKey."
|
|
name: "copyModeType"
|
|
type: "<xref href=\"com.azure.storage.file.share.models.PermissionCopyModeType?alt=com.azure.storage.file.share.models.PermissionCopyModeType&text=PermissionCopyModeType\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ShareFileCopyOptions setPermissionCopyModeType(PermissionCopyModeType copyModeType)"
|
|
desc: "Sets 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."
|
|
returns:
|
|
description: "The updated options."
|
|
type: "<xref href=\"com.azure.storage.file.share.options.ShareFileCopyOptions?alt=com.azure.storage.file.share.options.ShareFileCopyOptions&text=ShareFileCopyOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.options.ShareFileCopyOptions.setSmbProperties(com.azure.storage.file.share.FileSmbProperties)"
|
|
fullName: "com.azure.storage.file.share.options.ShareFileCopyOptions.setSmbProperties(FileSmbProperties smbProperties)"
|
|
name: "setSmbProperties(FileSmbProperties smbProperties)"
|
|
nameWithType: "ShareFileCopyOptions.setSmbProperties(FileSmbProperties smbProperties)"
|
|
summary: "Sets the SMB properties to set on the destination file."
|
|
parameters:
|
|
- description: "Optional SMB properties to set on the destination file or directory. The only properties\n that are considered are file attributes, file creation time, file last write time, and file permission key. The\n rest are ignored."
|
|
name: "smbProperties"
|
|
type: "<xref href=\"com.azure.storage.file.share.FileSmbProperties?alt=com.azure.storage.file.share.FileSmbProperties&text=FileSmbProperties\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ShareFileCopyOptions setSmbProperties(FileSmbProperties smbProperties)"
|
|
desc: "Sets the SMB properties to set on the destination file."
|
|
returns:
|
|
description: "The updated options."
|
|
type: "<xref href=\"com.azure.storage.file.share.options.ShareFileCopyOptions?alt=com.azure.storage.file.share.options.ShareFileCopyOptions&text=ShareFileCopyOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.options.ShareFileCopyOptions.setSmbPropertiesToCopy(com.azure.storage.file.share.models.CopyableFileSmbPropertiesList)"
|
|
fullName: "com.azure.storage.file.share.options.ShareFileCopyOptions.setSmbPropertiesToCopy(CopyableFileSmbPropertiesList smbProperties)"
|
|
name: "setSmbPropertiesToCopy(CopyableFileSmbPropertiesList smbProperties)"
|
|
nameWithType: "ShareFileCopyOptions.setSmbPropertiesToCopy(CopyableFileSmbPropertiesList smbProperties)"
|
|
summary: "Sets the SMB properties to copy from the source file."
|
|
parameters:
|
|
- description: "list of SMB properties to copy from the source file."
|
|
name: "smbProperties"
|
|
type: "<xref href=\"com.azure.storage.file.share.models.CopyableFileSmbPropertiesList?alt=com.azure.storage.file.share.models.CopyableFileSmbPropertiesList&text=CopyableFileSmbPropertiesList\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ShareFileCopyOptions setSmbPropertiesToCopy(CopyableFileSmbPropertiesList smbProperties)"
|
|
desc: "Sets the SMB properties to copy from the source file."
|
|
returns:
|
|
description: "The updated options."
|
|
type: "<xref href=\"com.azure.storage.file.share.options.ShareFileCopyOptions?alt=com.azure.storage.file.share.options.ShareFileCopyOptions&text=ShareFileCopyOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "Extended options that may be passed when copying a share."
|
|
metadata: {}
|
|
package: "com.azure.storage.file.share.options"
|
|
artifact: com.azure:azure-storage-file-share:12.24.0
|