com.ibm.cloud.objectstorage.retry

Class RetryPolicy

java.lang.Object

com.ibm.cloud.objectstorage.retry.RetryPolicy

@Immutable
public final class RetryPolicy
extends Object

Retry policy that can be configured on a specific service client using ClientConfiguration. This class is immutable, therefore safe to be shared by multiple clients.

See Also:

ClientConfiguration, PredefinedRetryPolicies

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RetryPolicy.BackoffStrategy The hook for providing custom back-off strategy to control the sleep time between retries.
static interface	RetryPolicy.RetryCondition The hook for providing custom condition on whether a failed request should be retried.
static class	RetryPolicy.RetryPolicyBuilder

Constructor Summary

Constructors

Constructor and Description
RetryPolicy(RetryPolicy.RetryCondition retryCondition, RetryPolicy.BackoffStrategy backoffStrategy, int maxErrorRetry, boolean honorMaxErrorRetryInClientConfig) Constructs a new retry policy.
RetryPolicy(RetryPolicy.RetryCondition retryCondition, RetryPolicy.BackoffStrategy backoffStrategy, int maxErrorRetry, boolean honorMaxErrorRetryInClientConfig, boolean honorDefaultMaxErrorRetryInRetryMode, boolean honorBackoffStrategyInRetryMode)
RetryPolicy(RetryPolicy.RetryCondition retryCondition, RetryPolicy.BackoffStrategy backoffStrategy, int maxErrorRetry, boolean honorMaxErrorRetryInClientConfig, RetryMode retryMode)

Method Summary

Modifier and Type	Method and Description
static RetryPolicy.RetryPolicyBuilder	builder()
RetryPolicy.BackoffStrategy	getBackoffStrategy() Returns the back-off strategy included in this retry policy.
int	getMaxErrorRetry() Returns the maximum number of retry attempts.
RetryPolicy.RetryCondition	getRetryCondition() Returns the retry condition included in this retry policy.
RetryMode	getRetryMode() Returns the RetryMode to be used.
boolean	isFastFailRateLimiting() Whether the client should fail immediately when RetryMode.ADAPTIVE is enabled, and there is not enough capacity in the rate limiter to execute the request immediately.
boolean	isMaxErrorRetryInClientConfigHonored() Returns whether this retry policy should honor the max error retry set in ClientConfiguration.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RetryPolicy

public RetryPolicy(RetryPolicy.RetryCondition retryCondition,
                   RetryPolicy.BackoffStrategy backoffStrategy,
                   int maxErrorRetry,
                   boolean honorMaxErrorRetryInClientConfig)

Constructs a new retry policy. See PredefinedRetryPolicies for some pre-defined policy components, and also the default policies used by SDK.

Parameters:

retryCondition - Retry condition on whether a specific request and exception should be retried. If null value is specified, the SDK' default retry condition is used.

backoffStrategy - Back-off strategy for controlling how long the next retry should wait. If null value is specified, the SDK' default exponential back-off strategy is used.

maxErrorRetry - Maximum number of retry attempts for failed requests.

honorMaxErrorRetryInClientConfig - Whether this retry policy should honor the max error retry set by ClientConfiguration.setMaxErrorRetry(int)

See Also:

ClientConfiguration, PredefinedRetryPolicies

RetryPolicy

public RetryPolicy(RetryPolicy.RetryCondition retryCondition,
                   RetryPolicy.BackoffStrategy backoffStrategy,
                   int maxErrorRetry,
                   boolean honorMaxErrorRetryInClientConfig,
                   boolean honorDefaultMaxErrorRetryInRetryMode,
                   boolean honorBackoffStrategyInRetryMode)

RetryPolicy

public RetryPolicy(RetryPolicy.RetryCondition retryCondition,
                   RetryPolicy.BackoffStrategy backoffStrategy,
                   int maxErrorRetry,
                   boolean honorMaxErrorRetryInClientConfig,
                   RetryMode retryMode)

Method Detail

getRetryCondition

public RetryPolicy.RetryCondition getRetryCondition()

Returns the retry condition included in this retry policy.

Returns:

The retry condition included in this retry policy.

getBackoffStrategy

public RetryPolicy.BackoffStrategy getBackoffStrategy()

Returns the back-off strategy included in this retry policy.

Returns:

The back-off strategy included in this retry policy.

getMaxErrorRetry

public int getMaxErrorRetry()

Returns the maximum number of retry attempts.

Returns:

The maximum number of retry attempts.

isMaxErrorRetryInClientConfigHonored

public boolean isMaxErrorRetryInClientConfigHonored()

Returns whether this retry policy should honor the max error retry set in ClientConfiguration.

Returns:

Whether this retry policy should honor the max error retry set in ClientConfiguration

See Also:

ClientConfiguration.setMaxErrorRetry(int)

getRetryMode

public RetryMode getRetryMode()

Returns the RetryMode to be used.

Returns:

retryMode

isFastFailRateLimiting

public boolean isFastFailRateLimiting()

Whether the client should fail immediately when RetryMode.ADAPTIVE is enabled, and there is not enough capacity in the rate limiter to execute the request immediately.

The default configuration value is false, which will cause client to wait until enough capacity is available.

Returns:

The fast fail configuration value.

builder

public static RetryPolicy.RetryPolicyBuilder builder()

Returns:

A builder for conveniently building a retry policy.