com.ibm.cos.v2.retries.internal

Class DefaultLegacyRetryStrategy.Builder

java.lang.Object

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

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

All Implemented Interfaces:

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

Enclosing class:

DefaultLegacyRetryStrategy

public static class DefaultLegacyRetryStrategy.Builder
extends BaseRetryStrategy.Builder
implements LegacyRetryStrategy.Builder

Method Summary

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

maxAttempts

public DefaultLegacyRetryStrategy.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<LegacyRetryStrategy.Builder,LegacyRetryStrategy>

backoffStrategy

public DefaultLegacyRetryStrategy.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<LegacyRetryStrategy.Builder,LegacyRetryStrategy>

throttlingBackoffStrategy

public DefaultLegacyRetryStrategy.Builder throttlingBackoffStrategy(BackoffStrategy throttlingBackoffStrategy)

Description copied from interface: LegacyRetryStrategy.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<LegacyRetryStrategy.Builder,LegacyRetryStrategy>

Specified by:

throttlingBackoffStrategy in interface LegacyRetryStrategy.Builder

circuitBreakerEnabled

public DefaultLegacyRetryStrategy.Builder circuitBreakerEnabled(Boolean circuitBreakerEnabled)

Description copied from interface: LegacyRetryStrategy.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 LegacyRetryStrategy.Builder

treatAsThrottling

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

Description copied from interface: LegacyRetryStrategy.Builder

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

Specified by:

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

Specified by:

treatAsThrottling in interface LegacyRetryStrategy.Builder

tokenBucketExceptionCost

public DefaultLegacyRetryStrategy.Builder tokenBucketExceptionCost(int exceptionCost)

tokenBucketThrottlingExceptionCost

public DefaultLegacyRetryStrategy.Builder tokenBucketThrottlingExceptionCost(int throttlingExceptionCost)

tokenBucketStore

public DefaultLegacyRetryStrategy.Builder tokenBucketStore(TokenBucketStore tokenBucketStore)

useClientDefaults

public DefaultLegacyRetryStrategy.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<LegacyRetryStrategy.Builder,LegacyRetryStrategy>

build

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

Specified by:

build in interface LegacyRetryStrategy.Builder

Specified by:

build in interface Buildable

Specified by:

build in interface SdkBuilder<LegacyRetryStrategy.Builder,LegacyRetryStrategy>

Returns:

an instance of T