Packages

final class RetrySettings extends AnyRef

Settings for retrying operations.

Source
RetrySettings.scala
Linear Supertypes
AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RetrySettings
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from RetrySettings toany2stringadd[RetrySettings] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (RetrySettings, B)
    Implicit
    This member is added by an implicit conversion from RetrySettings toArrowAssoc[RetrySettings] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  8. val delayFunction: (Int) => Option[FiniteDuration]
  9. def ensuring(cond: (RetrySettings) => Boolean, msg: => Any): RetrySettings
    Implicit
    This member is added by an implicit conversion from RetrySettings toEnsuring[RetrySettings] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (RetrySettings) => Boolean): RetrySettings
    Implicit
    This member is added by an implicit conversion from RetrySettings toEnsuring[RetrySettings] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: => Any): RetrySettings
    Implicit
    This member is added by an implicit conversion from RetrySettings toEnsuring[RetrySettings] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): RetrySettings
    Implicit
    This member is added by an implicit conversion from RetrySettings toEnsuring[RetrySettings] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. val maxRetries: Int
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  22. val shouldRetry: (Throwable) => Boolean
  23. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  24. def toString(): String
    Definition Classes
    RetrySettings → AnyRef → Any
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  27. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  28. def withDecider(shouldRetry: (Throwable) => Boolean): RetrySettings

    Scala API: Set the function to determine if a failure should be retried.

    Scala API: Set the function to determine if a failure should be retried.

    shouldRetry

    function to determine if a failure should be retried

    returns

    Updated settings

  29. def withDelayFunction(delayFunction: (Int) => Option[FiniteDuration]): RetrySettings

    Scala API: Set custom delay function between retries.

    Scala API: Set custom delay function between retries.

    delayFunction

    function to calculate the delay between retries

    returns

    Updated settings

  30. def withExponentialBackoff(minBackoff: Duration, maxBackoff: Duration, randomFactor: Double): RetrySettings

    Java API: Set exponential backoff delay between retries.

    Java API: Set exponential backoff delay between retries.

    minBackoff

    minimum backoff duration

    maxBackoff

    maximum backoff duration

    randomFactor

    random factor to add jitter to the backoff

    returns

    Updated settings

  31. def withExponentialBackoff(minBackoff: FiniteDuration, maxBackoff: FiniteDuration, randomFactor: Double): RetrySettings

    Scala API: Set exponential backoff delay between retries.

    Scala API: Set exponential backoff delay between retries.

    minBackoff

    minimum backoff duration

    maxBackoff

    maximum backoff duration

    randomFactor

    random factor to add jitter to the backoff

  32. def withFixedDelay(fixedDelay: Duration): RetrySettings

    Java API: Set fixed delay between retries.

    Java API: Set fixed delay between retries.

    fixedDelay

    fixed delay between retries

    returns

    Updated settings

  33. def withFixedDelay(fixedDelay: FiniteDuration): RetrySettings

    Scala API: Set fixed delay between retries.

    Scala API: Set fixed delay between retries.

    fixedDelay

    fixed delay between retries

    returns

    Updated settings

  34. def withJavaDecider(shouldRetry: Function[Throwable, Boolean]): RetrySettings

    Java API: Set the function to determine if a failure should be retried.

    Java API: Set the function to determine if a failure should be retried.

    shouldRetry

    function to determine if a failure should be retried

    returns

    Updated settings

  35. def withJavaDelayFunction(delayFunction: IntFunction[Optional[Duration]]): RetrySettings

    Java API: Set custom delay function between retries.

    Java API: Set custom delay function between retries.

    delayFunction

    function to calculate the delay between retries

    returns

    Updated settings

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from RetrySettings toStringFormat[RetrySettings] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def →[B](y: B): (RetrySettings, B)
    Implicit
    This member is added by an implicit conversion from RetrySettings toArrowAssoc[RetrySettings] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromRetrySettings to any2stringadd[RetrySettings]

Inherited by implicit conversion StringFormat fromRetrySettings to StringFormat[RetrySettings]

Inherited by implicit conversion Ensuring fromRetrySettings to Ensuring[RetrySettings]

Inherited by implicit conversion ArrowAssoc fromRetrySettings to ArrowAssoc[RetrySettings]

Ungrouped