Package com.google.api.gax.retrying

Class RetrySettings.Builder

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
    Description
    Builder()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    RetrySettings
    build()
     
    abstract org.threeten.bp.Duration
    getInitialRetryDelay()
    InitialRetryDelay controls the delay before the first retry/ poll.
    abstract org.threeten.bp.Duration
    getInitialRpcTimeout()
    InitialRpcTimeout controls the timeout for the initial RPC.
    abstract int
    getMaxAttempts()
    MaxAttempts defines the maximum number of retry 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 delay before the next retry or poll.
    abstract double
    getRpcTimeoutMultiplier()
    RpcTimeoutMultiplier controls the change in RPC timeout.
    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/ poll.
    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.
    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.
    abstract RetrySettings.Builder
    setMaxAttempts(int maxAttempts)
    MaxAttempts defines the maximum number of retry 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 delay before the next retry or poll.
    abstract RetrySettings.Builder
    setRpcTimeoutMultiplier(double multiplier)
    RpcTimeoutMultiplier controls the change in RPC timeout.
    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 Details

    • Builder

      public Builder()

  • Method Details

    • 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 and polls can be attempted. If this value is Duration.ZERO, then the logic will instead use the number of attempts to determine retries. In the event that both maxAttempts and totalTimeout values are both 0, the logic will not retry. If this value is non-Duration.ZERO, and the retry duration has reaches the timeout value, the logic will give up retrying even the number of attempts is lower than the maxAttempts value.

      If there are no configurations, Retries have the default timeout value of Duration.ZERO and LROs have a default total timeout value of Duration.ofMillis(300000) (5 minutes).

    • setInitialRetryDelay

      public abstract RetrySettings.Builder setInitialRetryDelay(org.threeten.bp.Duration initialDelay)
      InitialRetryDelay controls the delay before the first retry/ poll. Subsequent retries and polls will use this value adjusted according to the RetryDelayMultiplier.

      If there are no configurations, Retries have the default initial retry delay value of Duration.ZERO and LROs have a default initial poll delay value of Duration.ofMillis(5000) (5 seconds).

    • setRetryDelayMultiplier

      public abstract RetrySettings.Builder setRetryDelayMultiplier(double multiplier)
      RetryDelayMultiplier controls the change in delay before the next retry or poll. The retry delay of the previous call is multiplied by the RetryDelayMultiplier to calculate the retry delay for the next call.

      If there are no configurations, Retries have the default retry delay multiplier value of 1.0 and LROs have a default retry delay multiplier of 1.5.

    • 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.

      If there are no configurations, Retries have the default max retry delay value of Duration.ZERO and LROs have a default max poll retry delay value of Duration.ofMillis(45000) (45 seconds).

    • setMaxAttempts

      public abstract RetrySettings.Builder setMaxAttempts(int maxAttempts)
      MaxAttempts defines the maximum number of retry attempts to perform. If this value is set to 0, the logic will instead use the totalTimeout value to determine retries. In the event that both the maxAttempts and totalTimeout values are both 0, the logic will not retry. If this value is greater than 0, and the number of attempts exceeds this limit, the logic will give up retrying even if the total retry time is still lower than totalTimeout.

      If there are no configurations, Retries and LROs have the default max attempt value of 0. LRO polling does not use this value by default.

      The first RPC invocation will be considered attempt #0. Subsequent calls (retries) will increment the number of attempts and the number of attempts will not exceed this value.

    • 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. RPC Timeout value of Duration.ZERO allows the RPC to continue indefinitely (until it hits a Connect Timeout or the connection has been terminated).

      getTotalTimeout() caps how long the logic should keep trying the RPC until it gives up completely. If getTotalTimeout() is set, initialRpcTimeout should be <= totalTimeout.

      If there are no configurations, Retries have the default initial RPC timeout value of Duration.ZERO. LRO polling does not use the Initial RPC Timeout value.

    • setRpcTimeoutMultiplier

      public abstract RetrySettings.Builder setRpcTimeoutMultiplier(double multiplier)
      RpcTimeoutMultiplier controls the change in RPC timeout. The timeout of the previous call is multiplied by the RpcTimeoutMultiplier to calculate the timeout for the next call.

      If there are no configurations, Retries have the default RPC Timeout Multiplier value of 1.0. LRO polling does not use the RPC Timeout Multiplier value.

    • 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.

      If there are no configurations, Retries have the default Max RPC Timeout value of Duration.ZERO. LRO polling does not use the Max RPC Timeout value.

    • 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 and polls can be attempted. If this value is Duration.ZERO, then the logic will instead use the number of attempts to determine retries. In the event that both maxAttempts and totalTimeout values are both 0, the logic will not retry. If this value is non-Duration.ZERO, and the retry duration has reaches the timeout value, the logic will give up retrying even the number of attempts is lower than the maxAttempts value.

      If there are no configurations, Retries have the default timeout value of Duration.ZERO and LROs have a default total timeout value of Duration.ofMillis(300000) (5 minutes).

    • getInitialRetryDelay

      public abstract org.threeten.bp.Duration getInitialRetryDelay()
      InitialRetryDelay controls the delay before the first retry/ poll. Subsequent retries and polls will use this value adjusted according to the RetryDelayMultiplier.

      If there are no configurations, Retries have the default initial retry delay value of Duration.ZERO and LROs have a default initial poll delay value of Duration.ofMillis(5000) (5 seconds).

    • getRetryDelayMultiplier

      public abstract double getRetryDelayMultiplier()
      RetryDelayMultiplier controls the change in delay before the next retry or poll. The retry delay of the previous call is multiplied by the RetryDelayMultiplier to calculate the retry delay for the next call.

      If there are no configurations, Retries have the default retry delay multiplier value of 1.0 and LROs have a default retry delay multiplier of 1.5.

    • getMaxAttempts

      public abstract int getMaxAttempts()
      MaxAttempts defines the maximum number of retry attempts to perform. If this value is set to 0, the logic will instead use the totalTimeout value to determine retries. In the event that both the maxAttempts and totalTimeout values are both 0, the logic will not retry. If this value is greater than 0, and the number of attempts exceeds this limit, the logic will give up retrying even if the total retry time is still lower than totalTimeout.

      If there are no configurations, Retries and LROs have the default max attempt value of 0. LRO polling does not use this value by default.

      The first RPC invocation will be considered attempt #0. Subsequent calls (retries) will increment the number of attempts and the number of attempts will not exceed this value.

    • 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.

      If there are no configurations, Retries have the default max retry delay value of Duration.ZERO and LROs have a default max poll retry delay value of Duration.ofMillis(45000) (45 seconds).

    • 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. RPC Timeout value of Duration.ZERO allows the RPC to continue indefinitely (until it hits a Connect Timeout or the connection has been terminated).

      getTotalTimeout() caps how long the logic should keep trying the RPC until it gives up completely. If getTotalTimeout() is set, initialRpcTimeout should be <= totalTimeout.

      If there are no configurations, Retries have the default initial RPC timeout value of Duration.ZERO. LRO polling does not use the Initial RPC Timeout value.

    • getRpcTimeoutMultiplier

      public abstract double getRpcTimeoutMultiplier()
      RpcTimeoutMultiplier controls the change in RPC timeout. The timeout of the previous call is multiplied by the RpcTimeoutMultiplier to calculate the timeout for the next call.

      If there are no configurations, Retries have the default RPC Timeout Multiplier value of 1.0. LRO polling does not use the RPC Timeout Multiplier value.

    • 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.

      If there are no configurations, Retries have the default Max RPC Timeout value of Duration.ZERO. LRO polling does not use the Max RPC Timeout value.

    • 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.

    • build

      public RetrySettings build()

    • merge

      public RetrySettings.Builder merge(RetrySettings.Builder newSettings)