RetrySettings.Builder (gax 1.62.0 API)

java.lang.Object
- com.google.api.gax.retrying.RetrySettings.Builder

Enclosing class:

RetrySettings
```
public abstract static class RetrySettings.Builder
extends Object
```
A base builder class for RetrySettings. See the class documentation of RetrySettings for a description of the different values that can be set.

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`RetrySettings`	`build()`
`abstract org.threeten.bp.Duration`	`getInitialRetryDelay()` InitialRetryDelay controls the delay before the first retry.
`abstract org.threeten.bp.Duration`	`getInitialRpcTimeout()` InitialRpcTimeout controls the timeout for the initial RPC.
`abstract int`	`getMaxAttempts()` MaxAttempts defines the maximum number of attempts to perform.
`abstract org.threeten.bp.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.
`abstract org.threeten.bp.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.
`abstract double`	`getRetryDelayMultiplier()` RetryDelayMultiplier controls the change in retry delay.
`abstract double`	`getRpcTimeoutMultiplier()` See the class documentation of `RetrySettings` for a description of what this value does.
`abstract org.threeten.bp.Duration`	`getTotalTimeout()` TotalTimeout has ultimate control over how long the logic should keep trying the remote call until it gives up completely.
`abstract boolean`	`isJittered()` Jitter determines if the delay time should be randomized.
`RetrySettings.Builder`	`merge(RetrySettings.Builder newSettings)`
`abstract RetrySettings.Builder`	`setInitialRetryDelay(org.threeten.bp.Duration initialDelay)` InitialRetryDelay controls the delay before the first retry.
`abstract RetrySettings.Builder`	`setInitialRpcTimeout(org.threeten.bp.Duration initialTimeout)` InitialRpcTimeout controls the timeout for the initial RPC.
`abstract RetrySettings.Builder`	`setJittered(boolean jittered)` Deprecated. Retries always jitter.
`abstract RetrySettings.Builder`	`setMaxAttempts(int maxAttempts)` MaxAttempts defines the maximum number of attempts to perform.
`abstract RetrySettings.Builder`	`setMaxRetryDelay(org.threeten.bp.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.
`abstract RetrySettings.Builder`	`setMaxRpcTimeout(org.threeten.bp.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.
`abstract RetrySettings.Builder`	`setRetryDelayMultiplier(double multiplier)` RetryDelayMultiplier controls the change in retry delay.
`abstract RetrySettings.Builder`	`setRpcTimeoutMultiplier(double multiplier)` See the class documentation of `RetrySettings` for a description of what this value does.
`abstract RetrySettings.Builder`	`setTotalTimeout(org.threeten.bp.Duration totalTimeout)` TotalTimeout has ultimate control over how long the logic should keep trying the remote call until it gives up completely.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - setTotalTimeout
```
public abstract RetrySettings.Builder setTotalTimeout(org.threeten.bp.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.
  - setInitialRetryDelay
```
public abstract RetrySettings.Builder setInitialRetryDelay(org.threeten.bp.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.
  - setRetryDelayMultiplier
```
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.
  - setMaxRetryDelay
```
public abstract RetrySettings.Builder setMaxRetryDelay(org.threeten.bp.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.
  - setMaxAttempts
```
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.
  - setJittered
```
@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.
  - setInitialRpcTimeout
```
public abstract RetrySettings.Builder setInitialRpcTimeout(org.threeten.bp.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.
  - setRpcTimeoutMultiplier
```
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.
  - setMaxRpcTimeout
```
public abstract RetrySettings.Builder setMaxRpcTimeout(org.threeten.bp.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.
  - getTotalTimeout
```
public abstract org.threeten.bp.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.
  - getInitialRetryDelay
```
public abstract org.threeten.bp.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.
  - 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.
  - 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.
  - 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.
  - getMaxRetryDelay
```
public abstract org.threeten.bp.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.
  - getInitialRpcTimeout
```
public abstract org.threeten.bp.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.
  - 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.
  - getMaxRpcTimeout
```
public abstract org.threeten.bp.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.
  - build
```
public RetrySettings build()
```
  - merge
```
public RetrySettings.Builder merge(RetrySettings.Builder newSettings)
```

Class RetrySettings.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

setTotalTimeout

setInitialRetryDelay

setRetryDelayMultiplier

setMaxRetryDelay

setMaxAttempts

setJittered

setInitialRpcTimeout

setRpcTimeoutMultiplier

setMaxRpcTimeout

getTotalTimeout

getInitialRetryDelay

getRetryDelayMultiplier

getMaxAttempts

isJittered

getMaxRetryDelay

getInitialRpcTimeout

getRpcTimeoutMultiplier

getMaxRpcTimeout

build

merge