-
Notifications
You must be signed in to change notification settings - Fork 262
/
HttpRetryOptions.xml
195 lines (195 loc) · 10.6 KB
/
HttpRetryOptions.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
<Type Name="HttpRetryOptions" FullName="Microsoft.Azure.WebJobs.Extensions.DurableTask.HttpRetryOptions">
<TypeSignature Language="C#" Value="public class HttpRetryOptions" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit HttpRetryOptions extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.WebJobs.Extensions.DurableTask.HttpRetryOptions" />
<TypeSignature Language="VB.NET" Value="Public Class HttpRetryOptions" />
<TypeSignature Language="F#" Value="type HttpRetryOptions = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.DurableTask</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Defines retry policies that can be passed as parameters to various operations.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public HttpRetryOptions (TimeSpan firstRetryInterval, int maxNumberOfAttempts);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype System.TimeSpan firstRetryInterval, int32 maxNumberOfAttempts) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.WebJobs.Extensions.DurableTask.HttpRetryOptions.#ctor(System.TimeSpan,System.Int32)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (firstRetryInterval As TimeSpan, maxNumberOfAttempts As Integer)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.WebJobs.Extensions.DurableTask.HttpRetryOptions : TimeSpan * int -> Microsoft.Azure.WebJobs.Extensions.DurableTask.HttpRetryOptions" Usage="new Microsoft.Azure.WebJobs.Extensions.DurableTask.HttpRetryOptions (firstRetryInterval, maxNumberOfAttempts)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.DurableTask</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="firstRetryInterval" Type="System.TimeSpan" />
<Parameter Name="maxNumberOfAttempts" Type="System.Int32" />
</Parameters>
<Docs>
<param name="firstRetryInterval">Timespan to wait for the first retry.</param>
<param name="maxNumberOfAttempts">Max number of attempts to retry.</param>
<summary>
Creates a new instance SerializableRetryOptions with the supplied first retry and max attempts.
</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentException">
The <paramref name="firstRetryInterval" /> value must be greater than <see cref="F:System.TimeSpan.Zero" />.
</exception>
</Docs>
</Member>
<Member MemberName="BackoffCoefficient">
<MemberSignature Language="C#" Value="public double BackoffCoefficient { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance float64 BackoffCoefficient" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.WebJobs.Extensions.DurableTask.HttpRetryOptions.BackoffCoefficient" />
<MemberSignature Language="VB.NET" Value="Public Property BackoffCoefficient As Double" />
<MemberSignature Language="F#" Value="member this.BackoffCoefficient : double with get, set" Usage="Microsoft.Azure.WebJobs.Extensions.DurableTask.HttpRetryOptions.BackoffCoefficient" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.DurableTask</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the backoff coefficient.
</summary>
<value>
The backoff coefficient used to determine rate of increase of backoff. Defaults to 1.
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="FirstRetryInterval">
<MemberSignature Language="C#" Value="public TimeSpan FirstRetryInterval { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.TimeSpan FirstRetryInterval" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.WebJobs.Extensions.DurableTask.HttpRetryOptions.FirstRetryInterval" />
<MemberSignature Language="VB.NET" Value="Public Property FirstRetryInterval As TimeSpan" />
<MemberSignature Language="F#" Value="member this.FirstRetryInterval : TimeSpan with get, set" Usage="Microsoft.Azure.WebJobs.Extensions.DurableTask.HttpRetryOptions.FirstRetryInterval" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.DurableTask</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.TimeSpan</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the first retry interval.
</summary>
<value>
The TimeSpan to wait for the first retries.
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MaxNumberOfAttempts">
<MemberSignature Language="C#" Value="public int MaxNumberOfAttempts { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 MaxNumberOfAttempts" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.WebJobs.Extensions.DurableTask.HttpRetryOptions.MaxNumberOfAttempts" />
<MemberSignature Language="VB.NET" Value="Public Property MaxNumberOfAttempts As Integer" />
<MemberSignature Language="F#" Value="member this.MaxNumberOfAttempts : int with get, set" Usage="Microsoft.Azure.WebJobs.Extensions.DurableTask.HttpRetryOptions.MaxNumberOfAttempts" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.DurableTask</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the max number of attempts.
</summary>
<value>
The maximum number of retry attempts.
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MaxRetryInterval">
<MemberSignature Language="C#" Value="public TimeSpan MaxRetryInterval { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.TimeSpan MaxRetryInterval" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.WebJobs.Extensions.DurableTask.HttpRetryOptions.MaxRetryInterval" />
<MemberSignature Language="VB.NET" Value="Public Property MaxRetryInterval As TimeSpan" />
<MemberSignature Language="F#" Value="member this.MaxRetryInterval : TimeSpan with get, set" Usage="Microsoft.Azure.WebJobs.Extensions.DurableTask.HttpRetryOptions.MaxRetryInterval" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.DurableTask</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.TimeSpan</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the max retry interval.
</summary>
<value>
The TimeSpan of the max retry interval, defaults to 6 days.
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="RetryTimeout">
<MemberSignature Language="C#" Value="public TimeSpan RetryTimeout { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.TimeSpan RetryTimeout" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.WebJobs.Extensions.DurableTask.HttpRetryOptions.RetryTimeout" />
<MemberSignature Language="VB.NET" Value="Public Property RetryTimeout As TimeSpan" />
<MemberSignature Language="F#" Value="member this.RetryTimeout : TimeSpan with get, set" Usage="Microsoft.Azure.WebJobs.Extensions.DurableTask.HttpRetryOptions.RetryTimeout" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.DurableTask</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.TimeSpan</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the timeout for retries.
</summary>
<value>
The TimeSpan timeout for retries, defaults to <see cref="F:System.TimeSpan.MaxValue" />.
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="StatusCodesToRetry">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<System.Net.HttpStatusCode> StatusCodesToRetry { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<valuetype System.Net.HttpStatusCode> StatusCodesToRetry" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.WebJobs.Extensions.DurableTask.HttpRetryOptions.StatusCodesToRetry" />
<MemberSignature Language="VB.NET" Value="Public Property StatusCodesToRetry As IList(Of HttpStatusCode)" />
<MemberSignature Language="F#" Value="member this.StatusCodesToRetry : System.Collections.Generic.IList<System.Net.HttpStatusCode> with get, set" Usage="Microsoft.Azure.WebJobs.Extensions.DurableTask.HttpRetryOptions.StatusCodesToRetry" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.DurableTask</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<System.Net.HttpStatusCode></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the list of status codes upon which the
retry logic specified by this object shall be triggered.
If none are provided, all 4xx and 5xx status codes
will be retried.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>