com.ibm.cos.v2.retries

Interface LegacyRetryStrategy.Builder

All Superinterfaces:

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

All Known Implementing Classes:

DefaultLegacyRetryStrategy.Builder

Enclosing interface:

LegacyRetryStrategy

public static interface LegacyRetryStrategy.Builder
extends RetryStrategy.Builder<LegacyRetryStrategy.Builder,LegacyRetryStrategy>

Method Summary

Modifier and Type	Method and Description
LegacyRetryStrategy	build() Build a new RetryStrategy with the current configuration on this builder.
LegacyRetryStrategy.Builder	circuitBreakerEnabled(Boolean circuitBreakerEnabled) Whether circuit breaking is enabled for this strategy.
LegacyRetryStrategy.Builder	throttlingBackoffStrategy(BackoffStrategy throttlingBackoffStrategy) Configure the backoff strategy used for throttling exceptions by this strategy.
LegacyRetryStrategy.Builder	treatAsThrottling(Predicate<Throwable> treatAsThrottling) Configure the predicate to allow the strategy categorize a Throwable as throttling exception.

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

backoffStrategy, maxAttempts, retryOnException, retryOnException, retryOnExceptionInstanceOf, retryOnExceptionOrCause, retryOnExceptionOrCauseInstanceOf, retryOnRootCause, retryOnRootCauseInstanceOf, useClientDefaults

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

applyMutation

Method Detail

throttlingBackoffStrategy

LegacyRetryStrategy.Builder throttlingBackoffStrategy(BackoffStrategy throttlingBackoffStrategy)

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>

circuitBreakerEnabled

LegacyRetryStrategy.Builder circuitBreakerEnabled(Boolean circuitBreakerEnabled)

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.

treatAsThrottling

LegacyRetryStrategy.Builder treatAsThrottling(Predicate<Throwable> treatAsThrottling)

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

Specified by:

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

build

LegacyRetryStrategy build()

Description copied from interface: RetryStrategy.Builder

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

Specified by:

build in interface Buildable

Specified by:

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

Specified by:

build in interface SdkBuilder<LegacyRetryStrategy.Builder,LegacyRetryStrategy>

Returns:

an instance of T