/
com.azure.core.amqp.AmqpRetryOptions.yml
187 lines (187 loc) · 12.6 KB
/
com.azure.core.amqp.AmqpRetryOptions.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
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
### YamlMime:JavaType
uid: "com.azure.core.amqp.AmqpRetryOptions"
fullName: "com.azure.core.amqp.AmqpRetryOptions"
name: "AmqpRetryOptions"
nameWithType: "AmqpRetryOptions"
summary: "A set of options that can be specified to influence how retry attempts are made."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
methodsRef:
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public class **AmqpRetryOptions**"
constructors:
- uid: "com.azure.core.amqp.AmqpRetryOptions.AmqpRetryOptions()"
fullName: "com.azure.core.amqp.AmqpRetryOptions.AmqpRetryOptions()"
name: "AmqpRetryOptions()"
nameWithType: "AmqpRetryOptions.AmqpRetryOptions()"
summary: "Creates an instance with the default retry options set."
syntax: "public AmqpRetryOptions()"
desc: "Creates an instance with the default retry options set."
- uid: "com.azure.core.amqp.AmqpRetryOptions.AmqpRetryOptions(com.azure.core.amqp.AmqpRetryOptions)"
fullName: "com.azure.core.amqp.AmqpRetryOptions.AmqpRetryOptions(AmqpRetryOptions retryOptions)"
name: "AmqpRetryOptions(AmqpRetryOptions retryOptions)"
nameWithType: "AmqpRetryOptions.AmqpRetryOptions(AmqpRetryOptions retryOptions)"
summary: "Creates an instance configured with `retryOptions`."
parameters:
- description: "Retry options to configure new instance with."
name: "retryOptions"
type: "<xref href=\"com.azure.core.amqp.AmqpRetryOptions?alt=com.azure.core.amqp.AmqpRetryOptions&text=AmqpRetryOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public AmqpRetryOptions(AmqpRetryOptions retryOptions)"
desc: "Creates an instance configured with `retryOptions`. This is not thread-safe."
methods:
- uid: "com.azure.core.amqp.AmqpRetryOptions.equals(java.lang.Object)"
fullName: "com.azure.core.amqp.AmqpRetryOptions.equals(Object obj)"
name: "equals(Object obj)"
nameWithType: "AmqpRetryOptions.equals(Object obj)"
overridden: "java.lang.Object.equals(java.lang.Object)"
parameters:
- name: "obj"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
syntax: "public boolean equals(Object obj)"
returns:
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.core.amqp.AmqpRetryOptions.getDelay()"
fullName: "com.azure.core.amqp.AmqpRetryOptions.getDelay()"
name: "getDelay()"
nameWithType: "AmqpRetryOptions.getDelay()"
summary: "Gets the delay between retry attempts for a fixed approach or the delay on which to base calculations for a backoff-approach."
syntax: "public Duration getDelay()"
desc: "Gets the delay between retry attempts for a fixed approach or the delay on which to base calculations for a backoff-approach."
returns:
description: "The delay between retry attempts."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
- uid: "com.azure.core.amqp.AmqpRetryOptions.getMaxDelay()"
fullName: "com.azure.core.amqp.AmqpRetryOptions.getMaxDelay()"
name: "getMaxDelay()"
nameWithType: "AmqpRetryOptions.getMaxDelay()"
summary: "Gets the maximum permissible delay between retry attempts."
syntax: "public Duration getMaxDelay()"
desc: "Gets the maximum permissible delay between retry attempts."
returns:
description: "The maximum permissible delay between retry attempts."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
- uid: "com.azure.core.amqp.AmqpRetryOptions.getMaxRetries()"
fullName: "com.azure.core.amqp.AmqpRetryOptions.getMaxRetries()"
name: "getMaxRetries()"
nameWithType: "AmqpRetryOptions.getMaxRetries()"
summary: "The maximum number of retry attempts before considering the associated operation to have failed."
syntax: "public int getMaxRetries()"
desc: "The maximum number of retry attempts before considering the associated operation to have failed."
returns:
description: "The maximum number of retry attempts before considering the associated operation to have failed."
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.core.amqp.AmqpRetryOptions.getMode()"
fullName: "com.azure.core.amqp.AmqpRetryOptions.getMode()"
name: "getMode()"
nameWithType: "AmqpRetryOptions.getMode()"
summary: "Gets the approach to use for calculating retry delays."
syntax: "public AmqpRetryMode getMode()"
desc: "Gets the approach to use for calculating retry delays."
returns:
description: "The approach to use for calculating retry delays."
type: "<xref href=\"com.azure.core.amqp.AmqpRetryMode?alt=com.azure.core.amqp.AmqpRetryMode&text=AmqpRetryMode\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.core.amqp.AmqpRetryOptions.getTryTimeout()"
fullName: "com.azure.core.amqp.AmqpRetryOptions.getTryTimeout()"
name: "getTryTimeout()"
nameWithType: "AmqpRetryOptions.getTryTimeout()"
summary: "Gets the maximum duration to wait for completion of a single attempt, whether the initial attempt or a retry."
syntax: "public Duration getTryTimeout()"
desc: "Gets the maximum duration to wait for completion of a single attempt, whether the initial attempt or a retry."
returns:
description: "The maximum duration to wait for completion of a single attempt, whether the initial attempt or a retry."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
- uid: "com.azure.core.amqp.AmqpRetryOptions.hashCode()"
fullName: "com.azure.core.amqp.AmqpRetryOptions.hashCode()"
name: "hashCode()"
nameWithType: "AmqpRetryOptions.hashCode()"
overridden: "java.lang.Object.hashCode()"
syntax: "public int hashCode()"
returns:
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.core.amqp.AmqpRetryOptions.setDelay(java.time.Duration)"
fullName: "com.azure.core.amqp.AmqpRetryOptions.setDelay(Duration delay)"
name: "setDelay(Duration delay)"
nameWithType: "AmqpRetryOptions.setDelay(Duration delay)"
summary: "Gets the delay between retry attempts for a fixed approach or the delay on which to base calculations for a backoff-approach."
parameters:
- description: "The delay between retry attempts."
name: "delay"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
syntax: "public AmqpRetryOptions setDelay(Duration delay)"
desc: "Gets the delay between retry attempts for a fixed approach or the delay on which to base calculations for a backoff-approach."
returns:
description: "The updated <xref uid=\"com.azure.core.amqp.AmqpRetryOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AmqpRetryOptions\"></xref> object."
type: "<xref href=\"com.azure.core.amqp.AmqpRetryOptions?alt=com.azure.core.amqp.AmqpRetryOptions&text=AmqpRetryOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.core.amqp.AmqpRetryOptions.setMaxDelay(java.time.Duration)"
fullName: "com.azure.core.amqp.AmqpRetryOptions.setMaxDelay(Duration maximumDelay)"
name: "setMaxDelay(Duration maximumDelay)"
nameWithType: "AmqpRetryOptions.setMaxDelay(Duration maximumDelay)"
summary: "Sets the maximum permissible delay between retry attempts."
parameters:
- description: "The maximum permissible delay between retry attempts."
name: "maximumDelay"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
syntax: "public AmqpRetryOptions setMaxDelay(Duration maximumDelay)"
desc: "Sets the maximum permissible delay between retry attempts."
returns:
description: "The updated <xref uid=\"com.azure.core.amqp.AmqpRetryOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AmqpRetryOptions\"></xref> object."
type: "<xref href=\"com.azure.core.amqp.AmqpRetryOptions?alt=com.azure.core.amqp.AmqpRetryOptions&text=AmqpRetryOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.core.amqp.AmqpRetryOptions.setMaxRetries(int)"
fullName: "com.azure.core.amqp.AmqpRetryOptions.setMaxRetries(int numberOfRetries)"
name: "setMaxRetries(int numberOfRetries)"
nameWithType: "AmqpRetryOptions.setMaxRetries(int numberOfRetries)"
summary: "Sets the maximum number of retry attempts before considering the associated operation to have failed."
parameters:
- description: "The maximum number of retry attempts."
name: "numberOfRetries"
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
syntax: "public AmqpRetryOptions setMaxRetries(int numberOfRetries)"
desc: "Sets the maximum number of retry attempts before considering the associated operation to have failed."
returns:
description: "The updated <xref uid=\"com.azure.core.amqp.AmqpRetryOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AmqpRetryOptions\"></xref> object."
type: "<xref href=\"com.azure.core.amqp.AmqpRetryOptions?alt=com.azure.core.amqp.AmqpRetryOptions&text=AmqpRetryOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.core.amqp.AmqpRetryOptions.setMode(com.azure.core.amqp.AmqpRetryMode)"
fullName: "com.azure.core.amqp.AmqpRetryOptions.setMode(AmqpRetryMode retryMode)"
name: "setMode(AmqpRetryMode retryMode)"
nameWithType: "AmqpRetryOptions.setMode(AmqpRetryMode retryMode)"
summary: "Sets the approach to use for calculating retry delays."
parameters:
- description: "The retry approach to use for calculating delays."
name: "retryMode"
type: "<xref href=\"com.azure.core.amqp.AmqpRetryMode?alt=com.azure.core.amqp.AmqpRetryMode&text=AmqpRetryMode\" data-throw-if-not-resolved=\"False\" />"
syntax: "public AmqpRetryOptions setMode(AmqpRetryMode retryMode)"
desc: "Sets the approach to use for calculating retry delays."
returns:
description: "The updated <xref uid=\"com.azure.core.amqp.AmqpRetryOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AmqpRetryOptions\"></xref> object."
type: "<xref href=\"com.azure.core.amqp.AmqpRetryOptions?alt=com.azure.core.amqp.AmqpRetryOptions&text=AmqpRetryOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.core.amqp.AmqpRetryOptions.setTryTimeout(java.time.Duration)"
fullName: "com.azure.core.amqp.AmqpRetryOptions.setTryTimeout(Duration tryTimeout)"
name: "setTryTimeout(Duration tryTimeout)"
nameWithType: "AmqpRetryOptions.setTryTimeout(Duration tryTimeout)"
summary: "Sets the maximum duration to wait for completion of a single attempt, whether the initial attempt or a retry."
parameters:
- description: "The maximum duration to wait for completion."
name: "tryTimeout"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
syntax: "public AmqpRetryOptions setTryTimeout(Duration tryTimeout)"
desc: "Sets the maximum duration to wait for completion of a single attempt, whether the initial attempt or a retry."
returns:
description: "The updated <xref uid=\"com.azure.core.amqp.AmqpRetryOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AmqpRetryOptions\"></xref> object."
type: "<xref href=\"com.azure.core.amqp.AmqpRetryOptions?alt=com.azure.core.amqp.AmqpRetryOptions&text=AmqpRetryOptions\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "A set of options that can be specified to influence how retry attempts are made."
metadata: {}
package: "com.azure.core.amqp"
artifact: com.azure:azure-core-amqp:2.9.4