com.ibm.cloud.objectstorage.retry

Class PredefinedRetryPolicies

java.lang.Object

com.ibm.cloud.objectstorage.retry.PredefinedRetryPolicies

public class PredefinedRetryPolicies
extends Object

This class includes a set of pre-defined retry policies, including default policies used by SDK.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PredefinedRetryPolicies.SDKDefaultRetryCondition The default implementation of RetryCondition used by the SDK.

Field Summary

Fields

Modifier and Type	Field and Description
static RetryPolicy	DEFAULT SDK default retry policy.
static RetryPolicy.BackoffStrategy	DEFAULT_BACKOFF_STRATEGY The SDK default back-off strategy, which increases exponentially up to a max amount of delay.
static V2CompatibleBackoffStrategy	DEFAULT_BACKOFF_STRATEGY_V2 The SDK default back-off strategy, which increases exponentially up to a max amount of delay.
static int	DEFAULT_MAX_ERROR_RETRY SDK default max retry count for legacy retry mode
static int	DEFAULT_MAX_ERROR_RETRY_STANDARD_MODE SDK default max retry count for standard retry mode
static RetryPolicy.RetryCondition	DEFAULT_RETRY_CONDITION The SDK default retry condition, which checks for various conditions in the following order: Never retry on requests with non-repeatable content; Retry on client exceptions caused by IOException; Retry on service exceptions that are either 500 internal server errors, 503 service unavailable errors, service throttling errors or clock skew errors.
static RetryPolicy	DYNAMODB_DEFAULT Default policy for DynamoDB client
static RetryPolicy.BackoffStrategy	DYNAMODB_DEFAULT_BACKOFF_STRATEGY The default back-off strategy for DynamoDB client, which increases exponentially up to a max amount of delay.
static int	DYNAMODB_DEFAULT_MAX_ERROR_RETRY Standard max retry count for DynamoDB client for DynamoDB client
static RetryPolicy	NO_RETRY_POLICY No retry policy

Constructor Summary

Constructors

Constructor and Description
PredefinedRetryPolicies()

Method Summary

Modifier and Type	Method and Description
static RetryPolicy.BackoffStrategy	getDefaultBackoffStrategy(RetryMode retryMode)
static RetryPolicy	getDefaultRetryPolicy() Returns the SDK default retry policy.
static RetryPolicy	getDefaultRetryPolicyWithCustomMaxRetries(int maxErrorRetry) Returns the SDK default retry policy with the specified max retry count.
static RetryPolicy	getDynamoDBDefaultRetryPolicy() Returns the default retry policy for DynamoDB client.
static RetryPolicy	getDynamoDBDefaultRetryPolicyWithCustomMaxRetries(int maxErrorRetry) Returns the default retry policy for DynamoDB client with the specified max retry count.

Methods inherited from class java.lang.Object

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

Field Detail

NO_RETRY_POLICY

public static final RetryPolicy NO_RETRY_POLICY

No retry policy

DEFAULT_MAX_ERROR_RETRY

public static final int DEFAULT_MAX_ERROR_RETRY

SDK default max retry count for legacy retry mode

See Also:

Constant Field Values

DEFAULT_MAX_ERROR_RETRY_STANDARD_MODE

public static final int DEFAULT_MAX_ERROR_RETRY_STANDARD_MODE

SDK default max retry count for standard retry mode

See Also:

Constant Field Values

DEFAULT

public static final RetryPolicy DEFAULT

SDK default retry policy. Amazon DynamoDB has a custom retry policy that is used when no ClientConfiguration is provided.

DYNAMODB_DEFAULT_MAX_ERROR_RETRY

public static final int DYNAMODB_DEFAULT_MAX_ERROR_RETRY

Standard max retry count for DynamoDB client for DynamoDB client

See Also:

Constant Field Values

DYNAMODB_DEFAULT

public static final RetryPolicy DYNAMODB_DEFAULT

Default policy for DynamoDB client

DEFAULT_RETRY_CONDITION

public static final RetryPolicy.RetryCondition DEFAULT_RETRY_CONDITION

The SDK default retry condition, which checks for various conditions in the following order:

• Never retry on requests with non-repeatable content;
• Retry on client exceptions caused by IOException;
• Retry on service exceptions that are either 500 internal server errors, 503 service unavailable errors, service throttling errors or clock skew errors.

DEFAULT_BACKOFF_STRATEGY

public static final RetryPolicy.BackoffStrategy DEFAULT_BACKOFF_STRATEGY

The SDK default back-off strategy, which increases exponentially up to a max amount of delay. It also applies a larger scale factor upon service throttling exception.

DEFAULT_BACKOFF_STRATEGY_V2

public static final V2CompatibleBackoffStrategy DEFAULT_BACKOFF_STRATEGY_V2

The SDK default back-off strategy, which increases exponentially up to a max amount of delay. It also applies a larger scale factor upon service throttling exception.

DYNAMODB_DEFAULT_BACKOFF_STRATEGY

public static final RetryPolicy.BackoffStrategy DYNAMODB_DEFAULT_BACKOFF_STRATEGY

The default back-off strategy for DynamoDB client, which increases exponentially up to a max amount of delay. Compared to the SDK default back-off strategy, it applies a smaller scale factor.

Constructor Detail

PredefinedRetryPolicies

public PredefinedRetryPolicies()

Method Detail

getDefaultBackoffStrategy

public static RetryPolicy.BackoffStrategy getDefaultBackoffStrategy(RetryMode retryMode)

getDefaultRetryPolicy

public static RetryPolicy getDefaultRetryPolicy()

Returns the SDK default retry policy. This policy will honor the maxErrorRetry set in ClientConfiguration.

See Also:

ClientConfiguration.setMaxErrorRetry(int)

getDynamoDBDefaultRetryPolicy

public static RetryPolicy getDynamoDBDefaultRetryPolicy()

Returns the default retry policy for DynamoDB client. This policy will honor the maxErrorRetry set in ClientConfiguration. For DynamoDB the Default max error retry attempts is kept same as Standard Max retry of Dynamo DB. Thus honorDefaultMaxErrorRetryInRetryMode is set to False so that it uses max error retries same as DYNAMODB_STANDARD_DEFAULT_MAX_ERROR_RETRY which is 10.

See Also:

ClientConfiguration.setMaxErrorRetry(int)

getDefaultRetryPolicyWithCustomMaxRetries

public static RetryPolicy getDefaultRetryPolicyWithCustomMaxRetries(int maxErrorRetry)

Returns the SDK default retry policy with the specified max retry count.

getDynamoDBDefaultRetryPolicyWithCustomMaxRetries

public static RetryPolicy getDynamoDBDefaultRetryPolicyWithCustomMaxRetries(int maxErrorRetry)

Returns the default retry policy for DynamoDB client with the specified max retry count.