Package software.amazon.awssdk.opensdk.retry

Class RetryPolicyBuilder

java.lang.Object

software.amazon.awssdk.opensdk.retry.RetryPolicyBuilder

public final class RetryPolicyBuilder
extends Object

Fluent builder to construct a RetryPolicy implementation.

Method Summary

Modifier and Type	Method	Description
RetryPolicyBuilder	backoffStrategy(BackoffStrategy backoffStrategy)	Note, this option and fixedBackoff(int) are mutually exclusive settings.
RetryPolicy	build()	Construct a RetryPolicy with the current configuration in the builder.
RetryPolicyBuilder	fixedBackoff(int backoff)	Note, this option and backoffStrategy(BackoffStrategy) are mutually exclusive settings.
RetryPolicyBuilder	maxNumberOfRetries(int maxNumberOfRetries)	The default value for max number of retries is .
RetryPolicyBuilder	retryOnExceptions(Class<? extends Exception>... exceptions)
RetryPolicyBuilder	retryOnStatusCodes(int... statusCodes)
static RetryPolicyBuilder	standard()

Methods inherited from class java.lang.Object

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

Method Detail

standard

public static RetryPolicyBuilder standard()

Returns:

Builder with standard defaults.

retryOnExceptions

@SafeVarargs
public final RetryPolicyBuilder retryOnExceptions(Class<? extends Exception>... exceptions)

Parameters:

exceptions - Exception classes to retry on.

Returns:

This object for method chaining.

retryOnStatusCodes

public RetryPolicyBuilder retryOnStatusCodes(int... statusCodes)

Parameters:

statusCodes - HTTP status codes to retry on.

Returns:

This object for method chaining.

maxNumberOfRetries

public RetryPolicyBuilder maxNumberOfRetries(int maxNumberOfRetries)

The default value for max number of retries is .

Parameters:

maxNumberOfRetries - Max number of retries to allow.

Returns:

This object for method chaining.

fixedBackoff

public RetryPolicyBuilder fixedBackoff(int backoff)

Note, this option and backoffStrategy(BackoffStrategy) are mutually exclusive settings.

If backoff strategy is not provided, PredefinedRetryPolicies.DEFAULT_BACKOFF_STRATEGY will be used.

See PredefinedBackoffStrategies for precanned implementations.

Parameters:

backoff - Fixed delay before each retry attempt.

Returns:

This object for method chaining.

backoffStrategy

public RetryPolicyBuilder backoffStrategy(BackoffStrategy backoffStrategy)

Note, this option and fixedBackoff(int) are mutually exclusive settings.

If backoff strategy is not provided, PredefinedRetryPolicies.DEFAULT_BACKOFF_STRATEGY will be used.

See PredefinedBackoffStrategies for precanned implementations.

Parameters:

backoffStrategy - Backoff strategy to use in the RetryPolicy.

Returns:

This object for method chaining.

build

public RetryPolicy build()

Construct a RetryPolicy with the current configuration in the builder.

Returns:

Configured RetryPolicy object.