Package com.google.api.gax.retrying

Class RetrySettings.Builder

  • Enclosing class:
    RetrySettings
    public abstract static class RetrySettings.Builder
extends java.lang.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 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.

      • setLogicalTimeout

        @BetaApi
public RetrySettings.Builder setLogicalTimeout​(org.threeten.bp.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.