-
Notifications
You must be signed in to change notification settings - Fork 223
/
com.azure.storage.file.share.options.ShareDirectoryCreateOptions.yml
109 lines (109 loc) · 8.73 KB
/
com.azure.storage.file.share.options.ShareDirectoryCreateOptions.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
### YamlMime:JavaType
uid: "com.azure.storage.file.share.options.ShareDirectoryCreateOptions"
fullName: "com.azure.storage.file.share.options.ShareDirectoryCreateOptions"
name: "ShareDirectoryCreateOptions"
nameWithType: "ShareDirectoryCreateOptions"
summary: "Extended options that may be passed when creating a share directory."
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 class **ShareDirectoryCreateOptions**"
constructors:
- uid: "com.azure.storage.file.share.options.ShareDirectoryCreateOptions.ShareDirectoryCreateOptions()"
fullName: "com.azure.storage.file.share.options.ShareDirectoryCreateOptions.ShareDirectoryCreateOptions()"
name: "ShareDirectoryCreateOptions()"
nameWithType: "ShareDirectoryCreateOptions.ShareDirectoryCreateOptions()"
summary: "Creates a new instance of <xref uid=\"com.azure.storage.file.share.options.ShareDirectoryCreateOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ShareDirectoryCreateOptions\"></xref>."
syntax: "public ShareDirectoryCreateOptions()"
desc: "Creates a new instance of <xref uid=\"com.azure.storage.file.share.options.ShareDirectoryCreateOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ShareDirectoryCreateOptions\"></xref>."
methods:
- uid: "com.azure.storage.file.share.options.ShareDirectoryCreateOptions.getFilePermission()"
fullName: "com.azure.storage.file.share.options.ShareDirectoryCreateOptions.getFilePermission()"
name: "getFilePermission()"
nameWithType: "ShareDirectoryCreateOptions.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.ShareDirectoryCreateOptions.getMetadata()"
fullName: "com.azure.storage.file.share.options.ShareDirectoryCreateOptions.getMetadata()"
name: "getMetadata()"
nameWithType: "ShareDirectoryCreateOptions.getMetadata()"
summary: "Gets the metadata to associate with the directory."
syntax: "public Map<String,String> getMetadata()"
desc: "Gets the metadata to associate with the directory."
returns:
description: "Metadata to associate with the directory."
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.ShareDirectoryCreateOptions.getSmbProperties()"
fullName: "com.azure.storage.file.share.options.ShareDirectoryCreateOptions.getSmbProperties()"
name: "getSmbProperties()"
nameWithType: "ShareDirectoryCreateOptions.getSmbProperties()"
summary: "Gets the SMB properties to set on the destination directory."
syntax: "public FileSmbProperties getSmbProperties()"
desc: "Gets the SMB properties to set on the destination directory."
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.ShareDirectoryCreateOptions.setFilePermission(java.lang.String)"
fullName: "com.azure.storage.file.share.options.ShareDirectoryCreateOptions.setFilePermission(String filePermissionKey)"
name: "setFilePermission(String filePermissionKey)"
nameWithType: "ShareDirectoryCreateOptions.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 ShareDirectoryCreateOptions setFilePermission(String filePermissionKey)"
desc: "Sets the file permission key."
returns:
description: "the updated options."
type: "<xref href=\"com.azure.storage.file.share.options.ShareDirectoryCreateOptions?alt=com.azure.storage.file.share.options.ShareDirectoryCreateOptions&text=ShareDirectoryCreateOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.share.options.ShareDirectoryCreateOptions.setMetadata(java.util.Map<java.lang.String,java.lang.String>)"
fullName: "com.azure.storage.file.share.options.ShareDirectoryCreateOptions.setMetadata(Map<String,String> metadata)"
name: "setMetadata(Map<String,String> metadata)"
nameWithType: "ShareDirectoryCreateOptions.setMetadata(Map<String,String> metadata)"
summary: "Sets the metadata to associate with the directory."
parameters:
- description: "Metadata to associate with the directory. 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 ShareDirectoryCreateOptions setMetadata(Map<String,String> metadata)"
desc: "Sets the metadata to associate with the directory."
returns:
description: "The updated options."
type: "<xref href=\"com.azure.storage.file.share.options.ShareDirectoryCreateOptions?alt=com.azure.storage.file.share.options.ShareDirectoryCreateOptions&text=ShareDirectoryCreateOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.share.options.ShareDirectoryCreateOptions.setSmbProperties(com.azure.storage.file.share.FileSmbProperties)"
fullName: "com.azure.storage.file.share.options.ShareDirectoryCreateOptions.setSmbProperties(FileSmbProperties smbProperties)"
name: "setSmbProperties(FileSmbProperties smbProperties)"
nameWithType: "ShareDirectoryCreateOptions.setSmbProperties(FileSmbProperties smbProperties)"
summary: "Sets the SMB properties to set on the destination directory."
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 ShareDirectoryCreateOptions setSmbProperties(FileSmbProperties smbProperties)"
desc: "Sets the SMB properties to set on the destination directory."
returns:
description: "The updated options."
type: "<xref href=\"com.azure.storage.file.share.options.ShareDirectoryCreateOptions?alt=com.azure.storage.file.share.options.ShareDirectoryCreateOptions&text=ShareDirectoryCreateOptions\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Extended options that may be passed when creating a share directory."
metadata: {}
package: "com.azure.storage.file.share.options"
artifact: com.azure:azure-storage-file-share:12.22.1