Class RetrySettings.Builder (2.19.0)

Version 2.19.0

• 2.58.0 (latest)
• 2.57.0
• 2.55.0
• 2.54.1
• 2.53.0
• 2.52.0
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.1
• 2.47.0
• 2.46.1
• 2.45.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.1
• 2.33.0
• 2.32.1
• 2.31.1
• 2.30.1
• 2.24.0
• 2.23.3
• 2.22.0
• 2.21.0
• 2.20.1
• 2.19.6
• 2.18.7
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.2
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.1
• 2.7.1

public abstract static class RetrySettings.Builder

A base builder class for RetrySettings. See the class documentation of RetrySettings for a description of the different values that can be set.

Inheritance

java.lang.Object > RetrySettings.Builder

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)

Constructors

Builder()

public Builder()

Methods

build()

public RetrySettings build()

Returns

Type	Description
RetrySettings

getInitialRetryDelay()

public abstract Duration getInitialRetryDelay()

InitialRetryDelay controls the delay before the first retry. Subsequent retries will use this value adjusted according to the RetryDelayMultiplier. The default value is Duration.ZERO.

Returns

Type	Description
org.threeten.bp.Duration

getInitialRpcTimeout()

public abstract Duration getInitialRpcTimeout()

InitialRpcTimeout controls the timeout for the initial RPC. Subsequent calls will use this value adjusted according to the RpcTimeoutMultiplier. The default value is Duration.ZERO.

Returns

Type	Description
org.threeten.bp.Duration

getMaxAttempts()

public abstract int getMaxAttempts()

MaxAttempts defines the maximum number of attempts to perform. The default value is 0. If this value is greater than 0, and the number of attempts reaches this limit, the logic will give up retrying even if the total retry time is still lower than TotalTimeout.

Returns

Type	Description
int

getMaxRetryDelay()

public abstract Duration getMaxRetryDelay()

MaxRetryDelay puts a limit on the value of the retry delay, so that the RetryDelayMultiplier can't increase the retry delay higher than this amount. The default value is Duration.ZERO.

Returns

Type	Description
org.threeten.bp.Duration

getMaxRpcTimeout()

public abstract Duration getMaxRpcTimeout()

MaxRpcTimeout puts a limit on the value of the RPC timeout, so that the RpcTimeoutMultiplier can't increase the RPC timeout higher than this amount.

Returns

Type	Description
org.threeten.bp.Duration

getRetryDelayMultiplier()

public abstract double getRetryDelayMultiplier()

RetryDelayMultiplier controls the change in retry delay. The retry delay of the previous call is multiplied by the RetryDelayMultiplier to calculate the retry delay for the next call. The default value is 1.0.

Returns

Type	Description
double

getRpcTimeoutMultiplier()

public abstract double getRpcTimeoutMultiplier()

See the class documentation of RetrySettings for a description of what this value does. The default value is 1.0.

Returns

Type	Description
double

getTotalTimeout()

public abstract Duration getTotalTimeout()

TotalTimeout has ultimate control over how long the logic should keep trying the remote call until it gives up completely. The higher the total timeout, the more retries can be attempted. The default value is Duration.ZERO.

Returns

Type	Description
org.threeten.bp.Duration

isJittered()

public abstract boolean isJittered()

Jitter determines if the delay time should be randomized. In most cases, if jitter is set to true the actual delay time is calculated in the following way:

actualDelay = rand_between(0, min(maxRetryDelay, exponentialDelay))

The default value is true.

Returns

Type	Description
boolean

merge(RetrySettings.Builder newSettings)

public RetrySettings.Builder merge(RetrySettings.Builder newSettings)

Parameter

Name	Description
newSettings	RetrySettings.Builder

Returns

Type	Description
RetrySettings.Builder

setInitialRetryDelay(Duration initialDelay)

public abstract RetrySettings.Builder setInitialRetryDelay(Duration initialDelay)

InitialRetryDelay controls the delay before the first retry. Subsequent retries will use this value adjusted according to the RetryDelayMultiplier. The default value is Duration.ZERO.

Parameter

