Package software.amazon.awssdk.core.retry

Interface RetryPolicy.Builder

All Superinterfaces:

Buildable, CopyableBuilder<RetryPolicy.Builder,RetryPolicy>, SdkBuilder<RetryPolicy.Builder,RetryPolicy>

Enclosing class:

RetryPolicy

public static interface RetryPolicy.Builder
extends CopyableBuilder<RetryPolicy.Builder,RetryPolicy>

Method Summary

Modifier and Type	Method	Description
boolean	additionalRetryConditionsAllowed()
RetryPolicy.Builder	additionalRetryConditionsAllowed(boolean additionalRetryConditionsAllowed)	Configure whether further conditions can be added to this policy after it is created.
BackoffStrategy	backoffStrategy()
RetryPolicy.Builder	backoffStrategy(BackoffStrategy backoffStrategy)	Configure the backoff strategy that should be used for waiting in between retry attempts.
RetryPolicy	build()	An immutable object that is created from the properties that have been set on the builder.
RetryPolicy.Builder	fastFailRateLimiting(Boolean fastFailRateLimiting)	Whether 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.
Boolean	isFastFailRateLimiting()	Whether 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.
Integer	numRetries()
RetryPolicy.Builder	numRetries(Integer numRetries)	Configure the maximum number of times that a single request should be retried, assuming it fails for a retryable error.
RetryCondition	retryCapacityCondition()
RetryPolicy.Builder	retryCapacityCondition(RetryCondition retryCapacityCondition)	Configure the RetryCondition that should be used to throttle the number of retries attempted by the SDK client as a whole.
RetryCondition	retryCondition()
RetryPolicy.Builder	retryCondition(RetryCondition retryCondition)	Configure the condition under which the request should be retried.
BackoffStrategy	throttlingBackoffStrategy()
RetryPolicy.Builder	throttlingBackoffStrategy(BackoffStrategy backoffStrategy)	Configure the backoff strategy that should be used for waiting in between retry attempts after a throttling error is encountered.

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

copy

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

applyMutation

Method Details

additionalRetryConditionsAllowed

RetryPolicy.Builder additionalRetryConditionsAllowed(boolean additionalRetryConditionsAllowed)

Configure whether further conditions can be added to this policy after it is created. This may include service- specific retry conditions that may not otherwise be covered by the RetryCondition.defaultRetryCondition().

By default, this is true.

additionalRetryConditionsAllowed

boolean additionalRetryConditionsAllowed()

See Also:

• additionalRetryConditionsAllowed(boolean)

backoffStrategy

RetryPolicy.Builder backoffStrategy(BackoffStrategy backoffStrategy)

Configure the backoff strategy that should be used for waiting in between retry attempts. If the retry is because of throttling reasons, the throttlingBackoffStrategy(BackoffStrategy) is used instead.

backoffStrategy

BackoffStrategy backoffStrategy()

See Also:

• backoffStrategy(BackoffStrategy)

throttlingBackoffStrategy

RetryPolicy.Builder throttlingBackoffStrategy(BackoffStrategy backoffStrategy)

Configure the backoff strategy that should be used for waiting in between retry attempts after a throttling error is encountered. If the retry is not because of throttling reasons, the backoffStrategy(BackoffStrategy) is used instead.

throttlingBackoffStrategy

BackoffStrategy throttlingBackoffStrategy()

See Also:

• throttlingBackoffStrategy(BackoffStrategy)

retryCondition

RetryPolicy.Builder retryCondition(RetryCondition retryCondition)

Configure the condition under which the request should be retried.

While this can be any interface that implements RetryCondition, it is encouraged to use numRetries(Integer) when attempting to limit the number of times the SDK will retry an attempt or the retryCapacityCondition(RetryCondition) when attempting to configure the throttling of retries. This guidance is because the SDK uses the RetryPolicy.aggregateRetryCondition() when determining whether or not to retry a request, and the aggregateRetryCondition includes the numRetries and retryCapacityCondition in its determination.

retryCondition

RetryCondition retryCondition()

See Also:

• retryCondition(RetryCondition)

retryCapacityCondition

RetryPolicy.Builder retryCapacityCondition(RetryCondition retryCapacityCondition)

Configure the RetryCondition that should be used to throttle the number of retries attempted by the SDK client as a whole.

While any RetryCondition (or null) can be used, by convention these conditions are usually stateful and work globally for the whole client to limit the overall capacity of the client to execute retries.

By default the TokenBucketRetryCondition is used. This can be disabled by setting the value to null (not RetryPolicy#none(), which would completely disable retries).

retryCapacityCondition

RetryCondition retryCapacityCondition()

See Also:

• retryCapacityCondition(RetryCondition)

numRetries

RetryPolicy.Builder numRetries(Integer numRetries)

Configure the maximum number of times that a single request should be retried, assuming it fails for a retryable error.

numRetries

Integer numRetries()

See Also:

• numRetries(Integer)

fastFailRateLimiting

RetryPolicy.Builder fastFailRateLimiting(Boolean fastFailRateLimiting)

Whether 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.

Parameters:

fastFailRateLimiting - Whether to fast fail.

isFastFailRateLimiting

Boolean isFastFailRateLimiting()

Whether 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.

build

RetryPolicy build()

Description copied from interface: SdkBuilder

An immutable object that is created from the properties that have been set on the builder.

Specified by:

build in interface Buildable

Specified by:

build in interface SdkBuilder<RetryPolicy.Builder,RetryPolicy>

Returns:

an instance of T