com.ibm.cos.v2.retries.internal

Class DefaultAdaptiveRetryStrategy.Builder

java.lang.Object

com.ibm.cos.v2.retries.internal.BaseRetryStrategy.Builder

com.ibm.cos.v2.retries.internal.DefaultAdaptiveRetryStrategy.Builder

All Implemented Interfaces:

AdaptiveRetryStrategy.Builder, RetryStrategy.Builder<AdaptiveRetryStrategy.Builder,AdaptiveRetryStrategy>, DefaultAwareRetryStrategy.Builder, Buildable, SdkBuilder<AdaptiveRetryStrategy.Builder,AdaptiveRetryStrategy>

Enclosing class:

DefaultAdaptiveRetryStrategy

public static class DefaultAdaptiveRetryStrategy.Builder
extends BaseRetryStrategy.Builder
implements AdaptiveRetryStrategy.Builder

Method Summary

Modifier and Type	Method and Description
DefaultAdaptiveRetryStrategy.Builder	backoffStrategy(BackoffStrategy backoffStrategy) Configure the backoff strategy used by the retry strategy.
AdaptiveRetryStrategy	build() Build a new RetryStrategy with the current configuration on this builder.
DefaultAdaptiveRetryStrategy.Builder	circuitBreakerEnabled(Boolean circuitBreakerEnabled)
DefaultAdaptiveRetryStrategy.Builder	maxAttempts(int maxAttempts) Configure the maximum number of attempts used by the retry strategy.
DefaultAdaptiveRetryStrategy.Builder	rateLimiterTokenBucketStore(RateLimiterTokenBucketStore rateLimiterTokenBucketStore)
DefaultAdaptiveRetryStrategy.Builder	retryOnException(Predicate<Throwable> shouldRetry) Configure the strategy to retry when the provided predicate returns true, given a failure exception.
DefaultAdaptiveRetryStrategy.Builder	throttlingBackoffStrategy(BackoffStrategy backoffStrategy) Configure the backoff strategy used for throttling exceptions by this strategy.
DefaultAdaptiveRetryStrategy.Builder	tokenBucketExceptionCost(int exceptionCost)
DefaultAdaptiveRetryStrategy.Builder	tokenBucketStore(TokenBucketStore tokenBucketStore)
DefaultAdaptiveRetryStrategy.Builder	treatAsThrottling(Predicate<Throwable> treatAsThrottling) Configure the predicate to allow the strategy categorize a Throwable as throttling exception.
DefaultAdaptiveRetryStrategy.Builder	useClientDefaults(boolean useClientDefaults) Configure whether the default predicates should be used, or not.

Methods inherited from class com.ibm.cos.v2.retries.internal.BaseRetryStrategy.Builder

markDefaultAdded

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.ibm.cos.v2.retries.api.RetryStrategy.Builder

retryOnException, retryOnExceptionInstanceOf, retryOnExceptionOrCause, retryOnExceptionOrCauseInstanceOf, retryOnRootCause, retryOnRootCauseInstanceOf

Methods inherited from interface com.ibm.cos.v2.utils.builder.SdkBuilder

applyMutation

Method Detail

retryOnException

public DefaultAdaptiveRetryStrategy.Builder retryOnException(Predicate<Throwable> shouldRetry)

Description copied from interface: RetryStrategy.Builder

Configure the strategy to retry when the provided predicate returns true, given a failure exception.

Specified by:

retryOnException in interface RetryStrategy.Builder<AdaptiveRetryStrategy.Builder,AdaptiveRetryStrategy>

maxAttempts

public DefaultAdaptiveRetryStrategy.Builder maxAttempts(int maxAttempts)

Description copied from interface: RetryStrategy.Builder

Configure the maximum number of attempts used by the retry strategy.

The actual number of attempts made may be less, depending on the retry strategy implementation. For example, the standard and adaptive retry modes both employ short-circuiting which reduces the maximum attempts during outages.

The default value for the standard and adaptive retry strategies is 3.

Specified by:

maxAttempts in interface RetryStrategy.Builder<AdaptiveRetryStrategy.Builder,AdaptiveRetryStrategy>

treatAsThrottling

public DefaultAdaptiveRetryStrategy.Builder treatAsThrottling(Predicate<Throwable> treatAsThrottling)

Description copied from interface: AdaptiveRetryStrategy.Builder

Configure the predicate to allow the strategy categorize a Throwable as throttling exception.

Specified by:

treatAsThrottling in interface AdaptiveRetryStrategy.Builder

Specified by:

treatAsThrottling in interface RetryStrategy.Builder<AdaptiveRetryStrategy.Builder,AdaptiveRetryStrategy>

backoffStrategy

public DefaultAdaptiveRetryStrategy.Builder backoffStrategy(BackoffStrategy backoffStrategy)

Description copied from interface: RetryStrategy.Builder

Configure the backoff strategy used by the retry strategy.

By default, this uses jittered exponential backoff.

Specified by:

backoffStrategy in interface RetryStrategy.Builder<AdaptiveRetryStrategy.Builder,AdaptiveRetryStrategy>

throttlingBackoffStrategy

public DefaultAdaptiveRetryStrategy.Builder throttlingBackoffStrategy(BackoffStrategy backoffStrategy)

Description copied from interface: RetryStrategy.Builder

Configure the backoff strategy used for throttling exceptions by this strategy.

By default, this uses jittered exponential backoff.

Specified by:

throttlingBackoffStrategy in interface RetryStrategy.Builder<AdaptiveRetryStrategy.Builder,AdaptiveRetryStrategy>

circuitBreakerEnabled

public DefaultAdaptiveRetryStrategy.Builder circuitBreakerEnabled(Boolean circuitBreakerEnabled)

tokenBucketExceptionCost

public DefaultAdaptiveRetryStrategy.Builder tokenBucketExceptionCost(int exceptionCost)

rateLimiterTokenBucketStore

public DefaultAdaptiveRetryStrategy.Builder rateLimiterTokenBucketStore(RateLimiterTokenBucketStore rateLimiterTokenBucketStore)

tokenBucketStore

public DefaultAdaptiveRetryStrategy.Builder tokenBucketStore(TokenBucketStore tokenBucketStore)

useClientDefaults

public DefaultAdaptiveRetryStrategy.Builder useClientDefaults(boolean useClientDefaults)

Description copied from interface: RetryStrategy.Builder

Configure whether the default predicates should be used, or not. When set to false, only user-provided retry predicates will be considered to determine what should be retried or not. Setting this to false and providing no predicate will result in an empty retry strategy.

Specified by:

useClientDefaults in interface RetryStrategy.Builder<AdaptiveRetryStrategy.Builder,AdaptiveRetryStrategy>

build

public AdaptiveRetryStrategy build()

Description copied from interface: RetryStrategy.Builder

Build a new RetryStrategy with the current configuration on this builder.

Specified by:

build in interface AdaptiveRetryStrategy.Builder

Specified by:

build in interface RetryStrategy.Builder<AdaptiveRetryStrategy.Builder,AdaptiveRetryStrategy>

Specified by:

build in interface Buildable

Specified by:

build in interface SdkBuilder<AdaptiveRetryStrategy.Builder,AdaptiveRetryStrategy>

Returns:

an instance of T