Package io.github.resilience4j.common.retry.configuration

Class CommonRetryConfigurationProperties.InstanceProperties

java.lang.Object

io.github.resilience4j.common.retry.configuration.CommonRetryConfigurationProperties.InstanceProperties

Enclosing class:

CommonRetryConfigurationProperties

public static class CommonRetryConfigurationProperties.InstanceProperties
extends Object

Class storing property values for configuring Retry instances.

Field Summary

Fields

Modifier and Type	Field	Description
private String	baseConfig
private Class<? extends BiConsumer<Integer,Object>>	consumeResultBeforeRetryAttempt	class to be used to perform post actions on the object if it needs to be retried
private Boolean	enableExponentialBackoff	flag to enable Exponential backoff policy or not for retry policy delay
private Boolean	enableRandomizedWait	flag to enable randomized delay policy or not for retry policy delay
private Integer	eventConsumerBufferSize	event buffer size for generated retry events
private Double	exponentialBackoffMultiplier	exponential backoff multiplier value
private Duration	exponentialMaxWaitDuration	exponential max interval value
private Boolean	failAfterMaxAttempts	flag to enable explicit MaxRetriesExceededException to be thrown when max retries are exceeded
private Class<? extends Throwable>[]	ignoreExceptions	list of retry ignored exception classes
private Class<? extends io.github.resilience4j.core.IntervalBiFunction<Object>>	intervalBiFunction
private Integer	maxAttempts
private Double	randomizedWaitFactor	randomized delay factor value
private Class<? extends Predicate<Object>>	resultPredicate	retry setResultPredicate predicate class to be used to evaluate the result to retry or not
private Class<? extends Predicate<Throwable>>	retryExceptionPredicate	retry exception predicate class to be used to evaluate the exception to retry or not
private Class<? extends Throwable>[]	retryExceptions	list of retry exception classes
private Duration	waitDuration

Constructor Summary

Constructors

Constructor	Description
InstanceProperties()

Method Summary

Modifier and Type	Method	Description
String	getBaseConfig()	Gets the shared configuration name.
(package private) Class<? extends BiConsumer<Integer,Object>>	getConsumeResultBeforeRetryAttempt()
Boolean	getEnableExponentialBackoff()
Boolean	getEnableRandomizedWait()
Integer	getEventConsumerBufferSize()
Double	getExponentialBackoffMultiplier()
Duration	getExponentialMaxWaitDuration()
Boolean	getFailAfterMaxAttempts()
Class<? extends Throwable>[]	getIgnoreExceptions()
Class<? extends io.github.resilience4j.core.IntervalBiFunction<Object>>	getIntervalBiFunction()
Integer	getMaxAttempts()
Double	getRandomizedWaitFactor()
Class<? extends Predicate<Object>>	getResultPredicate()
Class<? extends Predicate<Throwable>>	getRetryExceptionPredicate()
Class<? extends Throwable>[]	getRetryExceptions()
Duration	getWaitDuration()
CommonRetryConfigurationProperties.InstanceProperties	setBaseConfig(String baseConfig)	Sets the shared configuration name.
CommonRetryConfigurationProperties.InstanceProperties	setConsumeResultBeforeRetryAttempt(Class<? extends BiConsumer<Integer,Object>> consumer)
CommonRetryConfigurationProperties.InstanceProperties	setEnableExponentialBackoff(Boolean enableExponentialBackoff)
CommonRetryConfigurationProperties.InstanceProperties	setEnableRandomizedWait(Boolean enableRandomizedWait)
CommonRetryConfigurationProperties.InstanceProperties	setEventConsumerBufferSize(Integer eventConsumerBufferSize)
CommonRetryConfigurationProperties.InstanceProperties	setExponentialBackoffMultiplier(Double exponentialBackoffMultiplier)
CommonRetryConfigurationProperties.InstanceProperties	setExponentialMaxWaitDuration(Duration exponentialMaxWaitDuration)
CommonRetryConfigurationProperties.InstanceProperties	setFailAfterMaxAttempts(Boolean failAfterMaxAttempts)
CommonRetryConfigurationProperties.InstanceProperties	setIgnoreExceptions(Class<? extends Throwable>[] ignoreExceptions)
void	setIntervalBiFunction(Class<? extends io.github.resilience4j.core.IntervalBiFunction<Object>> intervalBiFunction)
CommonRetryConfigurationProperties.InstanceProperties	setMaxAttempts(Integer maxAttempts)
CommonRetryConfigurationProperties.InstanceProperties	setRandomizedWaitFactor(Double randomizedWaitFactor)
CommonRetryConfigurationProperties.InstanceProperties	setResultPredicate(Class<? extends Predicate<Object>> resultPredicate)
CommonRetryConfigurationProperties.InstanceProperties	setRetryExceptionPredicate(Class<? extends Predicate<Throwable>> retryExceptionPredicate)
CommonRetryConfigurationProperties.InstanceProperties	setRetryExceptions(Class<? extends Throwable>[] retryExceptions)
CommonRetryConfigurationProperties.InstanceProperties	setWaitDuration(Duration waitDuration)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

