io.github.resilience4j.retry

Class RetryConfig.Builder

java.lang.Object

io.github.resilience4j.retry.RetryConfig.Builder

Enclosing class:

RetryConfig

public static class RetryConfig.Builder
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
RetryConfig	build()
RetryConfig.Builder	ignoreExceptions(java.lang.Class<? extends java.lang.Throwable>... errorClasses) Configures a list of error classes that are ignored and thus are not retried.
RetryConfig.Builder	intervalFunction(IntervalFunction f) Set a function to modify the waiting interval after a failure.
RetryConfig.Builder	maxAttempts(int maxAttempts)
RetryConfig.Builder	retryExceptions(java.lang.Class<? extends java.lang.Throwable>... errorClasses) Configures a list of error classes that are recorded as a failure and thus increase the failure rate.
RetryConfig.Builder	retryOnException(java.util.function.Predicate<java.lang.Throwable> predicate) Configures a Predicate which evaluates if an exception should be retried.
RetryConfig.Builder	waitDuration(java.time.Duration waitDuration)

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

maxAttempts

public RetryConfig.Builder maxAttempts(int maxAttempts)

waitDuration

public RetryConfig.Builder waitDuration(java.time.Duration waitDuration)

intervalFunction

public RetryConfig.Builder intervalFunction(IntervalFunction f)

Set a function to modify the waiting interval after a failure. By default the interval stays the same.

Parameters:

f - Function to modify the interval after a failure

Returns:

the CircuitBreakerConfig.Builder

retryOnException

public RetryConfig.Builder retryOnException(java.util.function.Predicate<java.lang.Throwable> predicate)

Configures a Predicate which evaluates if an exception should be retried. The Predicate must return true if the exception should count be retried, otherwise it must return false.

Parameters:

predicate - the Predicate which evaluates if an exception should be retried or not.

Returns:

the RetryConfig.Builder

retryExceptions

@SafeVarargs
public final RetryConfig.Builder retryExceptions(java.lang.Class<? extends java.lang.Throwable>... errorClasses)

Configures a list of error classes that are recorded as a failure and thus increase the failure rate. Any exception matching or inheriting from one of the list will be retried, unless ignored via

Parameters:

errorClasses - the error classes that are retried

Returns:

the RetryConfig.Builder

See Also:

). Ignoring an exception has priority over retrying an exception. Example: retryOnExceptions(Throwable.class) and ignoreExceptions(RuntimeException.class) would retry all Errors and checked Exceptions, and ignore unchecked For a more sophisticated exception management use the, method

ignoreExceptions

@SafeVarargs
public final RetryConfig.Builder ignoreExceptions(java.lang.Class<? extends java.lang.Throwable>... errorClasses)

Configures a list of error classes that are ignored and thus are not retried. Any exception matching or inheriting from one of the list will not be retried, even if marked via

Parameters:

errorClasses - the error classes that are retried

Returns:

the RetryConfig.Builder

See Also:

. Ignoring an exception has priority over retrying an exception. Example: ignoreExceptions(Throwable.class) and retryOnExceptions(Exception.class) would capture nothing Example: ignoreExceptions(Exception.class) and retryOnExceptions(Throwable.class) would capture Errors For a more sophisticated exception management use the, method

build

public RetryConfig build()