Enum Class ClientConfiguration.RetryOnTimeout

java.lang.Object

java.lang.Enum<ClientConfiguration.RetryOnTimeout>

com.palantir.conjure.java.client.config.ClientConfiguration.RetryOnTimeout

All Implemented Interfaces:

Serializable, Comparable<ClientConfiguration.RetryOnTimeout>, Constable

Enclosing interface:

ClientConfiguration

public static enum ClientConfiguration.RetryOnTimeout
extends Enum<ClientConfiguration.RetryOnTimeout>

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DANGEROUS_ENABLE_AT_RISK_OF_RETRY_STORMS	Enables retry on read/write timeout.
DISABLED	Default.

Method Summary

Modifier and Type	Method	Description
static ClientConfiguration.RetryOnTimeout	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ClientConfiguration.RetryOnTimeout[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

DISABLED

public static final ClientConfiguration.RetryOnTimeout DISABLED

Default.

DANGEROUS_ENABLE_AT_RISK_OF_RETRY_STORMS

public static final ClientConfiguration.RetryOnTimeout DANGEROUS_ENABLE_AT_RISK_OF_RETRY_STORMS

Enables retry on read/write timeout. This was the default behavior in versions up to and including 4.24.x. Consumers should almost never use this option, reserving it for when their clients have guaranteed that they will never retry on timeout.

The risk of retry storms is severe. If the client times out before the consumer finishes retrying on its timeout, it will submit a new request which will also retry on timeout. Expensive requests that time out have brought down servers with this behavior enabled.

Note that connect timeouts will always be retried.

Method Details

values

public static ClientConfiguration.RetryOnTimeout[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static ClientConfiguration.RetryOnTimeout valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null