com.ibm.cos.v2.core.internal.retry

Class RetryPolicyAdapter.Builder

java.lang.Object

com.ibm.cos.v2.core.internal.retry.RetryPolicyAdapter.Builder

All Implemented Interfaces:

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

Enclosing class:

RetryPolicyAdapter

public static class RetryPolicyAdapter.Builder
extends Object
implements RetryStrategy.Builder<RetryPolicyAdapter.Builder,RetryPolicyAdapter>

Method Summary

Modifier and Type	Method and Description
RetryPolicyAdapter.Builder	backoffStrategy(BackoffStrategy backoffStrategy) Configure the backoff strategy used by the retry strategy.
RetryPolicyAdapter	build() Build a new RetryStrategy with the current configuration on this builder.
RetryPolicyAdapter.Builder	initialize(RetryPolicyContext retryPolicyContext)
RetryPolicyAdapter.Builder	maxAttempts(int maxAttempts) Configure the maximum number of attempts used by the retry strategy.
RetryPolicyAdapter.Builder	retryOnException(Predicate<Throwable> shouldRetry) Configure the strategy to retry when the provided predicate returns true, given a failure exception.
RetryPolicyAdapter.Builder	retryPolicy(RetryPolicy retryPolicy)
RetryPolicyAdapter.Builder	retryPolicyContext(RetryPolicyContext retryPolicyContext)
RetryPolicyAdapter.Builder	throttlingBackoffStrategy(BackoffStrategy backoffStrategy) Configure the backoff strategy used for throttling exceptions by this strategy.
RetryPolicyAdapter.Builder	treatAsThrottling(Predicate<Throwable> treatAsThrottling) Configure a predicate that determines whether a retryable exception is a throttling exception.

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, useClientDefaults

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

applyMutation

Method Detail

retryOnException

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

maxAttempts

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

backoffStrategy

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

throttlingBackoffStrategy

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

treatAsThrottling

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

retryPolicy

public RetryPolicyAdapter.Builder retryPolicy(RetryPolicy retryPolicy)

retryPolicyContext

public RetryPolicyAdapter.Builder retryPolicyContext(RetryPolicyContext retryPolicyContext)

initialize

public RetryPolicyAdapter.Builder initialize(RetryPolicyContext retryPolicyContext)

build

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

Specified by:

build in interface Buildable

Specified by:

build in interface SdkBuilder<RetryPolicyAdapter.Builder,RetryPolicyAdapter>

Returns:

an instance of T