com.ibm.cos.v2.retries.internal

Class DefaultStandardRetryStrategy.Builder

java.lang.Object

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

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

All Implemented Interfaces:

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

Enclosing class:

DefaultStandardRetryStrategy

public static class DefaultStandardRetryStrategy.Builder
extends BaseRetryStrategy.Builder
implements StandardRetryStrategy.Builder

Method Summary

Modifier and Type	Method and Description
DefaultStandardRetryStrategy.Builder	backoffStrategy(BackoffStrategy backoffStrategy) Configure the backoff strategy used by the retry strategy.
StandardRetryStrategy	build() Build a new RetryStrategy with the current configuration on this builder.
DefaultStandardRetryStrategy.Builder	circuitBreakerEnabled(Boolean circuitBreakerEnabled) Whether circuit breaking is enabled for this strategy.
DefaultStandardRetryStrategy.Builder	maxAttempts(int maxAttempts) Configure the maximum number of attempts used by the retry strategy.
DefaultStandardRetryStrategy.Builder	retryOnException(Predicate<Throwable> shouldRetry) Configure the strategy to retry when the provided predicate returns true, given a failure exception.
DefaultStandardRetryStrategy.Builder	throttlingBackoffStrategy(BackoffStrategy throttlingBackoffStrategy) Configure the backoff strategy used for throttling exceptions by this strategy.
DefaultStandardRetryStrategy.Builder	tokenBucketExceptionCost(int exceptionCost)
DefaultStandardRetryStrategy.Builder	tokenBucketStore(TokenBucketStore tokenBucketStore)
DefaultStandardRetryStrategy.Builder	treatAsThrottling(Predicate<Throwable> treatAsThrottling) Configure a predicate that determines whether a retryable exception is a throttling exception.
DefaultStandardRetryStrategy.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 DefaultStandardRetryStrategy.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<StandardRetryStrategy.Builder,StandardRetryStrategy>

maxAttempts

public DefaultStandardRetryStrategy.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<StandardRetryStrategy.Builder,StandardRetryStrategy>

backoffStrategy

public DefaultStandardRetryStrategy.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<StandardRetryStrategy.Builder,StandardRetryStrategy>

throttlingBackoffStrategy

public DefaultStandardRetryStrategy.Builder throttlingBackoffStrategy(BackoffStrategy throttlingBackoffStrategy)

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<StandardRetryStrategy.Builder,StandardRetryStrategy>

treatAsThrottling

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

Description copied from interface: RetryStrategy.Builder

Configure a predicate that determines whether a retryable exception is a throttling exception. When this predicate returns true, the retry strategy will use the RetryStrategy.Builder.throttlingBackoffStrategy(com.ibm.cos.v2.retries.api.BackoffStrategy). If it returns false, the RetryStrategy.Builder.backoffStrategy(com.ibm.cos.v2.retries.api.BackoffStrategy) will be used. This predicate will not be called for non-retryable exceptions.

Specified by:

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

circuitBreakerEnabled

public DefaultStandardRetryStrategy.Builder circuitBreakerEnabled(Boolean circuitBreakerEnabled)

Description copied from interface: StandardRetryStrategy.Builder

Whether circuit breaking is enabled for this strategy.

The circuit breaker will prevent attempts (even below the RetryStrategy.Builder.maxAttempts(int)) if a large number of failures are observed by this executor.

Note: The circuit breaker scope is local to the created RetryStrategy, and will therefore not be effective unless the RetryStrategy is used for more than one call. It's recommended that a RetryStrategy be reused for all calls to a single unreliable resource. It's also recommended that separate RetryStrategys be used for calls to unrelated resources.

By default, this is true.

Specified by:

circuitBreakerEnabled in interface StandardRetryStrategy.Builder

tokenBucketExceptionCost

public DefaultStandardRetryStrategy.Builder tokenBucketExceptionCost(int exceptionCost)

tokenBucketStore

public DefaultStandardRetryStrategy.Builder tokenBucketStore(TokenBucketStore tokenBucketStore)

useClientDefaults

public DefaultStandardRetryStrategy.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<StandardRetryStrategy.Builder,StandardRetryStrategy>

build

public StandardRetryStrategy build()

Description copied from interface: RetryStrategy.Builder

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

Specified by:

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

Specified by:

build in interface StandardRetryStrategy.Builder

Specified by:

build in interface Buildable

Specified by:

build in interface SdkBuilder<StandardRetryStrategy.Builder,StandardRetryStrategy>

Returns:

an instance of T