-
Notifications
You must be signed in to change notification settings - Fork 255
/
AccessCondition.xml
278 lines (278 loc) · 16.6 KB
/
AccessCondition.xml
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
<Type Name="AccessCondition" FullName="Microsoft.Azure.Search.Models.AccessCondition">
<TypeSignature Language="C#" Value="public class AccessCondition" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit AccessCondition extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Search.Models.AccessCondition" />
<TypeSignature Language="VB.NET" Value="Public Class AccessCondition" />
<TypeSignature Language="F#" Value="type AccessCondition = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Service</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Additional parameters for a set of operations.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public AccessCondition ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Models.AccessCondition.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Service</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Initializes a new instance of the AccessCondition class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public AccessCondition (string ifMatch = default, string ifNoneMatch = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string ifMatch, string ifNoneMatch) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Models.AccessCondition.#ctor(System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (Optional ifMatch As String = Nothing, Optional ifNoneMatch As String = Nothing)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Search.Models.AccessCondition : string * string -> Microsoft.Azure.Search.Models.AccessCondition" Usage="new Microsoft.Azure.Search.Models.AccessCondition (ifMatch, ifNoneMatch)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Service</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="ifMatch" Type="System.String" />
<Parameter Name="ifNoneMatch" Type="System.String" />
</Parameters>
<Docs>
<param name="ifMatch">Defines the If-Match condition. The operation
will be performed only if the ETag on the server matches this
value.</param>
<param name="ifNoneMatch">Defines the If-None-Match condition. The
operation will be performed only if the ETag on the server does not
match this value.</param>
<summary>
Initializes a new instance of the AccessCondition class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GenerateEmptyCondition">
<MemberSignature Language="C#" Value="public static Microsoft.Azure.Search.Models.AccessCondition GenerateEmptyCondition ();" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Azure.Search.Models.AccessCondition GenerateEmptyCondition() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Models.AccessCondition.GenerateEmptyCondition" />
<MemberSignature Language="VB.NET" Value="Public Shared Function GenerateEmptyCondition () As AccessCondition" />
<MemberSignature Language="F#" Value="static member GenerateEmptyCondition : unit -> Microsoft.Azure.Search.Models.AccessCondition" Usage="Microsoft.Azure.Search.Models.AccessCondition.GenerateEmptyCondition " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Service</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Search.Models.AccessCondition</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Constructs an empty access condition.
</summary>
<returns>An empty <see cref="T:Microsoft.Azure.Search.Models.AccessCondition" /> object.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GenerateIfExistsCondition">
<MemberSignature Language="C#" Value="public static Microsoft.Azure.Search.Models.AccessCondition GenerateIfExistsCondition ();" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Azure.Search.Models.AccessCondition GenerateIfExistsCondition() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Models.AccessCondition.GenerateIfExistsCondition" />
<MemberSignature Language="VB.NET" Value="Public Shared Function GenerateIfExistsCondition () As AccessCondition" />
<MemberSignature Language="F#" Value="static member GenerateIfExistsCondition : unit -> Microsoft.Azure.Search.Models.AccessCondition" Usage="Microsoft.Azure.Search.Models.AccessCondition.GenerateIfExistsCondition " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Service</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Search.Models.AccessCondition</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Constructs an access condition such that an operation will be performed only if the resource exists.
</summary>
<returns>An <see cref="T:Microsoft.Azure.Search.Models.AccessCondition" /> object that represents a condition where a resource exists.</returns>
<remarks>Setting this access condition modifies the request to include the HTTP <i>If-Match</i> conditional header set to <c>"*"</c>.</remarks>
</Docs>
</Member>
<Member MemberName="GenerateIfMatchCondition">
<MemberSignature Language="C#" Value="public static Microsoft.Azure.Search.Models.AccessCondition GenerateIfMatchCondition (string eTag);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Azure.Search.Models.AccessCondition GenerateIfMatchCondition(string eTag) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Models.AccessCondition.GenerateIfMatchCondition(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function GenerateIfMatchCondition (eTag As String) As AccessCondition" />
<MemberSignature Language="F#" Value="static member GenerateIfMatchCondition : string -> Microsoft.Azure.Search.Models.AccessCondition" Usage="Microsoft.Azure.Search.Models.AccessCondition.GenerateIfMatchCondition eTag" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Service</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Search.Models.AccessCondition</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="eTag" Type="System.String" />
</Parameters>
<Docs>
<param name="eTag">The ETag value to check against the resource's ETag.</param>
<summary>
Constructs an access condition such that an operation will be performed only if the resource's current ETag value
matches the specified ETag value.
</summary>
<returns>An <see cref="T:Microsoft.Azure.Search.Models.AccessCondition" /> object that represents the If-Match condition.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GenerateIfNoneMatchCondition">
<MemberSignature Language="C#" Value="public static Microsoft.Azure.Search.Models.AccessCondition GenerateIfNoneMatchCondition (string eTag);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Azure.Search.Models.AccessCondition GenerateIfNoneMatchCondition(string eTag) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Models.AccessCondition.GenerateIfNoneMatchCondition(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function GenerateIfNoneMatchCondition (eTag As String) As AccessCondition" />
<MemberSignature Language="F#" Value="static member GenerateIfNoneMatchCondition : string -> Microsoft.Azure.Search.Models.AccessCondition" Usage="Microsoft.Azure.Search.Models.AccessCondition.GenerateIfNoneMatchCondition eTag" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Service</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Search.Models.AccessCondition</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="eTag" Type="System.String" />
</Parameters>
<Docs>
<param name="eTag">The ETag value to check against the resource's ETag.</param>
<summary>
Constructs an access condition such that an operation will be performed only if the resource's current ETag value
does not match the specified ETag value.
</summary>
<returns>An <see cref="T:Microsoft.Azure.Search.Models.AccessCondition" /> object that represents the If-None-Match condition.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GenerateIfNotExistsCondition">
<MemberSignature Language="C#" Value="public static Microsoft.Azure.Search.Models.AccessCondition GenerateIfNotExistsCondition ();" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Azure.Search.Models.AccessCondition GenerateIfNotExistsCondition() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Models.AccessCondition.GenerateIfNotExistsCondition" />
<MemberSignature Language="VB.NET" Value="Public Shared Function GenerateIfNotExistsCondition () As AccessCondition" />
<MemberSignature Language="F#" Value="static member GenerateIfNotExistsCondition : unit -> Microsoft.Azure.Search.Models.AccessCondition" Usage="Microsoft.Azure.Search.Models.AccessCondition.GenerateIfNotExistsCondition " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Service</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Search.Models.AccessCondition</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Constructs an access condition such that an operation will be performed only if the resource does not exist.
</summary>
<returns>An <see cref="T:Microsoft.Azure.Search.Models.AccessCondition" /> object that represents a condition where a resource does not exist.</returns>
<remarks>Setting this access condition modifies the request to include the HTTP <i>If-None-Match</i> conditional header set to <c>"*"</c>.</remarks>
</Docs>
</Member>
<Member MemberName="IfMatch">
<MemberSignature Language="C#" Value="public string IfMatch { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string IfMatch" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Search.Models.AccessCondition.IfMatch" />
<MemberSignature Language="VB.NET" Value="Public Property IfMatch As String" />
<MemberSignature Language="F#" Value="member this.IfMatch : string with get, set" Usage="Microsoft.Azure.Search.Models.AccessCondition.IfMatch" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Service</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonIgnore]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonIgnore>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets defines the If-Match condition. The operation will be
performed only if the ETag on the server matches this value.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IfNoneMatch">
<MemberSignature Language="C#" Value="public string IfNoneMatch { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string IfNoneMatch" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Search.Models.AccessCondition.IfNoneMatch" />
<MemberSignature Language="VB.NET" Value="Public Property IfNoneMatch As String" />
<MemberSignature Language="F#" Value="member this.IfNoneMatch : string with get, set" Usage="Microsoft.Azure.Search.Models.AccessCondition.IfNoneMatch" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Service</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonIgnore]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonIgnore>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets defines the If-None-Match condition. The operation
will be performed only if the ETag on the server does not match
this value.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IfNotChanged">
<MemberSignature Language="C#" Value="public static Microsoft.Azure.Search.Models.AccessCondition IfNotChanged (Microsoft.Azure.Search.Models.IResourceWithETag resource);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Azure.Search.Models.AccessCondition IfNotChanged(class Microsoft.Azure.Search.Models.IResourceWithETag resource) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Models.AccessCondition.IfNotChanged(Microsoft.Azure.Search.Models.IResourceWithETag)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function IfNotChanged (resource As IResourceWithETag) As AccessCondition" />
<MemberSignature Language="F#" Value="static member IfNotChanged : Microsoft.Azure.Search.Models.IResourceWithETag -> Microsoft.Azure.Search.Models.AccessCondition" Usage="Microsoft.Azure.Search.Models.AccessCondition.IfNotChanged resource" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Service</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Search.Models.AccessCondition</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="resource" Type="Microsoft.Azure.Search.Models.IResourceWithETag" />
</Parameters>
<Docs>
<param name="resource">A resource with an ETag value to check against the resource's ETag.</param>
<summary>
Constructs an access condition such that an operation will be performed only if the resource's current ETag value
matches the specified resource's ETag value.
</summary>
<returns>An <see cref="T:Microsoft.Azure.Search.Models.AccessCondition" /> object that represents the If-Match condition.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>