-
Notifications
You must be signed in to change notification settings - Fork 261
/
Response.xml
418 lines (418 loc) · 20.8 KB
/
Response.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
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
<Type Name="Response" FullName="Azure.Response">
<TypeSignature Language="C#" Value="public abstract class Response : IDisposable" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit Response extends System.Object implements class System.IDisposable" />
<TypeSignature Language="DocId" Value="T:Azure.Response" />
<TypeSignature Language="VB.NET" Value="Public MustInherit Class Response
Implements IDisposable" />
<TypeSignature Language="F#" Value="type Response = class
 interface IDisposable" />
<AssemblyInfo>
<AssemblyName>Azure.Core</AssemblyName>
<AssemblyVersion>1.13.0.0</AssemblyVersion>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.15.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
<AssemblyVersion>1.18.0.0</AssemblyVersion>
<AssemblyVersion>1.19.0.0</AssemblyVersion>
<AssemblyVersion>1.20.0.0</AssemblyVersion>
<AssemblyVersion>1.21.0.0</AssemblyVersion>
<AssemblyVersion>1.22.0.0</AssemblyVersion>
<AssemblyVersion>1.23.0.0</AssemblyVersion>
<AssemblyVersion>1.24.0.0</AssemblyVersion>
<AssemblyVersion>1.25.0.0</AssemblyVersion>
<AssemblyVersion>1.26.0.0</AssemblyVersion>
<AssemblyVersion>1.27.0.0</AssemblyVersion>
<AssemblyVersion>1.28.0.0</AssemblyVersion>
<AssemblyVersion>1.29.0.0</AssemblyVersion>
<AssemblyVersion>1.30.0.0</AssemblyVersion>
<AssemblyVersion>1.31.0.0</AssemblyVersion>
<AssemblyVersion>1.32.0.0</AssemblyVersion>
<AssemblyVersion>1.33.0.0</AssemblyVersion>
<AssemblyVersion>1.34.0.0</AssemblyVersion>
<AssemblyVersion>1.35.0.0</AssemblyVersion>
<AssemblyVersion>1.36.0.0</AssemblyVersion>
<AssemblyVersion>1.37.0.0</AssemblyVersion>
<AssemblyVersion>1.38.0.0</AssemblyVersion>
<AssemblyVersion>1.39.0.0</AssemblyVersion>
<AssemblyVersion>1.40.0.0</AssemblyVersion>
<AssemblyVersion>1.41.0.0</AssemblyVersion>
<AssemblyVersion>1.42.0.0</AssemblyVersion>
<AssemblyVersion>1.43.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>
Represents the HTTP response from the service.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected Response ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Response.#ctor" />
<MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Core</AssemblyName>
<AssemblyVersion>1.43.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ClientRequestId">
<MemberSignature Language="C#" Value="public abstract string ClientRequestId { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ClientRequestId" />
<MemberSignature Language="DocId" Value="P:Azure.Response.ClientRequestId" />
<MemberSignature Language="VB.NET" Value="Public MustOverride Property ClientRequestId As String" />
<MemberSignature Language="F#" Value="member this.ClientRequestId : string with get, set" Usage="Azure.Response.ClientRequestId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Core</AssemblyName>
<AssemblyVersion>1.43.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the client request id that was sent to the server as <c>x-ms-client-request-id</c> headers.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ContainsHeader">
<MemberSignature Language="C#" Value="protected internal abstract bool ContainsHeader (string name);" />
<MemberSignature Language="ILAsm" Value=".method familyorassemblyhidebysig newslot virtual instance bool ContainsHeader(string name) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Response.ContainsHeader(System.String)" />
<MemberSignature Language="VB.NET" Value="Protected Friend MustOverride Function ContainsHeader (name As String) As Boolean" />
<MemberSignature Language="F#" Value="abstract member ContainsHeader : string -> bool" Usage="response.ContainsHeader name" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Core</AssemblyName>
<AssemblyVersion>1.43.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="name" Type="System.String" />
</Parameters>
<Docs>
<param name="name">The header name.</param>
<summary>
Returns <c>true</c> if the header is stored in the collection.
</summary>
<returns>
<c>true</c> if the specified header is stored in the collection, otherwise <c>false</c>.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Content">
<MemberSignature Language="C#" Value="public virtual BinaryData Content { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.BinaryData Content" />
<MemberSignature Language="DocId" Value="P:Azure.Response.Content" />
<MemberSignature Language="VB.NET" Value="Public Overridable ReadOnly Property Content As BinaryData" />
<MemberSignature Language="F#" Value="member this.Content : BinaryData" Usage="Azure.Response.Content" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Core</AssemblyName>
<AssemblyVersion>1.43.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.BinaryData</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the contents of HTTP response, if it is available.
</summary>
<value>To be added.</value>
<remarks>
Throws <see cref="T:System.InvalidOperationException" /> when <see cref="P:Azure.Response.ContentStream" /> is not a <see cref="T:System.IO.MemoryStream" />.
</remarks>
</Docs>
</Member>
<Member MemberName="ContentStream">
<MemberSignature Language="C#" Value="public abstract System.IO.Stream? ContentStream { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.IO.Stream ContentStream" />
<MemberSignature Language="DocId" Value="P:Azure.Response.ContentStream" />
<MemberSignature Language="VB.NET" Value="Public MustOverride Property ContentStream As Stream" />
<MemberSignature Language="F#" Value="member this.ContentStream : System.IO.Stream with get, set" Usage="Azure.Response.ContentStream" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Core</AssemblyName>
<AssemblyVersion>1.43.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IO.Stream</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the contents of HTTP response. Returns <c>null</c> for responses without content.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Dispose">
<MemberSignature Language="C#" Value="public abstract void Dispose ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Dispose() cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Response.Dispose" />
<MemberSignature Language="VB.NET" Value="Public MustOverride Sub Dispose ()" />
<MemberSignature Language="F#" Value="abstract member Dispose : unit -> unit" Usage="response.Dispose " />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:System.IDisposable.Dispose</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Azure.Core</AssemblyName>
<AssemblyVersion>1.43.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Frees resources held by this <see cref="T:Azure.Response" /> instance.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="EnumerateHeaders">
<MemberSignature Language="C#" Value="protected internal abstract System.Collections.Generic.IEnumerable<Azure.Core.HttpHeader> EnumerateHeaders ();" />
<MemberSignature Language="ILAsm" Value=".method familyorassemblyhidebysig newslot virtual instance class System.Collections.Generic.IEnumerable`1<valuetype Azure.Core.HttpHeader> EnumerateHeaders() cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Response.EnumerateHeaders" />
<MemberSignature Language="VB.NET" Value="Protected Friend MustOverride Function EnumerateHeaders () As IEnumerable(Of HttpHeader)" />
<MemberSignature Language="F#" Value="abstract member EnumerateHeaders : unit -> seq<Azure.Core.HttpHeader>" Usage="response.EnumerateHeaders " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Core</AssemblyName>
<AssemblyVersion>1.43.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IEnumerable<Azure.Core.HttpHeader></ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Returns an iterator for enumerating <see cref="T:Azure.Core.HttpHeader" /> in the response.
</summary>
<returns>The <see cref="T:System.Collections.Generic.IEnumerable`1" /> enumerating <see cref="T:Azure.Core.HttpHeader" /> in the response.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="FromValue<T>">
<MemberSignature Language="C#" Value="public static Azure.Response<T> FromValue<T> (T value, Azure.Response response);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Azure.Response`1<!!T> FromValue<T>(!!T value, class Azure.Response response) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Response.FromValue``1(``0,Azure.Response)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function FromValue(Of T) (value As T, response As Response) As Response(Of T)" />
<MemberSignature Language="F#" Value="static member FromValue : 'T * Azure.Response -> Azure.Response<'T>" Usage="Azure.Response.FromValue (value, response)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Core</AssemblyName>
<AssemblyVersion>1.43.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response<T></ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T" />
</TypeParameters>
<Parameters>
<Parameter Name="value" Type="T" />
<Parameter Name="response" Type="Azure.Response" />
</Parameters>
<Docs>
<typeparam name="T">The type of the value.</typeparam>
<param name="value">The value.</param>
<param name="response">The HTTP response.</param>
<summary>
Creates a new instance of <see cref="T:Azure.Response`1" /> with the provided value and HTTP response.
</summary>
<returns>A new instance of <see cref="T:Azure.Response`1" /> with the provided value and HTTP response.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Headers">
<MemberSignature Language="C#" Value="public virtual Azure.Core.ResponseHeaders Headers { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Azure.Core.ResponseHeaders Headers" />
<MemberSignature Language="DocId" Value="P:Azure.Response.Headers" />
<MemberSignature Language="VB.NET" Value="Public Overridable ReadOnly Property Headers As ResponseHeaders" />
<MemberSignature Language="F#" Value="member this.Headers : Azure.Core.ResponseHeaders" Usage="Azure.Response.Headers" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Core</AssemblyName>
<AssemblyVersion>1.43.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Core.ResponseHeaders</ReturnType>
</ReturnValue>
<Docs>
<summary>
Get the HTTP response headers.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IsError">
<MemberSignature Language="C#" Value="public virtual bool IsError { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool IsError" />
<MemberSignature Language="DocId" Value="P:Azure.Response.IsError" />
<MemberSignature Language="VB.NET" Value="Public Overridable ReadOnly Property IsError As Boolean" />
<MemberSignature Language="F#" Value="member this.IsError : bool" Usage="Azure.Response.IsError" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Core</AssemblyName>
<AssemblyVersion>1.43.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
Indicates whether the status code of the returned response is considered
an error code.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ReasonPhrase">
<MemberSignature Language="C#" Value="public abstract string ReasonPhrase { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ReasonPhrase" />
<MemberSignature Language="DocId" Value="P:Azure.Response.ReasonPhrase" />
<MemberSignature Language="VB.NET" Value="Public MustOverride ReadOnly Property ReasonPhrase As String" />
<MemberSignature Language="F#" Value="member this.ReasonPhrase : string" Usage="Azure.Response.ReasonPhrase" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Core</AssemblyName>
<AssemblyVersion>1.43.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the HTTP reason phrase.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Status">
<MemberSignature Language="C#" Value="public abstract int Status { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 Status" />
<MemberSignature Language="DocId" Value="P:Azure.Response.Status" />
<MemberSignature Language="VB.NET" Value="Public MustOverride ReadOnly Property Status As Integer" />
<MemberSignature Language="F#" Value="member this.Status : int" Usage="Azure.Response.Status" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Core</AssemblyName>
<AssemblyVersion>1.43.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the HTTP status code.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ToString">
<MemberSignature Language="C#" Value="public override string ToString ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string ToString() cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Response.ToString" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function ToString () As String" />
<MemberSignature Language="F#" Value="override this.ToString : unit -> string" Usage="response.ToString " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Core</AssemblyName>
<AssemblyVersion>1.43.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Returns the string representation of this <see cref="T:Azure.Response" />.
</summary>
<returns>The string representation of this <see cref="T:Azure.Response" /></returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TryGetHeader">
<MemberSignature Language="C#" Value="protected internal abstract bool TryGetHeader (string name, out string? value);" />
<MemberSignature Language="ILAsm" Value=".method familyorassemblyhidebysig newslot virtual instance bool TryGetHeader(string name, [out] string& value) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Response.TryGetHeader(System.String,System.String@)" />
<MemberSignature Language="VB.NET" Value="Protected Friend MustOverride Function TryGetHeader (name As String, ByRef value As String) As Boolean" />
<MemberSignature Language="F#" Value="abstract member TryGetHeader : string * string -> bool" Usage="response.TryGetHeader (name, value)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Core</AssemblyName>
<AssemblyVersion>1.43.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="name" Type="System.String" />
<Parameter Name="value" Type="System.String" RefType="out" />
</Parameters>
<Docs>
<param name="name">The header name.</param>
<param name="value">The reference to populate with value.</param>
<summary>
Returns header value if the header is stored in the collection. If header has multiple values they are going to be joined with a comma.
</summary>
<returns>
<c>true</c> if the specified header is stored in the collection, otherwise <c>false</c>.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TryGetHeaderValues">
<MemberSignature Language="C#" Value="protected internal abstract bool TryGetHeaderValues (string name, out System.Collections.Generic.IEnumerable<string>? values);" />
<MemberSignature Language="ILAsm" Value=".method familyorassemblyhidebysig newslot virtual instance bool TryGetHeaderValues(string name, [out] class System.Collections.Generic.IEnumerable`1<string>& values) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Response.TryGetHeaderValues(System.String,System.Collections.Generic.IEnumerable{System.String}@)" />
<MemberSignature Language="VB.NET" Value="Protected Friend MustOverride Function TryGetHeaderValues (name As String, ByRef values As IEnumerable(Of String)) As Boolean" />
<MemberSignature Language="F#" Value="abstract member TryGetHeaderValues : string * seq -> bool" Usage="response.TryGetHeaderValues (name, values)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Core</AssemblyName>
<AssemblyVersion>1.43.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="name" Type="System.String" />
<Parameter Name="values" Type="System.Collections.Generic.IEnumerable<System.String>" RefType="out" />
</Parameters>
<Docs>
<param name="name">The header name.</param>
<param name="values">The reference to populate with values.</param>
<summary>
Returns header values if the header is stored in the collection.
</summary>
<returns>
<c>true</c> if the specified header is stored in the collection, otherwise <c>false</c>.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>