-
Notifications
You must be signed in to change notification settings - Fork 254
/
Copy pathcom.azure.storage.file.datalake.options.PathSetAccessControlRecursiveOptions.yml
171 lines (171 loc) · 15.7 KB
/
com.azure.storage.file.datalake.options.PathSetAccessControlRecursiveOptions.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
### YamlMime:JavaType
uid: "com.azure.storage.file.datalake.options.PathSetAccessControlRecursiveOptions"
fullName: "com.azure.storage.file.datalake.options.PathSetAccessControlRecursiveOptions"
name: "PathSetAccessControlRecursiveOptions"
nameWithType: "PathSetAccessControlRecursiveOptions"
summary: "Optional parameters for Set Access Control Recursive."
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 **PathSetAccessControlRecursiveOptions**"
constructors:
- uid: "com.azure.storage.file.datalake.options.PathSetAccessControlRecursiveOptions.PathSetAccessControlRecursiveOptions(java.util.List<com.azure.storage.file.datalake.models.PathAccessControlEntry>)"
fullName: "com.azure.storage.file.datalake.options.PathSetAccessControlRecursiveOptions.PathSetAccessControlRecursiveOptions(List<PathAccessControlEntry> accessControlList)"
name: "PathSetAccessControlRecursiveOptions(List<PathAccessControlEntry> accessControlList)"
nameWithType: "PathSetAccessControlRecursiveOptions.PathSetAccessControlRecursiveOptions(List<PathAccessControlEntry> accessControlList)"
summary: "Constructs a new options object."
parameters:
- description: "The POSIX access control list for the file or directory."
name: "accessControlList"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.storage.file.datalake.models.PathAccessControlEntry?alt=com.azure.storage.file.datalake.models.PathAccessControlEntry&text=PathAccessControlEntry\" data-throw-if-not-resolved=\"False\" />>"
syntax: "public PathSetAccessControlRecursiveOptions(List<PathAccessControlEntry> accessControlList)"
desc: "Constructs a new options object."
methods:
- uid: "com.azure.storage.file.datalake.options.PathSetAccessControlRecursiveOptions.getAccessControlList()"
fullName: "com.azure.storage.file.datalake.options.PathSetAccessControlRecursiveOptions.getAccessControlList()"
name: "getAccessControlList()"
nameWithType: "PathSetAccessControlRecursiveOptions.getAccessControlList()"
summary: "Returns the POSIX access control list for the file or directory."
syntax: "public List<PathAccessControlEntry> getAccessControlList()"
desc: "Returns the POSIX access control list for the file or directory."
returns:
description: "The POSIX access control list for the file or directory."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.storage.file.datalake.models.PathAccessControlEntry?alt=com.azure.storage.file.datalake.models.PathAccessControlEntry&text=PathAccessControlEntry\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.storage.file.datalake.options.PathSetAccessControlRecursiveOptions.getBatchSize()"
fullName: "com.azure.storage.file.datalake.options.PathSetAccessControlRecursiveOptions.getBatchSize()"
name: "getBatchSize()"
nameWithType: "PathSetAccessControlRecursiveOptions.getBatchSize()"
summary: "Gets the batch size."
syntax: "public Integer getBatchSize()"
desc: "Gets the batch size.\n\nIf data set size exceeds batch size then operation will be split into multiple requests so that progress can be tracked. Batch size should be between 1 and 2000. The default when unspecified is 2000."
returns:
description: "The size of the batch."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
- uid: "com.azure.storage.file.datalake.options.PathSetAccessControlRecursiveOptions.getContinuationToken()"
fullName: "com.azure.storage.file.datalake.options.PathSetAccessControlRecursiveOptions.getContinuationToken()"
name: "getContinuationToken()"
nameWithType: "PathSetAccessControlRecursiveOptions.getContinuationToken()"
summary: "Returns a token that can be used to resume previously stopped operation."
syntax: "public String getContinuationToken()"
desc: "Returns a token that can be used to resume previously stopped operation."
returns:
description: "A token that can be used to resume previously stopped operation."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.storage.file.datalake.options.PathSetAccessControlRecursiveOptions.getMaxBatches()"
fullName: "com.azure.storage.file.datalake.options.PathSetAccessControlRecursiveOptions.getMaxBatches()"
name: "getMaxBatches()"
nameWithType: "PathSetAccessControlRecursiveOptions.getMaxBatches()"
summary: "Gets the maximum number of batches that single change Access Control operation can execute."
syntax: "public Integer getMaxBatches()"
desc: "Gets the maximum number of batches that single change Access Control operation can execute.\n\nIf maximum is reached before all subpaths are processed then continuation token can be used to resume operation. Empty value indicates that maximum number of batches in unbound and operation continues till end. Operation may \\* also halt if an error is hit and `continueOnFailure` is false."
returns:
description: "The maximum number of batches."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
- uid: "com.azure.storage.file.datalake.options.PathSetAccessControlRecursiveOptions.getProgressHandler()"
fullName: "com.azure.storage.file.datalake.options.PathSetAccessControlRecursiveOptions.getProgressHandler()"
name: "getProgressHandler()"
nameWithType: "PathSetAccessControlRecursiveOptions.getProgressHandler()"
summary: "Gets a callback where caller can track progress of the operation as well as collect paths that failed to change Access Control."
syntax: "public Consumer<Response<AccessControlChanges>> getProgressHandler()"
desc: "Gets a callback where caller can track progress of the operation as well as collect paths that failed to change Access Control."
returns:
description: "The progress handler."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/function/Consumer.html\">Consumer</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.storage.file.datalake.models.AccessControlChanges?alt=com.azure.storage.file.datalake.models.AccessControlChanges&text=AccessControlChanges\" data-throw-if-not-resolved=\"False\" />>>"
- uid: "com.azure.storage.file.datalake.options.PathSetAccessControlRecursiveOptions.isContinueOnFailure()"
fullName: "com.azure.storage.file.datalake.options.PathSetAccessControlRecursiveOptions.isContinueOnFailure()"
name: "isContinueOnFailure()"
nameWithType: "PathSetAccessControlRecursiveOptions.isContinueOnFailure()"
summary: "Returns if the operation should continue on user failure."
syntax: "public boolean isContinueOnFailure()"
desc: "Returns if the operation should continue on user failure.\n\nIf set to false, the operation will terminate quickly on encountering user failures. If true, the operation will ignore user failures and proceed with the operation on other sub-entities of the directory."
returns:
description: "If the operation should continue on user failure."
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.options.PathSetAccessControlRecursiveOptions.setBatchSize(java.lang.Integer)"
fullName: "com.azure.storage.file.datalake.options.PathSetAccessControlRecursiveOptions.setBatchSize(Integer batchSize)"
name: "setBatchSize(Integer batchSize)"
nameWithType: "PathSetAccessControlRecursiveOptions.setBatchSize(Integer batchSize)"
summary: "Sets the batch size."
parameters:
- description: "The size of the batch."
name: "batchSize"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
syntax: "public PathSetAccessControlRecursiveOptions setBatchSize(Integer batchSize)"
desc: "Sets the batch size.\n\nIf data set size exceeds batch size then operation will be split into multiple requests so that progress can be tracked. Batch size should be between 1 and 2000. The default when unspecified is 2000."
returns:
description: "The updated object."
type: "<xref href=\"com.azure.storage.file.datalake.options.PathSetAccessControlRecursiveOptions?alt=com.azure.storage.file.datalake.options.PathSetAccessControlRecursiveOptions&text=PathSetAccessControlRecursiveOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.options.PathSetAccessControlRecursiveOptions.setContinuationToken(java.lang.String)"
fullName: "com.azure.storage.file.datalake.options.PathSetAccessControlRecursiveOptions.setContinuationToken(String continuationToken)"
name: "setContinuationToken(String continuationToken)"
nameWithType: "PathSetAccessControlRecursiveOptions.setContinuationToken(String continuationToken)"
summary: "Sets a token that can be used to resume previously stopped operation."
parameters:
- description: "A token that can be used to resume previously stopped operation."
name: "continuationToken"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public PathSetAccessControlRecursiveOptions setContinuationToken(String continuationToken)"
desc: "Sets a token that can be used to resume previously stopped operation."
returns:
description: "The updated object."
type: "<xref href=\"com.azure.storage.file.datalake.options.PathSetAccessControlRecursiveOptions?alt=com.azure.storage.file.datalake.options.PathSetAccessControlRecursiveOptions&text=PathSetAccessControlRecursiveOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.options.PathSetAccessControlRecursiveOptions.setContinueOnFailure(boolean)"
fullName: "com.azure.storage.file.datalake.options.PathSetAccessControlRecursiveOptions.setContinueOnFailure(boolean continueOnFailure)"
name: "setContinueOnFailure(boolean continueOnFailure)"
nameWithType: "PathSetAccessControlRecursiveOptions.setContinueOnFailure(boolean continueOnFailure)"
summary: "Sets if the operation should continue on user failure."
parameters:
- description: "Whether the operation should continue on user failure."
name: "continueOnFailure"
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
syntax: "public PathSetAccessControlRecursiveOptions setContinueOnFailure(boolean continueOnFailure)"
desc: "Sets if the operation should continue on user failure.\n\nIf set to false, the operation will terminate quickly on encountering user failures. If true, the operation will ignore user failures and proceed with the operation on other sub-entities of the directory."
returns:
description: "The updated object."
type: "<xref href=\"com.azure.storage.file.datalake.options.PathSetAccessControlRecursiveOptions?alt=com.azure.storage.file.datalake.options.PathSetAccessControlRecursiveOptions&text=PathSetAccessControlRecursiveOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.options.PathSetAccessControlRecursiveOptions.setMaxBatches(java.lang.Integer)"
fullName: "com.azure.storage.file.datalake.options.PathSetAccessControlRecursiveOptions.setMaxBatches(Integer maxBatches)"
name: "setMaxBatches(Integer maxBatches)"
nameWithType: "PathSetAccessControlRecursiveOptions.setMaxBatches(Integer maxBatches)"
summary: "Sets the maximum number of batches that single change Access Control operation can execute."
parameters:
- description: "The maximum number of batches."
name: "maxBatches"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
syntax: "public PathSetAccessControlRecursiveOptions setMaxBatches(Integer maxBatches)"
desc: "Sets the maximum number of batches that single change Access Control operation can execute.\n\nIf maximum is reached before all subpaths are processed then continuation token can be used to resume operation. Empty value indicates that maximum number of batches in unbound and operation continues till end. Operation may \\* also halt if an error is hit and `continueOnFailure` is false."
returns:
description: "The updated object."
type: "<xref href=\"com.azure.storage.file.datalake.options.PathSetAccessControlRecursiveOptions?alt=com.azure.storage.file.datalake.options.PathSetAccessControlRecursiveOptions&text=PathSetAccessControlRecursiveOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.options.PathSetAccessControlRecursiveOptions.setProgressHandler(java.util.function.Consumer<com.azure.core.http.rest.Response<com.azure.storage.file.datalake.models.AccessControlChanges>>)"
fullName: "com.azure.storage.file.datalake.options.PathSetAccessControlRecursiveOptions.setProgressHandler(Consumer<Response<AccessControlChanges>> progressHandler)"
name: "setProgressHandler(Consumer<Response<AccessControlChanges>> progressHandler)"
nameWithType: "PathSetAccessControlRecursiveOptions.setProgressHandler(Consumer<Response<AccessControlChanges>> progressHandler)"
summary: "Sets a callback where caller can track progress of the operation as well as collect paths that failed to change Access Control."
parameters:
- description: "The progress handler."
name: "progressHandler"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/function/Consumer.html\">Consumer</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.storage.file.datalake.models.AccessControlChanges?alt=com.azure.storage.file.datalake.models.AccessControlChanges&text=AccessControlChanges\" data-throw-if-not-resolved=\"False\" />>>"
syntax: "public PathSetAccessControlRecursiveOptions setProgressHandler(Consumer<Response<AccessControlChanges>> progressHandler)"
desc: "Sets a callback where caller can track progress of the operation as well as collect paths that failed to change Access Control."
returns:
description: "The updated object."
type: "<xref href=\"com.azure.storage.file.datalake.options.PathSetAccessControlRecursiveOptions?alt=com.azure.storage.file.datalake.options.PathSetAccessControlRecursiveOptions&text=PathSetAccessControlRecursiveOptions\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Optional parameters for Set Access Control Recursive."
metadata: {}
package: "com.azure.storage.file.datalake.options"
artifact: com.azure:azure-storage-file-datalake:12.22.0