waitDuration

@Nullable
private Duration waitDuration

intervalBiFunction

@Nullable
private Class<? extends io.github.resilience4j.core.IntervalBiFunction<Object>> intervalBiFunction

maxAttempts

@Nullable
private Integer maxAttempts

retryExceptionPredicate

@Nullable
private Class<? extends Predicate<Throwable>> retryExceptionPredicate

retry exception predicate class to be used to evaluate the exception to retry or not

resultPredicate

@Nullable
private Class<? extends Predicate<Object>> resultPredicate

retry setResultPredicate predicate class to be used to evaluate the result to retry or not

consumeResultBeforeRetryAttempt

@Nullable
private Class<? extends BiConsumer<Integer,Object>> consumeResultBeforeRetryAttempt

class to be used to perform post actions on the object if it needs to be retried

retryExceptions

@Nullable
private Class<? extends Throwable>[] retryExceptions

list of retry exception classes

ignoreExceptions

@Nullable
private Class<? extends Throwable>[] ignoreExceptions

list of retry ignored exception classes

eventConsumerBufferSize

@Nullable
private Integer eventConsumerBufferSize

event buffer size for generated retry events

enableExponentialBackoff

@Nullable
private Boolean enableExponentialBackoff

flag to enable Exponential backoff policy or not for retry policy delay

exponentialBackoffMultiplier

private Double exponentialBackoffMultiplier

exponential backoff multiplier value

exponentialMaxWaitDuration

private Duration exponentialMaxWaitDuration

exponential max interval value

enableRandomizedWait

@Nullable
private Boolean enableRandomizedWait

flag to enable randomized delay policy or not for retry policy delay

randomizedWaitFactor

private Double randomizedWaitFactor

randomized delay factor value

failAfterMaxAttempts

@Nullable
private Boolean failAfterMaxAttempts

flag to enable explicit MaxRetriesExceededException to be thrown when max retries are exceeded

baseConfig

@Nullable
private String baseConfig

Constructor Details

InstanceProperties

public InstanceProperties()

Method Details

getWaitDuration

@Nullable
public Duration getWaitDuration()

setWaitDuration

public CommonRetryConfigurationProperties.InstanceProperties setWaitDuration(Duration waitDuration)

getIntervalBiFunction

@Nullable
public Class<? extends io.github.resilience4j.core.IntervalBiFunction<Object>> getIntervalBiFunction()

setIntervalBiFunction

public void setIntervalBiFunction(Class<? extends io.github.resilience4j.core.IntervalBiFunction<Object>> intervalBiFunction)

getMaxAttempts

@Nullable
public Integer getMaxAttempts()

setMaxAttempts

