RetrySettings.Builder (gax 1.5.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
Modifier and Type	Method and Description
`RetrySettings`	`build()`
`abstract org.threeten.bp.Duration`	`getInitialRetryDelay()` The InitialRetryDelay parameter controls the delay before the first retry.
`abstract org.threeten.bp.Duration`	`getInitialRpcTimeout()` The InitialRpcTimeout parameter 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()` The 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()` The 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()` The 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()` The TotalTimeout parameter has ultimate control over how long the logic should keep trying the remote call until it gives up completely.
`RetrySettings.Builder`	`merge(RetrySettings.Builder newSettings)`
`abstract RetrySettings.Builder`	`setInitialRetryDelay(org.threeten.bp.Duration initialDelay)` The InitialRetryDelay parameter controls the delay before the first retry.
`abstract RetrySettings.Builder`	`setInitialRpcTimeout(org.threeten.bp.Duration initialTimeout)` The InitialRpcTimeout parameter controls the timeout for the initial RPC.
`abstract RetrySettings.Builder`	`setMaxAttempts(int maxAttempts)` MaxAttempts defines the maximum number of attempts to perform.
`abstract RetrySettings.Builder`	`setMaxRetryDelay(org.threeten.bp.Duration maxDelay)` The 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)` The 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)` The 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)` The TotalTimeout parameter 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)
```
    The TotalTimeout parameter 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.
  - setInitialRetryDelay
```
public abstract RetrySettings.Builder setInitialRetryDelay(org.threeten.bp.Duration initialDelay)
```
    The InitialRetryDelay parameter controls the delay before the first retry. Subsequent retries will use this value adjusted according to the RetryDelayMultiplier.
  - setRetryDelayMultiplier
```
public abstract RetrySettings.Builder setRetryDelayMultiplier(double multiplier)
```
    The 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.
  - setMaxRetryDelay
```
public abstract RetrySettings.Builder setMaxRetryDelay(org.threeten.bp.Duration maxDelay)
```
    The 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.
  - setMaxAttempts
```
public abstract RetrySettings.Builder setMaxAttempts(int maxAttempts)
```
    MaxAttempts defines the maximum number of attempts to perform. If number of attempts reaches this limit the logic will give up retrying even if the total retry time is still lower than TotalTimeout.
  - setInitialRpcTimeout
```
public abstract RetrySettings.Builder setInitialRpcTimeout(org.threeten.bp.Duration initialTimeout)
```
    The InitialRpcTimeout parameter controls the timeout for the initial RPC. Subsequent calls will use this value adjusted according to the RpcTimeoutMultiplier.
  - setRpcTimeoutMultiplier
```
public abstract RetrySettings.Builder setRpcTimeoutMultiplier(double multiplier)
```
    See the class documentation of RetrySettings for a description of what this value does.
  - setMaxRpcTimeout
```
public abstract RetrySettings.Builder setMaxRpcTimeout(org.threeten.bp.Duration maxTimeout)
```
    The 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.
  - getTotalTimeout
```
public abstract org.threeten.bp.Duration getTotalTimeout()
```
    The TotalTimeout parameter 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.
  - getInitialRetryDelay
```
public abstract org.threeten.bp.Duration getInitialRetryDelay()
```
    The InitialRetryDelay parameter controls the delay before the first retry. Subsequent retries will use this value adjusted according to the RetryDelayMultiplier.
  - getRetryDelayMultiplier
```
public abstract double getRetryDelayMultiplier()
```
    The 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.
  - getMaxAttempts
```
public abstract int getMaxAttempts()
```
    MaxAttempts defines the maximum number of attempts to perform. If the number of attempts reaches this limit, the logic will give up retrying even if the total retry time is still lower than TotalTimeout.
  - getMaxRetryDelay
```
public abstract org.threeten.bp.Duration getMaxRetryDelay()
```
    The 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.
  - getInitialRpcTimeout
```
public abstract org.threeten.bp.Duration getInitialRpcTimeout()
```
    The InitialRpcTimeout parameter controls the timeout for the initial RPC. Subsequent calls will use this value adjusted according to the RpcTimeoutMultiplier.
  - getRpcTimeoutMultiplier
```
public abstract double getRpcTimeoutMultiplier()
```
    See the class documentation of RetrySettings for a description of what this value does.
  - getMaxRpcTimeout
```
public abstract org.threeten.bp.Duration getMaxRpcTimeout()
```
    The 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

setInitialRpcTimeout

setRpcTimeoutMultiplier

setMaxRpcTimeout

getTotalTimeout

getInitialRetryDelay

getRetryDelayMultiplier

getMaxAttempts

getMaxRetryDelay

getInitialRpcTimeout

getRpcTimeoutMultiplier

getMaxRpcTimeout

build

merge