-
Notifications
You must be signed in to change notification settings - Fork 224
/
com.azure.storage.file.datalake.sas.PathSasPermission.yml
284 lines (284 loc) · 19.2 KB
/
com.azure.storage.file.datalake.sas.PathSasPermission.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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
### YamlMime:JavaType
uid: "com.azure.storage.file.datalake.sas.PathSasPermission"
fullName: "com.azure.storage.file.datalake.sas.PathSasPermission"
name: "PathSasPermission"
nameWithType: "PathSasPermission"
summary: "This is a helper class to construct a string representing the permissions granted by a ServiceSAS to a path."
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 **PathSasPermission**"
constructors:
- uid: "com.azure.storage.file.datalake.sas.PathSasPermission.PathSasPermission()"
fullName: "com.azure.storage.file.datalake.sas.PathSasPermission.PathSasPermission()"
name: "PathSasPermission()"
nameWithType: "PathSasPermission.PathSasPermission()"
summary: "Initializes a `PathSasPermission` object with all fields set to false."
syntax: "public PathSasPermission()"
desc: "Initializes a `PathSasPermission` object with all fields set to false."
methods:
- uid: "com.azure.storage.file.datalake.sas.PathSasPermission.hasAddPermission()"
fullName: "com.azure.storage.file.datalake.sas.PathSasPermission.hasAddPermission()"
name: "hasAddPermission()"
nameWithType: "PathSasPermission.hasAddPermission()"
syntax: "public boolean hasAddPermission()"
returns:
description: "the add permission status."
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.sas.PathSasPermission.hasCreatePermission()"
fullName: "com.azure.storage.file.datalake.sas.PathSasPermission.hasCreatePermission()"
name: "hasCreatePermission()"
nameWithType: "PathSasPermission.hasCreatePermission()"
syntax: "public boolean hasCreatePermission()"
returns:
description: "the create permission status."
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.sas.PathSasPermission.hasDeletePermission()"
fullName: "com.azure.storage.file.datalake.sas.PathSasPermission.hasDeletePermission()"
name: "hasDeletePermission()"
nameWithType: "PathSasPermission.hasDeletePermission()"
syntax: "public boolean hasDeletePermission()"
returns:
description: "the delete permission status."
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.sas.PathSasPermission.hasExecutePermission()"
fullName: "com.azure.storage.file.datalake.sas.PathSasPermission.hasExecutePermission()"
name: "hasExecutePermission()"
nameWithType: "PathSasPermission.hasExecutePermission()"
syntax: "public boolean hasExecutePermission()"
returns:
description: "the execute permission status."
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.sas.PathSasPermission.hasListPermission()"
fullName: "com.azure.storage.file.datalake.sas.PathSasPermission.hasListPermission()"
name: "hasListPermission()"
nameWithType: "PathSasPermission.hasListPermission()"
syntax: "public boolean hasListPermission()"
returns:
description: "the list permission status."
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.sas.PathSasPermission.hasManageAccessControlPermission()"
fullName: "com.azure.storage.file.datalake.sas.PathSasPermission.hasManageAccessControlPermission()"
name: "hasManageAccessControlPermission()"
nameWithType: "PathSasPermission.hasManageAccessControlPermission()"
syntax: "public boolean hasManageAccessControlPermission()"
returns:
description: "the manage access control permission status."
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.sas.PathSasPermission.hasManageOwnershipPermission()"
fullName: "com.azure.storage.file.datalake.sas.PathSasPermission.hasManageOwnershipPermission()"
name: "hasManageOwnershipPermission()"
nameWithType: "PathSasPermission.hasManageOwnershipPermission()"
syntax: "public boolean hasManageOwnershipPermission()"
returns:
description: "the manage ownership permission status."
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.sas.PathSasPermission.hasMovePermission()"
fullName: "com.azure.storage.file.datalake.sas.PathSasPermission.hasMovePermission()"
name: "hasMovePermission()"
nameWithType: "PathSasPermission.hasMovePermission()"
syntax: "public boolean hasMovePermission()"
returns:
description: "the move permission status."
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.sas.PathSasPermission.hasReadPermission()"
fullName: "com.azure.storage.file.datalake.sas.PathSasPermission.hasReadPermission()"
name: "hasReadPermission()"
nameWithType: "PathSasPermission.hasReadPermission()"
syntax: "public boolean hasReadPermission()"
returns:
description: "the read permission status."
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.sas.PathSasPermission.hasWritePermission()"
fullName: "com.azure.storage.file.datalake.sas.PathSasPermission.hasWritePermission()"
name: "hasWritePermission()"
nameWithType: "PathSasPermission.hasWritePermission()"
syntax: "public boolean hasWritePermission()"
returns:
description: "the write permission status."
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.sas.PathSasPermission.parse(java.lang.String)"
fullName: "com.azure.storage.file.datalake.sas.PathSasPermission.parse(String permissionString)"
name: "parse(String permissionString)"
nameWithType: "PathSasPermission.parse(String permissionString)"
summary: "Creates a `PathSasPermission` from the specified permissions string."
modifiers:
- "static"
parameters:
- description: "A <code>String</code> which represents the <code>PathSasPermission</code>."
name: "permissionString"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public static PathSasPermission parse(String permissionString)"
desc: "Creates a `PathSasPermission` from the specified permissions string. This method will throw an `IllegalArgumentException` if it encounters a character that does not correspond to a valid permission."
returns:
description: "A <code>PathSasPermission</code> generated from the given <code>String</code>."
type: "<xref href=\"com.azure.storage.file.datalake.sas.PathSasPermission?alt=com.azure.storage.file.datalake.sas.PathSasPermission&text=PathSasPermission\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.sas.PathSasPermission.setAddPermission(boolean)"
fullName: "com.azure.storage.file.datalake.sas.PathSasPermission.setAddPermission(boolean hasAddPermission)"
name: "setAddPermission(boolean hasAddPermission)"
nameWithType: "PathSasPermission.setAddPermission(boolean hasAddPermission)"
summary: "Sets the add permission status."
parameters:
- description: "Permission status to set"
name: "hasAddPermission"
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
syntax: "public PathSasPermission setAddPermission(boolean hasAddPermission)"
desc: "Sets the add permission status."
returns:
description: "the updated PathSasPermission object."
type: "<xref href=\"com.azure.storage.file.datalake.sas.PathSasPermission?alt=com.azure.storage.file.datalake.sas.PathSasPermission&text=PathSasPermission\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.sas.PathSasPermission.setCreatePermission(boolean)"
fullName: "com.azure.storage.file.datalake.sas.PathSasPermission.setCreatePermission(boolean hasCreatePermission)"
name: "setCreatePermission(boolean hasCreatePermission)"
nameWithType: "PathSasPermission.setCreatePermission(boolean hasCreatePermission)"
summary: "Sets the create permission status."
parameters:
- description: "Permission status to set"
name: "hasCreatePermission"
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
syntax: "public PathSasPermission setCreatePermission(boolean hasCreatePermission)"
desc: "Sets the create permission status."
returns:
description: "the updated PathSasPermission object."
type: "<xref href=\"com.azure.storage.file.datalake.sas.PathSasPermission?alt=com.azure.storage.file.datalake.sas.PathSasPermission&text=PathSasPermission\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.sas.PathSasPermission.setDeletePermission(boolean)"
fullName: "com.azure.storage.file.datalake.sas.PathSasPermission.setDeletePermission(boolean hasDeletePermission)"
name: "setDeletePermission(boolean hasDeletePermission)"
nameWithType: "PathSasPermission.setDeletePermission(boolean hasDeletePermission)"
summary: "Sets the delete permission status."
parameters:
- description: "Permission status to set"
name: "hasDeletePermission"
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
syntax: "public PathSasPermission setDeletePermission(boolean hasDeletePermission)"
desc: "Sets the delete permission status."
returns:
description: "the updated PathSasPermission object."
type: "<xref href=\"com.azure.storage.file.datalake.sas.PathSasPermission?alt=com.azure.storage.file.datalake.sas.PathSasPermission&text=PathSasPermission\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.sas.PathSasPermission.setExecutePermission(boolean)"
fullName: "com.azure.storage.file.datalake.sas.PathSasPermission.setExecutePermission(boolean hasExecutePermission)"
name: "setExecutePermission(boolean hasExecutePermission)"
nameWithType: "PathSasPermission.setExecutePermission(boolean hasExecutePermission)"
summary: "Sets the execute permission status."
parameters:
- description: "Permission status to set"
name: "hasExecutePermission"
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
syntax: "public PathSasPermission setExecutePermission(boolean hasExecutePermission)"
desc: "Sets the execute permission status."
returns:
description: "the updated PathSasPermission object."
type: "<xref href=\"com.azure.storage.file.datalake.sas.PathSasPermission?alt=com.azure.storage.file.datalake.sas.PathSasPermission&text=PathSasPermission\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.sas.PathSasPermission.setListPermission(boolean)"
fullName: "com.azure.storage.file.datalake.sas.PathSasPermission.setListPermission(boolean hasListPermission)"
name: "setListPermission(boolean hasListPermission)"
nameWithType: "PathSasPermission.setListPermission(boolean hasListPermission)"
summary: "Sets the list permission status."
parameters:
- description: "Permission status to set"
name: "hasListPermission"
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
syntax: "public PathSasPermission setListPermission(boolean hasListPermission)"
desc: "Sets the list permission status."
returns:
description: "the updated PathSasPermission object."
type: "<xref href=\"com.azure.storage.file.datalake.sas.PathSasPermission?alt=com.azure.storage.file.datalake.sas.PathSasPermission&text=PathSasPermission\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.sas.PathSasPermission.setManageAccessControlPermission(boolean)"
fullName: "com.azure.storage.file.datalake.sas.PathSasPermission.setManageAccessControlPermission(boolean hasManageAccessControlPermission)"
name: "setManageAccessControlPermission(boolean hasManageAccessControlPermission)"
nameWithType: "PathSasPermission.setManageAccessControlPermission(boolean hasManageAccessControlPermission)"
summary: "Sets the manage access control permission status."
parameters:
- description: "Permission status to set"
name: "hasManageAccessControlPermission"
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
syntax: "public PathSasPermission setManageAccessControlPermission(boolean hasManageAccessControlPermission)"
desc: "Sets the manage access control permission status."
returns:
description: "the updated PathSasPermission object."
type: "<xref href=\"com.azure.storage.file.datalake.sas.PathSasPermission?alt=com.azure.storage.file.datalake.sas.PathSasPermission&text=PathSasPermission\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.sas.PathSasPermission.setManageOwnershipPermission(boolean)"
fullName: "com.azure.storage.file.datalake.sas.PathSasPermission.setManageOwnershipPermission(boolean hasManageOwnershipPermission)"
name: "setManageOwnershipPermission(boolean hasManageOwnershipPermission)"
nameWithType: "PathSasPermission.setManageOwnershipPermission(boolean hasManageOwnershipPermission)"
summary: "Sets the manage ownership permission status."
parameters:
- description: "Permission status to set"
name: "hasManageOwnershipPermission"
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
syntax: "public PathSasPermission setManageOwnershipPermission(boolean hasManageOwnershipPermission)"
desc: "Sets the manage ownership permission status."
returns:
description: "the updated PathSasPermission object."
type: "<xref href=\"com.azure.storage.file.datalake.sas.PathSasPermission?alt=com.azure.storage.file.datalake.sas.PathSasPermission&text=PathSasPermission\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.sas.PathSasPermission.setMovePermission(boolean)"
fullName: "com.azure.storage.file.datalake.sas.PathSasPermission.setMovePermission(boolean hasMovePermission)"
name: "setMovePermission(boolean hasMovePermission)"
nameWithType: "PathSasPermission.setMovePermission(boolean hasMovePermission)"
summary: "Sets the move permission status."
parameters:
- description: "Permission status to set"
name: "hasMovePermission"
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
syntax: "public PathSasPermission setMovePermission(boolean hasMovePermission)"
desc: "Sets the move permission status."
returns:
description: "the updated PathSasPermission object."
type: "<xref href=\"com.azure.storage.file.datalake.sas.PathSasPermission?alt=com.azure.storage.file.datalake.sas.PathSasPermission&text=PathSasPermission\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.sas.PathSasPermission.setReadPermission(boolean)"
fullName: "com.azure.storage.file.datalake.sas.PathSasPermission.setReadPermission(boolean hasReadPermission)"
name: "setReadPermission(boolean hasReadPermission)"
nameWithType: "PathSasPermission.setReadPermission(boolean hasReadPermission)"
summary: "Sets the read permission status."
parameters:
- description: "Permission status to set"
name: "hasReadPermission"
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
syntax: "public PathSasPermission setReadPermission(boolean hasReadPermission)"
desc: "Sets the read permission status."
returns:
description: "the updated PathSasPermission object."
type: "<xref href=\"com.azure.storage.file.datalake.sas.PathSasPermission?alt=com.azure.storage.file.datalake.sas.PathSasPermission&text=PathSasPermission\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.sas.PathSasPermission.setWritePermission(boolean)"
fullName: "com.azure.storage.file.datalake.sas.PathSasPermission.setWritePermission(boolean hasWritePermission)"
name: "setWritePermission(boolean hasWritePermission)"
nameWithType: "PathSasPermission.setWritePermission(boolean hasWritePermission)"
summary: "Sets the write permission status."
parameters:
- description: "Permission status to set"
name: "hasWritePermission"
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
syntax: "public PathSasPermission setWritePermission(boolean hasWritePermission)"
desc: "Sets the write permission status."
returns:
description: "the updated PathSasPermission object."
type: "<xref href=\"com.azure.storage.file.datalake.sas.PathSasPermission?alt=com.azure.storage.file.datalake.sas.PathSasPermission&text=PathSasPermission\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.sas.PathSasPermission.toString()"
fullName: "com.azure.storage.file.datalake.sas.PathSasPermission.toString()"
name: "toString()"
nameWithType: "PathSasPermission.toString()"
summary: "Converts the given permissions to a `String`."
overridden: "java.lang.Object.toString()"
syntax: "public String toString()"
desc: "Converts the given permissions to a `String`. Using this method will guarantee the permissions are in an order accepted by the service."
returns:
description: "A <code>String</code> which represents the <code>PathSasPermission</code>."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
type: "class"
desc: "This is a helper class to construct a string representing the permissions granted by a ServiceSAS to a path. Setting a value to true means that any SAS which uses these permissions will grant permissions for that operation. It is possible to construct the permissions string without this class, but the order of the permissions is particular and this class guarantees correctness."
metadata: {}
package: "com.azure.storage.file.datalake.sas"
artifact: com.azure:azure-storage-file-datalake:12.19.1