Package com.azure.core.http.policy
Class ExponentialBackoffOptions
java.lang.Object
com.azure.core.http.policy.ExponentialBackoffOptions
The configuration for exponential backoff that has a delay duration that exponentially
increases with each retry attempt until an upper bound is reached after which every retry attempt is delayed by the
provided max delay duration.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGets the base delay duration for retry.Gets the max delay duration for retry.Gets the max retry attempts that can be made.setBaseDelay
(Duration baseDelay) Sets the base delay duration for retry.setMaxDelay
(Duration maxDelay) Sets the max delay duration for retry.setMaxRetries
(Integer maxRetries) Sets the max retry attempts that can be made.
-
Constructor Details
-
ExponentialBackoffOptions
public ExponentialBackoffOptions()Creates a new instance ofExponentialBackoffOptions
.
-
-
Method Details
-
getMaxRetries
Gets the max retry attempts that can be made.- Returns:
- The max retry attempts that can be made.
-
setMaxRetries
Sets the max retry attempts that can be made.- Parameters:
maxRetries
- the max retry attempts that can be made.- Returns:
- The updated
ExponentialBackoffOptions
- Throws:
IllegalArgumentException
- ifmaxRetries
is less than 0.
-
getBaseDelay
Gets the base delay duration for retry.- Returns:
- The base delay duration for retry.
-
setBaseDelay
Sets the base delay duration for retry.- Parameters:
baseDelay
- the base delay duration for retry.- Returns:
- The updated
ExponentialBackoffOptions
- Throws:
IllegalArgumentException
- ifbaseDelay
is less than or equal to 0 ormaxDelay
has been set and is less thanbaseDelay
.
-
getMaxDelay
Gets the max delay duration for retry.- Returns:
- The max delay duration for retry.
-
setMaxDelay
Sets the max delay duration for retry.- Parameters:
maxDelay
- the max delay duration for retry.- Returns:
- The updated
ExponentialBackoffOptions
- Throws:
IllegalArgumentException
- ifmaxDelay
is less than or equal to 0 orbaseDelay
has been set and is more thanmaxDelay
.
-