Enum RetryMode
- java.lang.Object
-
- java.lang.Enum<RetryMode>
-
- software.amazon.awssdk.core.retry.RetryMode
-
- All Implemented Interfaces:
Serializable
,Comparable<RetryMode>
public enum RetryMode extends Enum<RetryMode>
A retry mode is a collection of retry behaviors encoded under a single value. For example, theLEGACY
retry mode will retry up to three times, and theSTANDARD
will retry up to two times.While the
LEGACY
retry mode is specific to Java, theSTANDARD
retry mode is standardized across all of the AWS SDKs.The retry mode can be configured:
- Directly on a client via
ClientOverrideConfiguration.Builder.retryPolicy(RetryMode)
. - Directly on a client via a combination of
RetryPolicy.builder(RetryMode)
orRetryPolicy.forRetryMode(RetryMode)
, andClientOverrideConfiguration.Builder.retryPolicy(RetryPolicy)
- On a configuration profile via the "retry_mode" profile file property.
- Globally via the "aws.retryMode" system property.
- Globally via the "AWS_RETRY_MODE" environment variable.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
RetryMode.Resolver
Allows customizing the variables used during determination of aRetryMode
.
-
Enum Constant Summary
Enum Constants Enum Constant Description ADAPTIVE
Deprecated.As of 2.25.xx, replaced byADAPTIVE_V2
.ADAPTIVE_V2
Adaptive V2 retry mode builds onSTANDARD
mode.LEGACY
The LEGACY retry mode, specific to the Java SDK, and characterized by: Up to 3 retries, or more for services like DynamoDB (which has up to 8). Zero token are subtracted from theTokenBucketRetryCondition
when throttling exceptions are encountered.STANDARD
The STANDARD retry mode, shared by all AWS SDK implementations, and characterized by: Up to 2 retries, regardless of service. Throttling exceptions are treated the same as other exceptions for the purposes of theTokenBucketRetryCondition
.
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static RetryMode
defaultRetryMode()
Retrieve the default retry mode by consulting the locations described inRetryMode
, or LEGACY if no value is configured.static RetryMode.Resolver
resolver()
Create aRetryMode.Resolver
that allows customizing the variables used during determination of aRetryMode
.static RetryMode
valueOf(String name)
Returns the enum constant of this type with the specified name.static RetryMode[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
LEGACY
public static final RetryMode LEGACY
The LEGACY retry mode, specific to the Java SDK, and characterized by:- Up to 3 retries, or more for services like DynamoDB (which has up to 8).
- Zero token are subtracted from the
TokenBucketRetryCondition
when throttling exceptions are encountered.
This is the retry mode that is used when no other mode is configured.
-
STANDARD
public static final RetryMode STANDARD
The STANDARD retry mode, shared by all AWS SDK implementations, and characterized by:- Up to 2 retries, regardless of service.
- Throttling exceptions are treated the same as other exceptions for the purposes of the
TokenBucketRetryCondition
.
-
ADAPTIVE
@Deprecated public static final RetryMode ADAPTIVE
Deprecated.As of 2.25.xx, replaced byADAPTIVE_V2
. The ADAPTIVE implementation has a bug that prevents it from remembering its state across requests which is needed to correctly estimate its sending rate. Given that this bug has been present since its introduction and that correct version might change the traffic patterns of the SDK we deemed too risky to fix this implementation.Adaptive retry mode builds onSTANDARD
mode.Adaptive retry mode dynamically limits the rate of AWS requests to maximize success rate. This may be at the expense of request latency. Adaptive retry mode is not recommended when predictable latency is important.
Warning: Adaptive retry mode assumes that the client is working against a single resource (e.g. one DynamoDB Table or one S3 Bucket). If you use a single client for multiple resources, throttling or outages associated with one resource will result in increased latency and failures when accessing all other resources via the same client. When using adaptive retry mode, we recommend using a single client per resource.
- See Also:
RetryPolicy.isFastFailRateLimiting()
-
ADAPTIVE_V2
public static final RetryMode ADAPTIVE_V2
Adaptive V2 retry mode builds onSTANDARD
mode.Adaptive retry mode dynamically limits the rate of AWS requests to maximize success rate. This may be at the expense of request latency. Adaptive V2 retry mode is not recommended when predictable latency is important.
ADAPTIVE_V2
mode differs fromADAPTIVE
mode in the computed delays between calls, including the first attempt that might be delayed if the algorithm considers that it's needed to increase the odds of a successful response.Warning: Adaptive V2 retry mode assumes that the client is working against a single resource (e.g. one DynamoDB Table or one S3 Bucket). If you use a single client for multiple resources, throttling or outages associated with one resource will result in increased latency and failures when accessing all other resources via the same client. When using adaptive retry mode, we recommend using a single client per resource.
-
-
Method Detail
-
values
public static RetryMode[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (RetryMode c : RetryMode.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static RetryMode valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-
defaultRetryMode
public static RetryMode defaultRetryMode()
Retrieve the default retry mode by consulting the locations described inRetryMode
, or LEGACY if no value is configured.
-
resolver
public static RetryMode.Resolver resolver()
Create aRetryMode.Resolver
that allows customizing the variables used during determination of aRetryMode
.
-
-