-
Notifications
You must be signed in to change notification settings - Fork 255
/
PipelineMessage.xml
381 lines (380 loc) · 22.3 KB
/
PipelineMessage.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
<Type Name="PipelineMessage" FullName="System.ClientModel.Primitives.PipelineMessage">
<TypeSignature Language="C#" Value="public class PipelineMessage : IDisposable" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit PipelineMessage extends System.Object implements class System.IDisposable" />
<TypeSignature Language="DocId" Value="T:System.ClientModel.Primitives.PipelineMessage" />
<TypeSignature Language="VB.NET" Value="Public Class PipelineMessage
Implements IDisposable" />
<TypeSignature Language="F#" Value="type PipelineMessage = class
 interface IDisposable" />
<AssemblyInfo>
<AssemblyName>System.ClientModel</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>
Represents an HTTP message that can be sent from a
<see cref="T:System.ClientModel.Primitives.ClientPipeline" />. <see cref="P:System.ClientModel.Primitives.PipelineMessage.Request" /> holds the request sent
to the cloud service, and <see cref="P:System.ClientModel.Primitives.PipelineMessage.Response" /> holds the response received
from the service.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected internal PipelineMessage (System.ClientModel.Primitives.PipelineRequest request);" />
<MemberSignature Language="ILAsm" Value=".method familyorassemblyhidebysig specialname rtspecialname instance void .ctor(class System.ClientModel.Primitives.PipelineRequest request) cil managed" />
<MemberSignature Language="DocId" Value="M:System.ClientModel.Primitives.PipelineMessage.#ctor(System.ClientModel.Primitives.PipelineRequest)" />
<MemberSignature Language="VB.NET" Value="Protected Friend Sub New (request As PipelineRequest)" />
<MemberSignature Language="F#" Value="new System.ClientModel.Primitives.PipelineMessage : System.ClientModel.Primitives.PipelineRequest -> System.ClientModel.Primitives.PipelineMessage" Usage="new System.ClientModel.Primitives.PipelineMessage request" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.ClientModel</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="request" Type="System.ClientModel.Primitives.PipelineRequest" />
</Parameters>
<Docs>
<param name="request">The <see cref="T:System.ClientModel.Primitives.PipelineRequest" /> to set on this
instance's <see cref="P:System.ClientModel.Primitives.PipelineMessage.Request" /> property.</param>
<summary>
Creates an instance of <see cref="T:System.ClientModel.Primitives.PipelineMessage" /> with
<see cref="P:System.ClientModel.Primitives.PipelineMessage.Request" /> set to the provided <paramref name="request" />.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Apply">
<MemberSignature Language="C#" Value="public void Apply (System.ClientModel.Primitives.RequestOptions? options);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Apply(class System.ClientModel.Primitives.RequestOptions options) cil managed" />
<MemberSignature Language="DocId" Value="M:System.ClientModel.Primitives.PipelineMessage.Apply(System.ClientModel.Primitives.RequestOptions)" />
<MemberSignature Language="VB.NET" Value="Public Sub Apply (options As RequestOptions)" />
<MemberSignature Language="F#" Value="member this.Apply : System.ClientModel.Primitives.RequestOptions -> unit" Usage="pipelineMessage.Apply options" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.ClientModel</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="options" Type="System.ClientModel.Primitives.RequestOptions" />
</Parameters>
<Docs>
<param name="options">The <see cref="T:System.ClientModel.Primitives.RequestOptions" /> to apply to this
<see cref="T:System.ClientModel.Primitives.PipelineMessage" /> instance. If <c>null</c> is passed,
no changes will be made to this message instance.</param>
<summary>
Apply the options from the provided <see cref="T:System.ClientModel.Primitives.RequestOptions" /> to
this <see cref="T:System.ClientModel.Primitives.PipelineMessage" /> instance.
</summary>
<remarks> This method is intended to be called after the creation of
the <see cref="T:System.ClientModel.Primitives.PipelineMessage" /> and its <see cref="P:System.ClientModel.Primitives.PipelineMessage.Request" /> is
complete, and prior to the call to
<see cref="M:System.ClientModel.Primitives.ClientPipeline.Send(System.ClientModel.Primitives.PipelineMessage)" />.
</remarks>
</Docs>
</Member>
<Member MemberName="BufferResponse">
<MemberSignature Language="C#" Value="public bool BufferResponse { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool BufferResponse" />
<MemberSignature Language="DocId" Value="P:System.ClientModel.Primitives.PipelineMessage.BufferResponse" />
<MemberSignature Language="VB.NET" Value="Public Property BufferResponse As Boolean" />
<MemberSignature Language="F#" Value="member this.BufferResponse : bool with get, set" Usage="System.ClientModel.Primitives.PipelineMessage.BufferResponse" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.ClientModel</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the value indicating whether the response should be buffered
in-memory by the pipeline. Defaults to true.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CancellationToken">
<MemberSignature Language="C#" Value="public System.Threading.CancellationToken CancellationToken { get; protected internal set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Threading.CancellationToken CancellationToken" />
<MemberSignature Language="DocId" Value="P:System.ClientModel.Primitives.PipelineMessage.CancellationToken" />
<MemberSignature Language="VB.NET" Value="Public Property CancellationToken As CancellationToken" />
<MemberSignature Language="F#" Value="member this.CancellationToken : System.Threading.CancellationToken with get, set" Usage="System.ClientModel.Primitives.PipelineMessage.CancellationToken" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.ClientModel</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.CancellationToken</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the <see cref="P:System.ClientModel.Primitives.PipelineMessage.CancellationToken" /> used for the duration
of the call to <see cref="M:System.ClientModel.Primitives.ClientPipeline.Send(System.ClientModel.Primitives.PipelineMessage)" />.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Dispose">
<MemberSignature Language="C#" Value="public void Dispose ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Dispose() cil managed" />
<MemberSignature Language="DocId" Value="M:System.ClientModel.Primitives.PipelineMessage.Dispose" />
<MemberSignature Language="VB.NET" Value="Public Sub Dispose ()" />
<MemberSignature Language="F#" Value="abstract member Dispose : unit -> unit
override this.Dispose : unit -> unit" Usage="pipelineMessage.Dispose " />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:System.IDisposable.Dispose</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>System.ClientModel</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Dispose">
<MemberSignature Language="C#" Value="protected virtual void Dispose (bool disposing);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void Dispose(bool disposing) cil managed" />
<MemberSignature Language="DocId" Value="M:System.ClientModel.Primitives.PipelineMessage.Dispose(System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Protected Overridable Sub Dispose (disposing As Boolean)" />
<MemberSignature Language="F#" Value="abstract member Dispose : bool -> unit
override this.Dispose : bool -> unit" Usage="pipelineMessage.Dispose disposing" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.ClientModel</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="disposing" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="disposing">
<c>true</c> to release both managed and
unmanaged resources; <c>false</c> to release only unmanaged resources.
</param>
<summary>
Releases the unmanaged resources used by the
<see cref="T:System.ClientModel.Primitives.PipelineMessage" /> and optionally disposes of the managed
resources.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ExtractResponse">
<MemberSignature Language="C#" Value="public System.ClientModel.Primitives.PipelineResponse? ExtractResponse ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.ClientModel.Primitives.PipelineResponse ExtractResponse() cil managed" />
<MemberSignature Language="DocId" Value="M:System.ClientModel.Primitives.PipelineMessage.ExtractResponse" />
<MemberSignature Language="VB.NET" Value="Public Function ExtractResponse () As PipelineResponse" />
<MemberSignature Language="F#" Value="member this.ExtractResponse : unit -> System.ClientModel.Primitives.PipelineResponse" Usage="pipelineMessage.ExtractResponse " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.ClientModel</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.ClientModel.Primitives.PipelineResponse</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Returns the value of the <see cref="P:System.ClientModel.Primitives.PipelineMessage.Response" /> property and transfers
dispose ownership of the response to the caller. After calling this
method, the <see cref="P:System.ClientModel.Primitives.PipelineMessage.Response" /> property will be <code>null</code>
and the caller will be responsible for disposing the returned value,
which may hold a live network stream.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="NetworkTimeout">
<MemberSignature Language="C#" Value="public TimeSpan? NetworkTimeout { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype System.TimeSpan> NetworkTimeout" />
<MemberSignature Language="DocId" Value="P:System.ClientModel.Primitives.PipelineMessage.NetworkTimeout" />
<MemberSignature Language="VB.NET" Value="Public Property NetworkTimeout As Nullable(Of TimeSpan)" />
<MemberSignature Language="F#" Value="member this.NetworkTimeout : Nullable<TimeSpan> with get, set" Usage="System.ClientModel.Primitives.PipelineMessage.NetworkTimeout" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.ClientModel</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.TimeSpan></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the network timeout value for this message.
If <c>null</c>, the value set on the client's options will be used.
Defaults to <c>null</c>.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Request">
<MemberSignature Language="C#" Value="public System.ClientModel.Primitives.PipelineRequest Request { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.ClientModel.Primitives.PipelineRequest Request" />
<MemberSignature Language="DocId" Value="P:System.ClientModel.Primitives.PipelineMessage.Request" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Request As PipelineRequest" />
<MemberSignature Language="F#" Value="member this.Request : System.ClientModel.Primitives.PipelineRequest" Usage="System.ClientModel.Primitives.PipelineMessage.Request" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.ClientModel</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.ClientModel.Primitives.PipelineRequest</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the <see cref="T:System.ClientModel.Primitives.PipelineRequest" /> to send to the service during
the call to <see cref="M:System.ClientModel.Primitives.ClientPipeline.Send(System.ClientModel.Primitives.PipelineMessage)" />.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Response">
<MemberSignature Language="C#" Value="public System.ClientModel.Primitives.PipelineResponse? Response { get; protected internal set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.ClientModel.Primitives.PipelineResponse Response" />
<MemberSignature Language="DocId" Value="P:System.ClientModel.Primitives.PipelineMessage.Response" />
<MemberSignature Language="VB.NET" Value="Public Property Response As PipelineResponse" />
<MemberSignature Language="F#" Value="member this.Response : System.ClientModel.Primitives.PipelineResponse with get, set" Usage="System.ClientModel.Primitives.PipelineMessage.Response" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.ClientModel</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.ClientModel.Primitives.PipelineResponse</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the <see cref="T:System.ClientModel.Primitives.PipelineResponse" /> received from the service during
the call to <see cref="M:System.ClientModel.Primitives.ClientPipeline.Send(System.ClientModel.Primitives.PipelineMessage)" />.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ResponseClassifier">
<MemberSignature Language="C#" Value="public System.ClientModel.Primitives.PipelineMessageClassifier ResponseClassifier { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.ClientModel.Primitives.PipelineMessageClassifier ResponseClassifier" />
<MemberSignature Language="DocId" Value="P:System.ClientModel.Primitives.PipelineMessage.ResponseClassifier" />
<MemberSignature Language="VB.NET" Value="Public Property ResponseClassifier As PipelineMessageClassifier" />
<MemberSignature Language="F#" Value="member this.ResponseClassifier : System.ClientModel.Primitives.PipelineMessageClassifier with get, set" Usage="System.ClientModel.Primitives.PipelineMessage.ResponseClassifier" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.ClientModel</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.ClientModel.Primitives.PipelineMessageClassifier</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the <see cref="T:System.ClientModel.Primitives.PipelineMessageClassifier" /> used by the
<see cref="T:System.ClientModel.Primitives.ClientPipeline" /> to determine whether the response received
from the service is considered an error and populate the
<see cref="P:System.ClientModel.Primitives.PipelineResponse.IsError" /> on <see cref="P:System.ClientModel.Primitives.PipelineMessage.Response" />.
This property is intended to be set in a client's service method to a
a <see cref="T:System.ClientModel.Primitives.PipelineMessageClassifier" /> that classifies responses as
success responses based on the service API's published success codes.
Setting this value outside the service method will override the
client-specified classifier and may result in undesired behavior.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SetProperty">
<MemberSignature Language="C#" Value="public void SetProperty (Type key, object? value);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetProperty(class System.Type key, object value) cil managed" />
<MemberSignature Language="DocId" Value="M:System.ClientModel.Primitives.PipelineMessage.SetProperty(System.Type,System.Object)" />
<MemberSignature Language="VB.NET" Value="Public Sub SetProperty (key As Type, value As Object)" />
<MemberSignature Language="F#" Value="member this.SetProperty : Type * obj -> unit" Usage="pipelineMessage.SetProperty (key, value)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.ClientModel</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="key" Type="System.Type" />
<Parameter Name="value" Type="System.Object" />
</Parameters>
<Docs>
<param name="key">The key for the property in the message's property
bag.</param>
<param name="value">The value of the property.</param>
<summary>
Set a property in the property bag for this <see cref="T:System.ClientModel.Primitives.PipelineMessage" />
instance. Message properties are used to govern the behavior of specific
policies in the <see cref="T:System.ClientModel.Primitives.ClientPipeline" />. Please refer to
documentation for a specific <see cref="T:System.ClientModel.Primitives.PipelinePolicy" /> to understand
what properties it supports.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TryGetProperty">
<MemberSignature Language="C#" Value="public bool TryGetProperty (Type key, out object? value);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool TryGetProperty(class System.Type key, [out] object& value) cil managed" />
<MemberSignature Language="DocId" Value="M:System.ClientModel.Primitives.PipelineMessage.TryGetProperty(System.Type,System.Object@)" />
<MemberSignature Language="VB.NET" Value="Public Function TryGetProperty (key As Type, ByRef value As Object) As Boolean" />
<MemberSignature Language="F#" Value="member this.TryGetProperty : Type * obj -> bool" Usage="pipelineMessage.TryGetProperty (key, value)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.ClientModel</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="key" Type="System.Type" />
<Parameter Name="value" Type="System.Object" RefType="out" />
</Parameters>
<Docs>
<param name="key">The key for the property in the message's property
bag.</param>
<param name="value">The value of the property.</param>
<summary>
Attempts to get a property from the property bag for this
<see cref="T:System.ClientModel.Primitives.PipelineMessage" /> instance. Message properties are used to
govern the behavior of specific policies in the
<see cref="T:System.ClientModel.Primitives.ClientPipeline" />. Please refer to documentation for a
specific <see cref="T:System.ClientModel.Primitives.PipelinePolicy" /> to understand what properties it
supports.
</summary>
<returns>
<c>true</c> if property exists; otherwise <c>false</c>.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>