com.ibm.cloud.objectstorage.retry

Enum RetryMode

java.lang.Object

java.lang.Enum<RetryMode>

com.ibm.cloud.objectstorage.retry.RetryMode

All Implemented Interfaces:

Serializable, Comparable<RetryMode>

public enum RetryMode
extends Enum<RetryMode>

The retry mode

Enum Constant Summary

Enum Constants

Enum Constant and Description
ADAPTIVE Adaptive retry mode dynamically limits the rate of AWS requests to maximize success rate.
LEGACY The legacy mode that only enables throttled retry for transient errors
STANDARD Standard mode is built on top of legacy mode and has throttled retry enabled for throttling errors apart from transient errors.

Method Summary

Modifier and Type	Method and Description
static RetryMode	fromName(String value) Returns a retry mode enum corresponding to the given retryMode name.
String	getName()
static RetryMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static RetryMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

LEGACY

public static final RetryMode LEGACY

The legacy mode that only enables throttled retry for transient errors

STANDARD

public static final RetryMode STANDARD

Standard mode is built on top of legacy mode and has throttled retry enabled for throttling errors apart from transient errors. In addition, timeout(socket timeout or connection timeout) errors would cost more retry capacity compared with RetryMode.LEGACY.

ADAPTIVE

public static final RetryMode ADAPTIVE

Adaptive retry mode dynamically limits the rate of AWS requests to maximize success rate. This may be at the expense of request latency. Adaptive retry mode is not recommended when predictable latency is important.

Warning: Adaptive retry mode assumes that the client is working against a single resource (e.g. one DynamoDB Table or one S3 Bucket). If you use a single client for multiple resources, throttling or outages associated with one resource will result in increased latency and failures when accessing all other resources via the same client. When using adaptive retry mode, we recommend using a single client per resource.

See Also:

RetryPolicy.isFastFailRateLimiting()

Method Detail

values

public static RetryMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (RetryMode c : RetryMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static RetryMode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getName

public String getName()

fromName

public static RetryMode fromName(String value)

Returns a retry mode enum corresponding to the given retryMode name.

Parameters:

value - The name of the retry mode

Returns:

RetryMode enum representing the given retry mode name.