com.ibm.cos.v2.retries

Interface StandardRetryStrategy.Builder

All Superinterfaces:

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

All Known Implementing Classes:

DefaultStandardRetryStrategy.Builder

Enclosing interface:

StandardRetryStrategy

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

Method Summary

Modifier and Type	Method and Description
StandardRetryStrategy	build() Build a new RetryStrategy with the current configuration on this builder.
StandardRetryStrategy.Builder	circuitBreakerEnabled(Boolean circuitBreakerEnabled) Whether circuit breaking is enabled for this strategy.

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

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

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

applyMutation

Method Detail

circuitBreakerEnabled

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

build

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

Specified by:

build in interface SdkBuilder<StandardRetryStrategy.Builder,StandardRetryStrategy>

Returns:

an instance of T