-
Notifications
You must be signed in to change notification settings - Fork 255
/
RequestContext.xml
230 lines (230 loc) · 13.1 KB
/
RequestContext.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
<Type Name="RequestContext" FullName="Azure.RequestContext">
<TypeSignature Language="C#" Value="public class RequestContext" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit RequestContext extends System.Object" />
<TypeSignature Language="DocId" Value="T:Azure.RequestContext" />
<TypeSignature Language="VB.NET" Value="Public Class RequestContext" />
<TypeSignature Language="F#" Value="type RequestContext = class" />
<AssemblyInfo>
<AssemblyName>Azure.Core</AssemblyName>
<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>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Options that can be used to control the behavior of a request sent by a client.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public RequestContext ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.RequestContext.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Core</AssemblyName>
<AssemblyVersion>1.40.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Initializes a new instance of the <see cref="T:Azure.RequestContext" /> class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AddClassifier">
<MemberSignature Language="C#" Value="public void AddClassifier (Azure.Core.ResponseClassificationHandler classifier);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void AddClassifier(class Azure.Core.ResponseClassificationHandler classifier) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.RequestContext.AddClassifier(Azure.Core.ResponseClassificationHandler)" />
<MemberSignature Language="VB.NET" Value="Public Sub AddClassifier (classifier As ResponseClassificationHandler)" />
<MemberSignature Language="F#" Value="member this.AddClassifier : Azure.Core.ResponseClassificationHandler -> unit" Usage="requestContext.AddClassifier classifier" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Core</AssemblyName>
<AssemblyVersion>1.40.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="classifier" Type="Azure.Core.ResponseClassificationHandler" />
</Parameters>
<Docs>
<param name="classifier">The custom classifier.</param>
<summary>
Customizes the <see cref="T:Azure.Core.ResponseClassifier" /> for this operation.
Adding a <see cref="T:Azure.Core.ResponseClassificationHandler" /> changes the classification
behavior so that it first tries to classify a response via the handler, and if
the handler doesn't have an opinion, it instead uses the default classifier.
Handlers are applied in order so the most recently added takes precedence.
This is useful for cases where you'd like to prevent specific response status codes from being treated as errors by
logging and distributed tracing policies -- that is, if a response is not classified as an error, it will not appear as an error in
logs or distributed traces.
</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.InvalidOperationException">If this method is called after the <see cref="T:Azure.RequestContext" /> has been
used in a method call.</exception>
</Docs>
</Member>
<Member MemberName="AddClassifier">
<MemberSignature Language="C#" Value="public void AddClassifier (int statusCode, bool isError);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void AddClassifier(int32 statusCode, bool isError) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.RequestContext.AddClassifier(System.Int32,System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Public Sub AddClassifier (statusCode As Integer, isError As Boolean)" />
<MemberSignature Language="F#" Value="member this.AddClassifier : int * bool -> unit" Usage="requestContext.AddClassifier (statusCode, isError)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Core</AssemblyName>
<AssemblyVersion>1.40.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="statusCode" Type="System.Int32" />
<Parameter Name="isError" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="statusCode">The status code to customize classification for.</param>
<param name="isError">Whether the passed-in status code should be classified as an error.</param>
<summary>
Customizes the <see cref="T:Azure.Core.ResponseClassifier" /> for this operation to change
the default <see cref="T:Azure.Response" /> classification behavior so that it considers
the passed-in status code to be an error or not, as specified.
Status code classifiers are applied after all <see cref="T:Azure.Core.ResponseClassificationHandler" /> classifiers.
This is useful for cases where you'd like to prevent specific response status codes from being treated as errors by
logging and distributed tracing policies -- that is, if a response is not classified as an error, it will not appear as an error in
logs or distributed traces.
</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentOutOfRangeException">statusCode is not between 100 and 599 (inclusive).</exception>
<exception cref="T:System.InvalidOperationException">If this method is called after the <see cref="T:Azure.RequestContext" /> has been
used in a method call.</exception>
</Docs>
</Member>
<Member MemberName="AddPolicy">
<MemberSignature Language="C#" Value="public void AddPolicy (Azure.Core.Pipeline.HttpPipelinePolicy policy, Azure.Core.HttpPipelinePosition position);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void AddPolicy(class Azure.Core.Pipeline.HttpPipelinePolicy policy, valuetype Azure.Core.HttpPipelinePosition position) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.RequestContext.AddPolicy(Azure.Core.Pipeline.HttpPipelinePolicy,Azure.Core.HttpPipelinePosition)" />
<MemberSignature Language="VB.NET" Value="Public Sub AddPolicy (policy As HttpPipelinePolicy, position As HttpPipelinePosition)" />
<MemberSignature Language="F#" Value="member this.AddPolicy : Azure.Core.Pipeline.HttpPipelinePolicy * Azure.Core.HttpPipelinePosition -> unit" Usage="requestContext.AddPolicy (policy, position)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Core</AssemblyName>
<AssemblyVersion>1.40.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="policy" Type="Azure.Core.Pipeline.HttpPipelinePolicy" />
<Parameter Name="position" Type="Azure.Core.HttpPipelinePosition" />
</Parameters>
<Docs>
<param name="policy">The <see cref="T:Azure.Core.Pipeline.HttpPipelinePolicy" /> instance to be added to the pipeline.</param>
<param name="position">The position of the policy in the pipeline.</param>
<summary>
Adds an <see cref="T:Azure.Core.Pipeline.HttpPipelinePolicy" /> into the pipeline for the duration of this request.
The position of policy in the pipeline is controlled by <paramref name="position" /> parameter.
If you want the policy to execute once per client request use <see cref="F:Azure.Core.HttpPipelinePosition.PerCall" />
otherwise use <see cref="F:Azure.Core.HttpPipelinePosition.PerRetry" /> to run the policy for every retry.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CancellationToken">
<MemberSignature Language="C#" Value="public System.Threading.CancellationToken CancellationToken { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Threading.CancellationToken CancellationToken" />
<MemberSignature Language="DocId" Value="P:Azure.RequestContext.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="Azure.RequestContext.CancellationToken" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Core</AssemblyName>
<AssemblyVersion>1.40.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.CancellationToken</ReturnType>
</ReturnValue>
<Docs>
<summary>
The token to check for cancellation.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ErrorOptions">
<MemberSignature Language="C#" Value="public Azure.ErrorOptions ErrorOptions { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Azure.ErrorOptions ErrorOptions" />
<MemberSignature Language="DocId" Value="P:Azure.RequestContext.ErrorOptions" />
<MemberSignature Language="VB.NET" Value="Public Property ErrorOptions As ErrorOptions" />
<MemberSignature Language="F#" Value="member this.ErrorOptions : Azure.ErrorOptions with get, set" Usage="Azure.RequestContext.ErrorOptions" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Core</AssemblyName>
<AssemblyVersion>1.40.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.ErrorOptions</ReturnType>
</ReturnValue>
<Docs>
<summary>
Controls under what conditions the operation raises an exception if the underlying response indicates a failure.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="op_Implicit">
<MemberSignature Language="C#" Value="public static implicit operator Azure.RequestContext (Azure.ErrorOptions options);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig specialname class Azure.RequestContext op_Implicit(valuetype Azure.ErrorOptions options) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.RequestContext.op_Implicit(Azure.ErrorOptions)~Azure.RequestContext" />
<MemberSignature Language="VB.NET" Value="Public Shared Widening Operator CType (options As ErrorOptions) As RequestContext" />
<MemberSignature Language="F#" Value="static member op_Implicit : Azure.ErrorOptions -> Azure.RequestContext" Usage="Azure.RequestContext.op_Implicit options" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Core</AssemblyName>
<AssemblyVersion>1.40.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.RequestContext</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="options" Type="Azure.ErrorOptions" />
</Parameters>
<Docs>
<param name="options" />
<summary>
Initializes a new instance of the <see cref="T:Azure.RequestContext" /> class using the given <see cref="P:Azure.RequestContext.ErrorOptions" />.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>