Package com.azure.core.http.policy

Class ExponentialBackoffOptions

java.lang.Object
com.azure.core.http.policy.ExponentialBackoffOptions
public class ExponentialBackoffOptions extends Object
The configuration for exponential backoff that has a delay duration that exponentially increases with each retry attempt until an upper bound is reached after which every retry attempt is delayed by the provided max delay duration.

  • Constructor Details

    • ExponentialBackoffOptions

      public ExponentialBackoffOptions()

  • Method Details

    • getMaxRetries

      public Integer getMaxRetries()
      Gets the max retry attempts that can be made.
      Returns:
      The max retry attempts that can be made.

    • setMaxRetries

      public ExponentialBackoffOptions setMaxRetries(Integer maxRetries)
      Sets the max retry attempts that can be made.
      Parameters:
      maxRetries - the max retry attempts that can be made.
      Returns:
      The updated ExponentialBackoffOptions
      Throws:
      IllegalArgumentException - if maxRetries is less than 0.

    • getBaseDelay

      public Duration getBaseDelay()
      Gets the base delay duration for retry.
      Returns:
      The base delay duration for retry.

    • setBaseDelay

      public ExponentialBackoffOptions setBaseDelay(Duration baseDelay)
      Sets the base delay duration for retry.
      Parameters:
      baseDelay - the base delay duration for retry.
      Returns:
      The updated ExponentialBackoffOptions
      Throws:
      IllegalArgumentException - if baseDelay is less than or equal to 0 or maxDelay has been set and is less than baseDelay.

    • getMaxDelay

      public Duration getMaxDelay()
      Gets the max delay duration for retry.
      Returns:
      The max delay duration for retry.

    • setMaxDelay

      public ExponentialBackoffOptions setMaxDelay(Duration maxDelay)
      Sets the max delay duration for retry.
      Parameters:
      maxDelay - the max delay duration for retry.
      Returns:
      The updated ExponentialBackoffOptions
      Throws:
      IllegalArgumentException - if maxDelay is less than or equal to 0 or baseDelay has been set and is more than maxDelay.