Name	Description
initialDelay	org.threeten.bp.Duration

Returns

Type	Description
RetrySettings.Builder

setInitialRpcTimeout(Duration initialTimeout)

public abstract RetrySettings.Builder setInitialRpcTimeout(Duration initialTimeout)

InitialRpcTimeout controls the timeout for the initial RPC. Subsequent calls will use this value adjusted according to the RpcTimeoutMultiplier. The default value is Duration.ZERO.

Parameter

Name	Description
initialTimeout	org.threeten.bp.Duration

Returns

Type	Description
RetrySettings.Builder

setJittered(boolean jittered) (deprecated)

public abstract RetrySettings.Builder setJittered(boolean jittered)

Deprecated. Retries always jitter.

Jitter determines if the delay time should be randomized. If jitter is set to true the actual delay time is calculated in the following way:

actualDelay = rand_between(0, min(maxRetryDelay, exponentialDelay))

The default value is true, and this method will be a no-op soon.

Parameter

Name	Description
jittered	boolean

Returns

Type	Description
RetrySettings.Builder

setLogicalTimeout(Duration timeout)

public RetrySettings.Builder setLogicalTimeout(Duration timeout)

Configures the timeout settings with the given timeout such that the logical call will take no longer than the given timeout and each RPC attempt will use only the time remaining in the logical call as a timeout.

Using this method in conjunction with individual RetrySettings timeout field setters is not advised, because only the order in which they are invoked determines which setter is respected.

Parameter

Name	Description
timeout	org.threeten.bp.Duration

Returns

Type	Description
RetrySettings.Builder

setMaxAttempts(int maxAttempts)

public abstract RetrySettings.Builder setMaxAttempts(int maxAttempts)

MaxAttempts defines the maximum number of attempts to perform. The default value is 0. If this value is greater than 0, and the number of attempts reaches this limit, the logic will give up retrying even if the total retry time is still lower than TotalTimeout.

Parameter

Name	Description
maxAttempts	int

Returns

Type	Description
RetrySettings.Builder

setMaxRetryDelay(Duration maxDelay)

public abstract RetrySettings.Builder setMaxRetryDelay(Duration maxDelay)

MaxRetryDelay puts a limit on the value of the retry delay, so that the RetryDelayMultiplier can't increase the retry delay higher than this amount. The default value is Duration.ZERO.

Parameter

Name	Description
maxDelay	org.threeten.bp.Duration

Returns

Type	Description
RetrySettings.Builder

setMaxRpcTimeout(Duration maxTimeout)

public abstract RetrySettings.Builder setMaxRpcTimeout(Duration maxTimeout)

MaxRpcTimeout puts a limit on the value of the RPC timeout, so that the RpcTimeoutMultiplier can't increase the RPC timeout higher than this amount. The default value is Duration.ZERO.

Parameter

Name	Description
maxTimeout	org.threeten.bp.Duration

Returns

Type	Description
RetrySettings.Builder

setRetryDelayMultiplier(double multiplier)

public abstract RetrySettings.Builder setRetryDelayMultiplier(double multiplier)

RetryDelayMultiplier controls the change in retry delay. The retry delay of the previous call is multiplied by the RetryDelayMultiplier to calculate the retry delay for the next call. The default value is 1.0.

Parameter

Name	Description
multiplier	double

Returns

Type	Description
RetrySettings.Builder

setRpcTimeoutMultiplier(double multiplier)

public abstract RetrySettings.Builder setRpcTimeoutMultiplier(double multiplier)

See the class documentation of RetrySettings for a description of what this value does. The default value is 1.0.

Parameter

Name	Description
multiplier	double

Returns

Type	Description
RetrySettings.Builder

setTotalTimeout(Duration totalTimeout)

public abstract RetrySettings.Builder setTotalTimeout(Duration totalTimeout)

TotalTimeout has ultimate control over how long the logic should keep trying the remote call until it gives up completely. The higher the total timeout, the more retries can be attempted. The default value is Duration.ZERO.

Parameter

Name	Description
totalTimeout	org.threeten.bp.Duration

Returns

Type	Description
RetrySettings.Builder