/
com.azure.resourcemanager.storagecache.models.NfsAccessRule.yml
236 lines (236 loc) · 17.1 KB
/
com.azure.resourcemanager.storagecache.models.NfsAccessRule.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
### YamlMime:JavaType
uid: "com.azure.resourcemanager.storagecache.models.NfsAccessRule"
fullName: "com.azure.resourcemanager.storagecache.models.NfsAccessRule"
name: "NfsAccessRule"
nameWithType: "NfsAccessRule"
summary: "Rule to place restrictions on portions of the cache namespace being presented to clients."
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 **NfsAccessRule**"
constructors:
- uid: "com.azure.resourcemanager.storagecache.models.NfsAccessRule.NfsAccessRule()"
fullName: "com.azure.resourcemanager.storagecache.models.NfsAccessRule.NfsAccessRule()"
name: "NfsAccessRule()"
nameWithType: "NfsAccessRule.NfsAccessRule()"
summary: "Creates an instance of Nfs<wbr>Access<wbr>Rule class."
syntax: "public NfsAccessRule()"
desc: "Creates an instance of NfsAccessRule class."
methods:
- uid: "com.azure.resourcemanager.storagecache.models.NfsAccessRule.access()"
fullName: "com.azure.resourcemanager.storagecache.models.NfsAccessRule.access()"
name: "access()"
nameWithType: "NfsAccessRule.access()"
summary: "Get the access property: Access allowed by this rule."
syntax: "public NfsAccessRuleAccess access()"
desc: "Get the access property: Access allowed by this rule."
returns:
description: "the access value."
type: "<xref href=\"com.azure.resourcemanager.storagecache.models.NfsAccessRuleAccess?alt=com.azure.resourcemanager.storagecache.models.NfsAccessRuleAccess&text=NfsAccessRuleAccess\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.storagecache.models.NfsAccessRule.anonymousGid()"
fullName: "com.azure.resourcemanager.storagecache.models.NfsAccessRule.anonymousGid()"
name: "anonymousGid()"
nameWithType: "NfsAccessRule.anonymousGid()"
summary: "Get the anonymous<wbr>Gid property: GID value that replaces 0 when root<wbr>Squash is true."
syntax: "public String anonymousGid()"
desc: "Get the anonymousGid property: GID value that replaces 0 when rootSquash is true. This will use the value of anonymousUID if not provided."
returns:
description: "the anonymousGid value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.storagecache.models.NfsAccessRule.anonymousUid()"
fullName: "com.azure.resourcemanager.storagecache.models.NfsAccessRule.anonymousUid()"
name: "anonymousUid()"
nameWithType: "NfsAccessRule.anonymousUid()"
summary: "Get the anonymous<wbr>Uid property: UID value that replaces 0 when root<wbr>Squash is true."
syntax: "public String anonymousUid()"
desc: "Get the anonymousUid property: UID value that replaces 0 when rootSquash is true. 65534 will be used if not provided."
returns:
description: "the anonymousUid value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.storagecache.models.NfsAccessRule.filter()"
fullName: "com.azure.resourcemanager.storagecache.models.NfsAccessRule.filter()"
name: "filter()"
nameWithType: "NfsAccessRule.filter()"
summary: "Get the filter property: Filter applied to the scope for this rule."
syntax: "public String filter()"
desc: "Get the filter property: Filter applied to the scope for this rule. The filter's format depends on its scope. 'default' scope matches all clients and has no filter value. 'network' scope takes a filter in CIDR format (for example, 10.99.1.0/24). 'host' takes an IP address or fully qualified domain name as filter. If a client does not match any filter rule and there is no default rule, access is denied."
returns:
description: "the filter value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.storagecache.models.NfsAccessRule.rootSquash()"
fullName: "com.azure.resourcemanager.storagecache.models.NfsAccessRule.rootSquash()"
name: "rootSquash()"
nameWithType: "NfsAccessRule.rootSquash()"
summary: "Get the root<wbr>Squash property: Map root accesses to anonymousUID and anonymousGID."
syntax: "public Boolean rootSquash()"
desc: "Get the rootSquash property: Map root accesses to anonymousUID and anonymousGID."
returns:
description: "the rootSquash value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
- uid: "com.azure.resourcemanager.storagecache.models.NfsAccessRule.scope()"
fullName: "com.azure.resourcemanager.storagecache.models.NfsAccessRule.scope()"
name: "scope()"
nameWithType: "NfsAccessRule.scope()"
summary: "Get the scope property: Scope for this rule."
syntax: "public NfsAccessRuleScope scope()"
desc: "Get the scope property: Scope for this rule. The scope and filter determine which clients match the rule."
returns:
description: "the scope value."
type: "<xref href=\"com.azure.resourcemanager.storagecache.models.NfsAccessRuleScope?alt=com.azure.resourcemanager.storagecache.models.NfsAccessRuleScope&text=NfsAccessRuleScope\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.storagecache.models.NfsAccessRule.submountAccess()"
fullName: "com.azure.resourcemanager.storagecache.models.NfsAccessRule.submountAccess()"
name: "submountAccess()"
nameWithType: "NfsAccessRule.submountAccess()"
summary: "Get the submount<wbr>Access property: For the default policy, allow access to subdirectories under the root export."
syntax: "public Boolean submountAccess()"
desc: "Get the submountAccess property: For the default policy, allow access to subdirectories under the root export. If this is set to no, clients can only mount the path '/'. If set to yes, clients can mount a deeper path, like '/a/b'."
returns:
description: "the submountAccess value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
- uid: "com.azure.resourcemanager.storagecache.models.NfsAccessRule.suid()"
fullName: "com.azure.resourcemanager.storagecache.models.NfsAccessRule.suid()"
name: "suid()"
nameWithType: "NfsAccessRule.suid()"
summary: "Get the suid property: Allow SUID semantics."
syntax: "public Boolean suid()"
desc: "Get the suid property: Allow SUID semantics."
returns:
description: "the suid value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
- uid: "com.azure.resourcemanager.storagecache.models.NfsAccessRule.validate()"
fullName: "com.azure.resourcemanager.storagecache.models.NfsAccessRule.validate()"
name: "validate()"
nameWithType: "NfsAccessRule.validate()"
summary: "Validates the instance."
syntax: "public void validate()"
desc: "Validates the instance."
- uid: "com.azure.resourcemanager.storagecache.models.NfsAccessRule.withAccess(com.azure.resourcemanager.storagecache.models.NfsAccessRuleAccess)"
fullName: "com.azure.resourcemanager.storagecache.models.NfsAccessRule.withAccess(NfsAccessRuleAccess access)"
name: "withAccess(NfsAccessRuleAccess access)"
nameWithType: "NfsAccessRule.withAccess(NfsAccessRuleAccess access)"
summary: "Set the access property: Access allowed by this rule."
parameters:
- description: "the access value to set."
name: "access"
type: "<xref href=\"com.azure.resourcemanager.storagecache.models.NfsAccessRuleAccess?alt=com.azure.resourcemanager.storagecache.models.NfsAccessRuleAccess&text=NfsAccessRuleAccess\" data-throw-if-not-resolved=\"False\" />"
syntax: "public NfsAccessRule withAccess(NfsAccessRuleAccess access)"
desc: "Set the access property: Access allowed by this rule."
returns:
description: "the NfsAccessRule object itself."
type: "<xref href=\"com.azure.resourcemanager.storagecache.models.NfsAccessRule?alt=com.azure.resourcemanager.storagecache.models.NfsAccessRule&text=NfsAccessRule\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.storagecache.models.NfsAccessRule.withAnonymousGid(java.lang.String)"
fullName: "com.azure.resourcemanager.storagecache.models.NfsAccessRule.withAnonymousGid(String anonymousGid)"
name: "withAnonymousGid(String anonymousGid)"
nameWithType: "NfsAccessRule.withAnonymousGid(String anonymousGid)"
summary: "Set the anonymous<wbr>Gid property: GID value that replaces 0 when root<wbr>Squash is true."
parameters:
- description: "the anonymousGid value to set."
name: "anonymousGid"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public NfsAccessRule withAnonymousGid(String anonymousGid)"
desc: "Set the anonymousGid property: GID value that replaces 0 when rootSquash is true. This will use the value of anonymousUID if not provided."
returns:
description: "the NfsAccessRule object itself."
type: "<xref href=\"com.azure.resourcemanager.storagecache.models.NfsAccessRule?alt=com.azure.resourcemanager.storagecache.models.NfsAccessRule&text=NfsAccessRule\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.storagecache.models.NfsAccessRule.withAnonymousUid(java.lang.String)"
fullName: "com.azure.resourcemanager.storagecache.models.NfsAccessRule.withAnonymousUid(String anonymousUid)"
name: "withAnonymousUid(String anonymousUid)"
nameWithType: "NfsAccessRule.withAnonymousUid(String anonymousUid)"
summary: "Set the anonymous<wbr>Uid property: UID value that replaces 0 when root<wbr>Squash is true."
parameters:
- description: "the anonymousUid value to set."
name: "anonymousUid"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public NfsAccessRule withAnonymousUid(String anonymousUid)"
desc: "Set the anonymousUid property: UID value that replaces 0 when rootSquash is true. 65534 will be used if not provided."
returns:
description: "the NfsAccessRule object itself."
type: "<xref href=\"com.azure.resourcemanager.storagecache.models.NfsAccessRule?alt=com.azure.resourcemanager.storagecache.models.NfsAccessRule&text=NfsAccessRule\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.storagecache.models.NfsAccessRule.withFilter(java.lang.String)"
fullName: "com.azure.resourcemanager.storagecache.models.NfsAccessRule.withFilter(String filter)"
name: "withFilter(String filter)"
nameWithType: "NfsAccessRule.withFilter(String filter)"
summary: "Set the filter property: Filter applied to the scope for this rule."
parameters:
- description: "the filter value to set."
name: "filter"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public NfsAccessRule withFilter(String filter)"
desc: "Set the filter property: Filter applied to the scope for this rule. The filter's format depends on its scope. 'default' scope matches all clients and has no filter value. 'network' scope takes a filter in CIDR format (for example, 10.99.1.0/24). 'host' takes an IP address or fully qualified domain name as filter. If a client does not match any filter rule and there is no default rule, access is denied."
returns:
description: "the NfsAccessRule object itself."
type: "<xref href=\"com.azure.resourcemanager.storagecache.models.NfsAccessRule?alt=com.azure.resourcemanager.storagecache.models.NfsAccessRule&text=NfsAccessRule\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.storagecache.models.NfsAccessRule.withRootSquash(java.lang.Boolean)"
fullName: "com.azure.resourcemanager.storagecache.models.NfsAccessRule.withRootSquash(Boolean rootSquash)"
name: "withRootSquash(Boolean rootSquash)"
nameWithType: "NfsAccessRule.withRootSquash(Boolean rootSquash)"
summary: "Set the root<wbr>Squash property: Map root accesses to anonymousUID and anonymousGID."
parameters:
- description: "the rootSquash value to set."
name: "rootSquash"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
syntax: "public NfsAccessRule withRootSquash(Boolean rootSquash)"
desc: "Set the rootSquash property: Map root accesses to anonymousUID and anonymousGID."
returns:
description: "the NfsAccessRule object itself."
type: "<xref href=\"com.azure.resourcemanager.storagecache.models.NfsAccessRule?alt=com.azure.resourcemanager.storagecache.models.NfsAccessRule&text=NfsAccessRule\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.storagecache.models.NfsAccessRule.withScope(com.azure.resourcemanager.storagecache.models.NfsAccessRuleScope)"
fullName: "com.azure.resourcemanager.storagecache.models.NfsAccessRule.withScope(NfsAccessRuleScope scope)"
name: "withScope(NfsAccessRuleScope scope)"
nameWithType: "NfsAccessRule.withScope(NfsAccessRuleScope scope)"
summary: "Set the scope property: Scope for this rule."
parameters:
- description: "the scope value to set."
name: "scope"
type: "<xref href=\"com.azure.resourcemanager.storagecache.models.NfsAccessRuleScope?alt=com.azure.resourcemanager.storagecache.models.NfsAccessRuleScope&text=NfsAccessRuleScope\" data-throw-if-not-resolved=\"False\" />"
syntax: "public NfsAccessRule withScope(NfsAccessRuleScope scope)"
desc: "Set the scope property: Scope for this rule. The scope and filter determine which clients match the rule."
returns:
description: "the NfsAccessRule object itself."
type: "<xref href=\"com.azure.resourcemanager.storagecache.models.NfsAccessRule?alt=com.azure.resourcemanager.storagecache.models.NfsAccessRule&text=NfsAccessRule\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.storagecache.models.NfsAccessRule.withSubmountAccess(java.lang.Boolean)"
fullName: "com.azure.resourcemanager.storagecache.models.NfsAccessRule.withSubmountAccess(Boolean submountAccess)"
name: "withSubmountAccess(Boolean submountAccess)"
nameWithType: "NfsAccessRule.withSubmountAccess(Boolean submountAccess)"
summary: "Set the submount<wbr>Access property: For the default policy, allow access to subdirectories under the root export."
parameters:
- description: "the submountAccess value to set."
name: "submountAccess"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
syntax: "public NfsAccessRule withSubmountAccess(Boolean submountAccess)"
desc: "Set the submountAccess property: For the default policy, allow access to subdirectories under the root export. If this is set to no, clients can only mount the path '/'. If set to yes, clients can mount a deeper path, like '/a/b'."
returns:
description: "the NfsAccessRule object itself."
type: "<xref href=\"com.azure.resourcemanager.storagecache.models.NfsAccessRule?alt=com.azure.resourcemanager.storagecache.models.NfsAccessRule&text=NfsAccessRule\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.storagecache.models.NfsAccessRule.withSuid(java.lang.Boolean)"
fullName: "com.azure.resourcemanager.storagecache.models.NfsAccessRule.withSuid(Boolean suid)"
name: "withSuid(Boolean suid)"
nameWithType: "NfsAccessRule.withSuid(Boolean suid)"
summary: "Set the suid property: Allow SUID semantics."
parameters:
- description: "the suid value to set."
name: "suid"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
syntax: "public NfsAccessRule withSuid(Boolean suid)"
desc: "Set the suid property: Allow SUID semantics."
returns:
description: "the NfsAccessRule object itself."
type: "<xref href=\"com.azure.resourcemanager.storagecache.models.NfsAccessRule?alt=com.azure.resourcemanager.storagecache.models.NfsAccessRule&text=NfsAccessRule\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Rule to place restrictions on portions of the cache namespace being presented to clients."
metadata: {}
package: "com.azure.resourcemanager.storagecache.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-storagecache:1.0.0-beta.11