Package software.amazon.awssdk.core.retry

Class RetryPolicy

java.lang.Object

software.amazon.awssdk.core.retry.RetryPolicy

All Implemented Interfaces:

ToCopyableBuilder<RetryPolicy.Builder,RetryPolicy>

@Immutable
public final class RetryPolicy
extends Object
implements ToCopyableBuilder<RetryPolicy.Builder,RetryPolicy>

Interface for specifying a retry policy to use when evaluating whether or not a request should be retried. The builder()} can be used to construct a retry policy from SDK provided policies or policies that directly implement BackoffStrategy and/or RetryCondition. This is configured on a client via ClientOverrideConfiguration.Builder.retryPolicy(software.amazon.awssdk.core.retry.RetryPolicy). When using the builder() the SDK will use default values for fields that are not provided. The default number of retries and condition is based on the current RetryMode.

See Also:

• for a list of SDK provided retry condition strategies
• for a list of SDK provided backoff strategies

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RetryPolicy.Builder

Method Summary

Modifier and Type	Method	Description
boolean	additionalRetryConditionsAllowed()	Returns true if service-specific conditions are allowed on this policy (e.g.
RetryCondition	aggregateRetryCondition()	Retrieve the retry condition that aggregates the RetryPolicy.Builder.retryCondition(RetryCondition), RetryPolicy.Builder.numRetries(Integer) and RetryPolicy.Builder.retryCapacityCondition(RetryCondition) configured on the builder.
BackoffStrategy	backoffStrategy()	Retrieve the RetryPolicy.Builder.backoffStrategy(BackoffStrategy) configured on the builder.
static RetryPolicy.Builder	builder()	Create a RetryPolicy.Builder populated with the defaults from the RetryMode.defaultRetryMode().
static RetryPolicy.Builder	builder(RetryMode retryMode)	Create a RetryPolicy.Builder populated with the defaults from the provided RetryMode.
static RetryPolicy	defaultRetryPolicy()	Create a RetryPolicy using the RetryMode.defaultRetryMode() defaults.
boolean	equals(Object o)
static RetryPolicy	forRetryMode(RetryMode retryMode)	Create a RetryPolicy using the provided RetryMode defaults.
int	hashCode()
Boolean	isFastFailRateLimiting()	When using RetryMode.ADAPTIVE retry mode, this controls the client should immediately fail the request when not enough capacity is immediately available from the rate limiter to execute the request, instead of waiting for capacity to be available.
static RetryPolicy	none()	Create a RetryPolicy that will NEVER retry.
Integer	numRetries()	Retrieve the RetryPolicy.Builder.numRetries(Integer) configured on the builder.
RetryCondition	retryCondition()	Retrieve the RetryPolicy.Builder.retryCondition(RetryCondition) configured on the builder.
RetryMode	retryMode()	Retrieve the RetryMode that was used to determine the defaults for this retry policy.
BackoffStrategy	throttlingBackoffStrategy()	Retrieve the RetryPolicy.Builder.throttlingBackoffStrategy(BackoffStrategy) configured on the builder.
RetryPolicy.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Details

defaultRetryPolicy

public static RetryPolicy defaultRetryPolicy()

Create a RetryPolicy using the RetryMode.defaultRetryMode() defaults.

forRetryMode

public static RetryPolicy forRetryMode(RetryMode retryMode)

Create a RetryPolicy using the provided RetryMode defaults.

none

public static RetryPolicy none()

Create a RetryPolicy that will NEVER retry.

builder

public static RetryPolicy.Builder builder()

Create a RetryPolicy.Builder populated with the defaults from the RetryMode.defaultRetryMode().

builder

public static RetryPolicy.Builder builder(RetryMode retryMode)

Create a RetryPolicy.Builder populated with the defaults from the provided RetryMode.

retryMode

public RetryMode retryMode()

Retrieve the RetryMode that was used to determine the defaults for this retry policy.

isFastFailRateLimiting

public Boolean isFastFailRateLimiting()

When using RetryMode.ADAPTIVE retry mode, this controls the client should immediately fail the request when not enough capacity is immediately available from the rate limiter to execute the request, instead of waiting for capacity to be available.

additionalRetryConditionsAllowed

public boolean additionalRetryConditionsAllowed()

Returns true if service-specific conditions are allowed on this policy (e.g. more conditions may be added by the SDK if they are recommended).

aggregateRetryCondition

public RetryCondition aggregateRetryCondition()

Retrieve the retry condition that aggregates the RetryPolicy.Builder.retryCondition(RetryCondition), RetryPolicy.Builder.numRetries(Integer) and RetryPolicy.Builder.retryCapacityCondition(RetryCondition) configured on the builder.

retryCondition

public RetryCondition retryCondition()

Retrieve the RetryPolicy.Builder.retryCondition(RetryCondition) configured on the builder.

backoffStrategy

public BackoffStrategy backoffStrategy()

Retrieve the RetryPolicy.Builder.backoffStrategy(BackoffStrategy) configured on the builder.

throttlingBackoffStrategy

public BackoffStrategy throttlingBackoffStrategy()

Retrieve the RetryPolicy.Builder.throttlingBackoffStrategy(BackoffStrategy) configured on the builder.

numRetries

public Integer numRetries()

Retrieve the RetryPolicy.Builder.numRetries(Integer) configured on the builder.

toBuilder

public RetryPolicy.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<RetryPolicy.Builder,RetryPolicy>

Returns:

a builder for type T

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object