public CommonRetryConfigurationProperties.InstanceProperties setMaxAttempts(Integer maxAttempts)

getRetryExceptionPredicate

@Nullable
public Class<? extends Predicate<Throwable>> getRetryExceptionPredicate()

setRetryExceptionPredicate

public CommonRetryConfigurationProperties.InstanceProperties setRetryExceptionPredicate(Class<? extends Predicate<Throwable>> retryExceptionPredicate)

getResultPredicate

@Nullable
public Class<? extends Predicate<Object>> getResultPredicate()

setResultPredicate

public CommonRetryConfigurationProperties.InstanceProperties setResultPredicate(Class<? extends Predicate<Object>> resultPredicate)

getConsumeResultBeforeRetryAttempt

@Nullable
Class<? extends BiConsumer<Integer,Object>> getConsumeResultBeforeRetryAttempt()

setConsumeResultBeforeRetryAttempt

public CommonRetryConfigurationProperties.InstanceProperties setConsumeResultBeforeRetryAttempt(Class<? extends BiConsumer<Integer,Object>> consumer)

getRetryExceptions

@Nullable
public Class<? extends Throwable>[] getRetryExceptions()

setRetryExceptions

public CommonRetryConfigurationProperties.InstanceProperties setRetryExceptions(Class<? extends Throwable>[] retryExceptions)

getIgnoreExceptions

@Nullable
public Class<? extends Throwable>[] getIgnoreExceptions()

setIgnoreExceptions

public CommonRetryConfigurationProperties.InstanceProperties setIgnoreExceptions(Class<? extends Throwable>[] ignoreExceptions)

getEventConsumerBufferSize

public Integer getEventConsumerBufferSize()

setEventConsumerBufferSize

public CommonRetryConfigurationProperties.InstanceProperties setEventConsumerBufferSize(Integer eventConsumerBufferSize)

getEnableExponentialBackoff

public Boolean getEnableExponentialBackoff()

setEnableExponentialBackoff

public CommonRetryConfigurationProperties.InstanceProperties setEnableExponentialBackoff(Boolean enableExponentialBackoff)

getExponentialBackoffMultiplier

@Nullable
public Double getExponentialBackoffMultiplier()

setExponentialBackoffMultiplier

public CommonRetryConfigurationProperties.InstanceProperties setExponentialBackoffMultiplier(Double exponentialBackoffMultiplier)

getExponentialMaxWaitDuration

@Nullable
public Duration getExponentialMaxWaitDuration()

setExponentialMaxWaitDuration

public CommonRetryConfigurationProperties.InstanceProperties setExponentialMaxWaitDuration(Duration exponentialMaxWaitDuration)

getEnableRandomizedWait

@Nullable
public Boolean getEnableRandomizedWait()

setEnableRandomizedWait

public CommonRetryConfigurationProperties.InstanceProperties setEnableRandomizedWait(Boolean enableRandomizedWait)

getRandomizedWaitFactor

@Nullable
public Double getRandomizedWaitFactor()

setRandomizedWaitFactor

public CommonRetryConfigurationProperties.InstanceProperties setRandomizedWaitFactor(Double randomizedWaitFactor)

getFailAfterMaxAttempts

@Nullable
public Boolean getFailAfterMaxAttempts()

setFailAfterMaxAttempts

public CommonRetryConfigurationProperties.InstanceProperties setFailAfterMaxAttempts(Boolean failAfterMaxAttempts)

getBaseConfig

@Nullable
public String getBaseConfig()

Gets the shared configuration name. If this is set, the configuration builder will use the shared configuration backend over this one.

Returns:

The shared configuration name.

setBaseConfig

public CommonRetryConfigurationProperties.InstanceProperties setBaseConfig(String baseConfig)

Sets the shared configuration name. If this is set, the configuration builder will use the shared configuration backend over this one.

Parameters:

baseConfig - The shared configuration name.