com.dnanexus

Enum DXHTTPRequest.RetryStrategy

java.lang.Object

java.lang.Enum<DXHTTPRequest.RetryStrategy>

com.dnanexus.DXHTTPRequest.RetryStrategy

All Implemented Interfaces:

Serializable, Comparable<DXHTTPRequest.RetryStrategy>

Enclosing class:

DXHTTPRequest

public static enum DXHTTPRequest.RetryStrategy
extends Enum<DXHTTPRequest.RetryStrategy>

Indicates whether a particular API request can be retried.

See the API wrappers common documentation for the retry logic specification.

Enum Constant Summary

Enum Constants

Enum Constant and Description
SAFE_TO_RETRY The request is idempotent and is safe to retry.
UNSAFE_TO_RETRY The request has non-idempotent side effects and is generally not safe to retry if the outcome of a previous request is unknown.

Method Summary

Modifier and Type	Method and Description
static DXHTTPRequest.RetryStrategy	valueOf(String name) Returns the enum constant of this type with the specified name.
static DXHTTPRequest.RetryStrategy[]	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

UNSAFE_TO_RETRY

public static final DXHTTPRequest.RetryStrategy UNSAFE_TO_RETRY

The request has non-idempotent side effects and is generally not safe to retry if the outcome of a previous request is unknown.

SAFE_TO_RETRY

public static final DXHTTPRequest.RetryStrategy SAFE_TO_RETRY

The request is idempotent and is safe to retry.

Method Detail

values

public static DXHTTPRequest.RetryStrategy[] 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 (DXHTTPRequest.RetryStrategy c : DXHTTPRequest.RetryStrategy.values())
    System.out.println(c);

Returns:

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

valueOf

public static DXHTTPRequest.RetryStrategy 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