Class RetryOption (2.49.0)

Version latest

• 2.49.0 (latest)
• 2.48.0
• 2.47.0
• 2.45.0
• 2.44.1
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.39.0
• 2.38.1
• 2.37.0
• 2.36.1
• 2.35.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.0
• 2.24.1
• 2.23.0
• 2.22.1
• 2.21.1
• 2.20.1
• 2.13.0
• 2.12.0
• 2.11.0
• 2.9.4
• 2.8.27
• 2.7.1
• 2.6.1
• 2.5.11
• 2.4.0
• 2.3.5

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

public class RetryOption implements Serializable

This class represents an options wrapper around the RetrySettings class and is an alternative way of initializing it. The retry options are usually provided in a form of varargs for methods that wait for changes in the status of a resource, do poll operations or retry on failures.

Inheritance

Object > RetryOption

Implements

Serializable

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

initialRetryDelay(Duration initialRetryDelay)

public static RetryOption initialRetryDelay(Duration initialRetryDelay)

Obsolete

Use initialRetryDelayDuration() instead

This feature is stable for usage in this major version, but may be deprecated in a future release.

This method is obsolete. Use #initialRetryDelayDuration(java.time.Duration) instead

Parameter
Name	Description
initialRetryDelay	org.threeten.bp.Duration

Returns
Type	Description
RetryOption

initialRetryDelayDuration(Duration initialRetryDelay)

public static RetryOption initialRetryDelayDuration(Duration initialRetryDelay)

See RetrySettings#getInitialRetryDelayDuration().

Parameter
Name	Description
initialRetryDelay	Duration

Returns
Type	Description
RetryOption

jittered(boolean jittered)

public static RetryOption jittered(boolean jittered)

See RetrySettings#isJittered() ()}.

Parameter
Name	Description
jittered	boolean

Returns
Type	Description
RetryOption

maxAttempts(int maxAttempts)

public static RetryOption maxAttempts(int maxAttempts)

See RetrySettings#getMaxAttempts().

Parameter
Name	Description
maxAttempts	int

Returns
Type	Description
RetryOption

maxRetryDelay(Duration maxRetryDelay)

public static RetryOption maxRetryDelay(Duration maxRetryDelay)

Obsolete

Use maxRetryDelayDuration() instead

This feature is stable for usage in this major version, but may be deprecated in a future release.

This method is obsolete. Use #maxRetryDelayDuration(java.time.Duration) instead

Parameter
Name	Description
maxRetryDelay	org.threeten.bp.Duration

Returns
Type	Description
RetryOption

maxRetryDelayDuration(Duration maxRetryDelay)

public static RetryOption maxRetryDelayDuration(Duration maxRetryDelay)

See RetrySettings#getMaxRetryDelayDuration().

Parameter
Name	Description
maxRetryDelay	Duration

Returns
Type	Description
RetryOption

mergeToSettings(RetrySettings settings, RetryOption[] options)

public static RetrySettings mergeToSettings(RetrySettings settings, RetryOption[] options)

Creates a new RetrySettings instance, merging provided settings and multiple RetryOptions, each of which represents a single property in RetrySettings. It is an alternative way of initializing RetrySettings instances.

Parameters
Name	Description
settings	RetrySettings retry settings
options	RetryOption[] zero or more Retry

Returns
Type	Description
RetrySettings	new RetrySettings instance, which is a result of merging options into settings, i.e. each element in options, if present, overrides corresponding property in settings

retryDelayMultiplier(double retryDelayMultiplier)

public static RetryOption retryDelayMultiplier(double retryDelayMultiplier)

See RetrySettings#getRetryDelayMultiplier().

Parameter
Name	Description
retryDelayMultiplier	double

Returns
Type	Description
RetryOption

totalTimeout(Duration totalTimeout)

public static RetryOption totalTimeout(Duration totalTimeout)

Obsolete

Use totalTimeouDuration() instead

This feature is stable for usage in this major version, but may be deprecated in a future release.

This method is obsolete. Use #totalTimeoutDuration(java.time.Duration) instead

Parameter
Name	Description
totalTimeout	org.threeten.bp.Duration

Returns
Type	Description
RetryOption

totalTimeoutDuration(Duration totalTimeout)

public static RetryOption totalTimeoutDuration(Duration totalTimeout)

See RetrySettings#getTotalTimeoutDuration().

Parameter
Name	Description
totalTimeout	Duration

Returns
Type	Description
RetryOption

Methods

equals(Object o)

public boolean equals(Object o)

Parameter
Name	Description
o	Object

Returns
Type	Description
boolean

Overrides

Object.equals(Object)

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

Object.hashCode()