-
Notifications
You must be signed in to change notification settings - Fork 223
/
com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.yml
155 lines (153 loc) · 13.2 KB
/
com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.yml
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
### YamlMime:JavaType
constructors:
- fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.RetryStrategy(String name, boolean firstFastRetry)
name: RetryStrategy(String name, boolean firstFastRetry)
nameWithType: RetryStrategy.RetryStrategy(String name, boolean firstFastRetry)
parameters:
- description: <p>The name of the retry strategy. </p>
name: name
type: <xref href="String?alt=String&text=String" data-throw-if-not-resolved="False"/>
- description: <p>true to immediately retry in the first attempt; otherwise, false. The subsequent retries will remain subject to the configured retry interval. </p>
name: firstFastRetry
type: <xref href="boolean?alt=boolean&text=boolean" data-throw-if-not-resolved="False"/>
summary: >-
<p>Initializes a new instance of the <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy" data-throw-if-not-resolved="false" data-raw-source="RetryStrategy"></xref> class.</p>
<p></p>
syntax: protected RetryStrategy(String name, boolean firstFastRetry)
uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.RetryStrategy(String,boolean)
fields:
- field:
type: <xref href="final+Duration?alt=final+Duration&text=final+Duration" data-throw-if-not-resolved="False"/>
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.DEFAULT_CLIENT_BACKOFF
name: DEFAULT_CLIENT_BACKOFF
nameWithType: RetryStrategy.DEFAULT_CLIENT_BACKOFF
summary: <p>Represents the default amount of time used when calculating a random delta in the exponential delay between retries. </p>
syntax: public static final Duration DEFAULT_CLIENT_BACKOFF= Duration.ofSeconds(10)
uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.DEFAULT_CLIENT_BACKOFF
- field:
type: <xref href="final+int?alt=final+int&text=final+int" data-throw-if-not-resolved="False"/>
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.DEFAULT_CLIENT_RETRY_COUNT
name: DEFAULT_CLIENT_RETRY_COUNT
nameWithType: RetryStrategy.DEFAULT_CLIENT_RETRY_COUNT
summary: <p>region Public members </p><p>Represents the default number of retry attempts. </p>
syntax: public static final int DEFAULT_CLIENT_RETRY_COUNT= 10
uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.DEFAULT_CLIENT_RETRY_COUNT
- field:
type: <xref href="final+boolean?alt=final+boolean&text=final+boolean" data-throw-if-not-resolved="False"/>
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.DEFAULT_FIRST_FAST_RETRY
name: DEFAULT_FIRST_FAST_RETRY
nameWithType: RetryStrategy.DEFAULT_FIRST_FAST_RETRY
summary: <p>Represents the default flag indicating whether the first retry attempt will be made immediately, whereas subsequent retries will remain subject to the retry interval. </p>
syntax: public static final boolean DEFAULT_FIRST_FAST_RETRY= true
uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.DEFAULT_FIRST_FAST_RETRY
- field:
type: <xref href="final+Duration?alt=final+Duration&text=final+Duration" data-throw-if-not-resolved="False"/>
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.DEFAULT_MAX_BACKOFF
name: DEFAULT_MAX_BACKOFF
nameWithType: RetryStrategy.DEFAULT_MAX_BACKOFF
summary: <p>Represents the default maximum amount of time used when calculating the exponential delay between retries. </p>
syntax: public static final Duration DEFAULT_MAX_BACKOFF= Duration.ofSeconds(30)
uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.DEFAULT_MAX_BACKOFF
- field:
type: <xref href="final+Duration?alt=final+Duration&text=final+Duration" data-throw-if-not-resolved="False"/>
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.DEFAULT_MIN_BACKOFF
name: DEFAULT_MIN_BACKOFF
nameWithType: RetryStrategy.DEFAULT_MIN_BACKOFF
summary: <p>Represents the default minimum amount of time used when calculating the exponential delay between retries. </p>
syntax: public static final Duration DEFAULT_MIN_BACKOFF= Duration.ofSeconds(1)
uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.DEFAULT_MIN_BACKOFF
- field:
type: <xref href="final+Duration?alt=final+Duration&text=final+Duration" data-throw-if-not-resolved="False"/>
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.DEFAULT_RETRY_INCREMENT
name: DEFAULT_RETRY_INCREMENT
nameWithType: RetryStrategy.DEFAULT_RETRY_INCREMENT
summary: <p>Represents the default time increment between retry attempts in the progressive delay policy. </p>
syntax: public static final Duration DEFAULT_RETRY_INCREMENT= Duration.ofSeconds(1)
uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.DEFAULT_RETRY_INCREMENT
- field:
type: <xref href="final+Duration?alt=final+Duration&text=final+Duration" data-throw-if-not-resolved="False"/>
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.DEFAULT_RETRY_INTERVAL
name: DEFAULT_RETRY_INTERVAL
nameWithType: RetryStrategy.DEFAULT_RETRY_INTERVAL
summary: <p>Represents the default interval between retries. </p>
syntax: public static final Duration DEFAULT_RETRY_INTERVAL= Duration.ofSeconds(1)
uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.DEFAULT_RETRY_INTERVAL
inheritances:
- <xref href="java.lang.Object" data-throw-if-not-resolved="False"/>
methods:
- fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.getDefaultExponential()
name: getDefaultExponential()
nameWithType: RetryStrategy.getDefaultExponential()
returns:
type: <xref href="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy?alt=com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy&text=RetryStrategy" data-throw-if-not-resolved="False"/>
summary: <p>Returns a default policy that implements a random exponential retry interval configured with the <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.DEFAULT_CLIENT_RETRY_COUNT" data-throw-if-not-resolved="false" data-raw-source="RetryStrategy.DEFAULT_CLIENT_RETRY_COUNT"></xref>, <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.DEFAULT_MIN_BACKOFF" data-throw-if-not-resolved="false" data-raw-source="RetryStrategy.DEFAULT_MIN_BACKOFF"></xref>, <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.DEFAULT_MAX_BACKOFF" data-throw-if-not-resolved="false" data-raw-source="RetryStrategy.DEFAULT_MAX_BACKOFF"></xref>, and <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.DEFAULT_CLIENT_BACKOFF" data-throw-if-not-resolved="false" data-raw-source="RetryStrategy.DEFAULT_CLIENT_BACKOFF"></xref> parameters. The default retry policy treats all caught exceptions as transient errors. </p>
syntax: public static RetryStrategy getDefaultExponential()
uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.getDefaultExponential()
- fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.getDefaultFixed()
name: getDefaultFixed()
nameWithType: RetryStrategy.getDefaultFixed()
returns:
type: <xref href="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy?alt=com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy&text=RetryStrategy" data-throw-if-not-resolved="False"/>
summary: <p>Returns a default policy that implements a fixed retry interval configured with the <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.DEFAULT_CLIENT_RETRY_COUNT" data-throw-if-not-resolved="false" data-raw-source="RetryStrategy.DEFAULT_CLIENT_RETRY_COUNT"></xref> and <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.DEFAULT_RETRY_INTERVAL" data-throw-if-not-resolved="false" data-raw-source="RetryStrategy.DEFAULT_RETRY_INTERVAL"></xref> parameters. The default retry policy treats all caught exceptions as transient errors. </p>
syntax: public static RetryStrategy getDefaultFixed()
uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.getDefaultFixed()
- fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.getDefaultProgressive()
name: getDefaultProgressive()
nameWithType: RetryStrategy.getDefaultProgressive()
returns:
type: <xref href="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy?alt=com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy&text=RetryStrategy" data-throw-if-not-resolved="False"/>
summary: <p>Returns a default policy that implements a progressive retry interval configured with the <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.DEFAULT_CLIENT_RETRY_COUNT" data-throw-if-not-resolved="false" data-raw-source="RetryStrategy.DEFAULT_CLIENT_RETRY_COUNT"></xref>, <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.DEFAULT_RETRY_INTERVAL" data-throw-if-not-resolved="false" data-raw-source="RetryStrategy.DEFAULT_RETRY_INTERVAL"></xref>, and <xref uid="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.DEFAULT_RETRY_INCREMENT" data-throw-if-not-resolved="false" data-raw-source="RetryStrategy.DEFAULT_RETRY_INCREMENT"></xref> parameters. The default retry policy treats all caught exceptions as transient errors. </p>
syntax: public static RetryStrategy getDefaultProgressive()
uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.getDefaultProgressive()
- fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.getFastFirstRetry()
name: getFastFirstRetry()
nameWithType: RetryStrategy.getFastFirstRetry()
returns:
type: <xref href="final+boolean?alt=final+boolean&text=final+boolean" data-throw-if-not-resolved="False"/>
syntax: public final boolean getFastFirstRetry()
uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.getFastFirstRetry()
- fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.getName()
name: getName()
nameWithType: RetryStrategy.getName()
returns:
type: <xref href="final+String?alt=final+String&text=final+String" data-throw-if-not-resolved="False"/>
syntax: public final String getName()
uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.getName()
- fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.getNoRetry()
name: getNoRetry()
nameWithType: RetryStrategy.getNoRetry()
returns:
type: <xref href="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy?alt=com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy&text=RetryStrategy" data-throw-if-not-resolved="False"/>
summary: <p>Returns a default policy that performs no retries, but invokes the action only once. </p>
syntax: public static RetryStrategy getNoRetry()
uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.getNoRetry()
- fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.getShouldRetry()
name: getShouldRetry()
nameWithType: RetryStrategy.getShouldRetry()
returns:
description: <p>The ShouldRetry delegate. </p>
type: abstract <xref href="com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ShouldRetry?alt=com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.ShouldRetry&text=ShouldRetry" data-throw-if-not-resolved="False"/>
summary: >-
<p>Returns the corresponding ShouldRetry delegate.</p>
<p></p>
syntax: public abstract ShouldRetry getShouldRetry()
uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.getShouldRetry()
- fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.setFastFirstRetry(boolean value)
name: setFastFirstRetry(boolean value)
nameWithType: RetryStrategy.setFastFirstRetry(boolean value)
parameters:
- name: value
type: <xref href="boolean?alt=boolean&text=boolean" data-throw-if-not-resolved="False"/>
returns:
type: <xref href="final+void?alt=final+void&text=final+void" data-throw-if-not-resolved="False"/>
syntax: public final void setFastFirstRetry(boolean value)
uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy.setFastFirstRetry(boolean)
nameWithType: RetryStrategy
syntax: public class RetryStrategy
type: class
uid: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy
fullName: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling.RetryStrategy
name: RetryStrategy
package: com.microsoft.azure.elasticdb.core.commons.transientfaulthandling
summary: <p>Represents a retry strategy that determines the number of retry attempts and the interval between retries. </p>
metadata: {}