Package software.amazon.awssdk.retry

Class RetryPolicy

java.lang.Object

software.amazon.awssdk.retry.RetryPolicy

@Immutable
public final class RetryPolicy
extends Object

Retry policy that can be configured on a specific service client using LegacyClientConfiguration. This class is immutable, therefore safe to be shared by multiple clients.

See Also:

LegacyClientConfiguration, PredefinedRetryPolicies

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RetryPolicy.BackoffStrategy	The hook for providing custom back-off strategy to control the sleep time between retries.
static interface	RetryPolicy.RetryCondition	The hook for providing custom condition on whether a failed request should be retried.

Constructor Summary

Constructors

Constructor	Description
RetryPolicy(RetryPolicy.RetryCondition retryCondition, RetryPolicy.BackoffStrategy backoffStrategy, int maxErrorRetry, boolean honorMaxErrorRetryInClientConfig)	Constructs a new retry policy.

Method Summary

Modifier and Type	Method	Description
RetryPolicy.BackoffStrategy	getBackoffStrategy()	Returns the back-off strategy included in this retry policy.
int	getMaxErrorRetry()	Returns the maximum number of retry attempts.
RetryPolicy.RetryCondition	getRetryCondition()	Returns the retry condition included in this retry policy.
boolean	isMaxErrorRetryInClientConfigHonored()	Returns whether this retry policy should honor the max error retry set in ClientConfiguration.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RetryPolicy

public RetryPolicy(RetryPolicy.RetryCondition retryCondition,
                   RetryPolicy.BackoffStrategy backoffStrategy,
                   int maxErrorRetry,
                   boolean honorMaxErrorRetryInClientConfig)

Constructs a new retry policy. See PredefinedRetryPolicies for some pre-defined policy components, and also the default policies used by SDK.

Parameters:

retryCondition - Retry condition on whether a specific request and exception should be retried. If null value is specified, the SDK' default retry condition is used.

backoffStrategy - Back-off strategy for controlling how long the next retry should wait. If null value is specified, the SDK' default exponential back-off strategy is used.

maxErrorRetry - Maximum number of retry attempts for failed requests.

honorMaxErrorRetryInClientConfig - Whether this retry policy should honor the max error retry set by LegacyClientConfiguration.setMaxErrorRetry(int)

See Also:

LegacyClientConfiguration, PredefinedRetryPolicies

Method Detail

getRetryCondition

public RetryPolicy.RetryCondition getRetryCondition()

Returns the retry condition included in this retry policy.

Returns:

The retry condition included in this retry policy.

getBackoffStrategy

public RetryPolicy.BackoffStrategy getBackoffStrategy()

Returns the back-off strategy included in this retry policy.

Returns:

The back-off strategy included in this retry policy.

getMaxErrorRetry

public int getMaxErrorRetry()

Returns the maximum number of retry attempts.

Returns:

The maximum number of retry attempts.

isMaxErrorRetryInClientConfigHonored

public boolean isMaxErrorRetryInClientConfigHonored()

Returns whether this retry policy should honor the max error retry set in ClientConfiguration.

Returns:

Whether this retry policy should honor the max error retry set in ClientConfiguration

See Also:

LegacyClientConfiguration.setMaxErrorRetry(int)