Class RetryConfig.Builder

java.lang.Object

io.helidon.faulttolerance.RetryConfig.BuilderBase<RetryConfig.Builder, RetryConfig>

io.helidon.faulttolerance.RetryConfig.Builder

All Implemented Interfaces:

Prototype.Builder<RetryConfig.Builder, RetryConfig>, Builder<RetryConfig.Builder, Retry>, ConfigBuilderSupport.ConfiguredBuilder<RetryConfig.Builder, RetryConfig>, Supplier<Retry>

Enclosing interface:

RetryConfig

public static class RetryConfig.Builder
extends RetryConfig.BuilderBase<RetryConfig.Builder, RetryConfig>
implements Builder<RetryConfig.Builder, Retry>

Fluent API builder for Retry.

Nested Class Summary

Nested classes/interfaces inherited from class RetryConfig.BuilderBase

RetryConfig.BuilderBase.RetryConfigImpl

Modifier and Type	Class	Description
protected static class	RetryConfig.BuilderBase.RetryConfigImpl	Generated implementation of the prototype, can be extended by descendant prototype implementations.

Method Summary

Modifier and Type	Method	Description
Retry	build()	Create an instance from this builder.
RetryConfig	buildPrototype()	Create an instance of the prototype.

Methods inherited from class RetryConfig.BuilderBase

addApplyOn, addApplyOn, addSkipOn, addSkipOn, applyOn, applyOn, calls, calls, clearApplyOn, clearMaxDelay, clearName, clearRetryPolicy, clearSkipOn, config, config, delay, delay, delayFactor, delayFactor, enableMetrics, enableMetrics, from, from, jitter, jitter, jitterFactor, jitterFactor, maxDelay, maxDelay, name, name, overallTimeout, overallTimeout, preBuildPrototype, retryPolicy, retryPolicy, skipOn, skipOn, toString, validatePrototype

Modifier and Type	Method	Description
RetryConfig.Builder	addApplyOn(Class<? extends Throwable> applyOn)	These throwables will be considered retriable.
RetryConfig.Builder	addApplyOn(Set<Class<? extends Throwable>> applyOn)	These throwables will be considered retriable.
RetryConfig.Builder	addSkipOn(Class<? extends Throwable> skipOn)	These throwables will not be considered retriable, all other will.
RetryConfig.Builder	addSkipOn(Set<Class<? extends Throwable>> skipOn)	These throwables will not be considered retriable, all other will.
Set<Class<? extends Throwable>>	applyOn()	These throwables will be considered retriable.
RetryConfig.Builder	applyOn(Set<Class<? extends Throwable>> applyOn)	These throwables will be considered retriable.
int	calls()	Number of calls, including the initial call and retries, which must be at least 1.
RetryConfig.Builder	calls(int calls)	Number of calls, including the initial call and retries, which must be at least 1.
RetryConfig.Builder	clearApplyOn()	Clear all applyOn.
RetryConfig.Builder	clearMaxDelay()	Clear existing value of maxDelay.
RetryConfig.Builder	clearName()	Clear existing value of name.
RetryConfig.Builder	clearRetryPolicy()	Clear existing value of retryPolicy.
RetryConfig.Builder	clearSkipOn()	Clear all skipOn.
protected Optional<Config>	config()	Configuration used to configure this instance.
RetryConfig.Builder	config(Config config)	Update builder from configuration (node of this type).
Duration	delay()	Non-negative base delay between the initial call and retries, which defaults to 200 ms.
RetryConfig.Builder	delay(Duration delay)	Non-negative base delay between the initial call and retries, which defaults to 200 ms.
double	delayFactor()	Delay multiplier that must be -1 or finite and non-negative; -1 selects 2 unless either jitter option is configured, and an explicit multiplier is applied before jitter.
RetryConfig.Builder	delayFactor(double delayFactor)	Delay multiplier that must be -1 or finite and non-negative; -1 selects 2 unless either jitter option is configured, and an explicit multiplier is applied before jitter.
boolean	enableMetrics()	Flag to enable metrics for this instance.
RetryConfig.Builder	enableMetrics(boolean enableMetrics)	Flag to enable metrics for this instance.
RetryConfig.Builder	from(RetryConfig prototype)	Update this builder from an existing prototype instance.
RetryConfig.Builder	from(RetryConfig.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
Duration	jitter()	Absolute random jitter that must be PT-1S (disabled) or non-negative; it cannot be combined with jitter-factor, is applied independently after delay-factor, does not affect later base-delay calculations, and is capped by max-delay when present.
RetryConfig.Builder	jitter(Duration jitter)	Absolute random jitter that must be PT-1S (disabled) or non-negative; it cannot be combined with jitter-factor, is applied independently after delay-factor, does not affect later base-delay calculations, and is capped by max-delay when present.
double	jitterFactor()	Relative random jitter that must be -1 (disabled) or from 0 (inclusive) to 1 (exclusive); it cannot be combined with jitter, is applied independently after delay-factor, does not affect later base-delay calculations, and is capped by max-delay when present.
RetryConfig.Builder	jitterFactor(double jitterFactor)	Relative random jitter that must be -1 (disabled) or from 0 (inclusive) to 1 (exclusive); it cannot be combined with jitter, is applied independently after delay-factor, does not affect later base-delay calculations, and is capped by max-delay when present.
Optional<Duration>	maxDelay()	Optional non-negative maximum delay applied after jitter; when absent, the delay is not capped.
RetryConfig.Builder	maxDelay(Duration maxDelay)	Optional non-negative maximum delay applied after jitter; when absent, the delay is not capped.
Optional<String>	name()	Name for debugging, error reporting, monitoring.
RetryConfig.Builder	name(String name)	Name for debugging, error reporting, monitoring.
Duration	overallTimeout()	Positive overall timeout used to bound the complete retry sequence.
RetryConfig.Builder	overallTimeout(Duration overallTimeout)	Positive overall timeout used to bound the complete retry sequence.
protected void	preBuildPrototype()	Handles providers and decorators.
Optional<Retry.RetryPolicy>	retryPolicy()	Explicitly configured retry policy.
RetryConfig.Builder	retryPolicy(Retry.RetryPolicy retryPolicy)	Explicitly configured retry policy.
Set<Class<? extends Throwable>>	skipOn()	These throwables will not be considered retriable, all other will.
RetryConfig.Builder	skipOn(Set<Class<? extends Throwable>> skipOn)	These throwables will not be considered retriable, all other will.
String	toString()
protected void	validatePrototype()	Validates required properties.

Methods inherited from class Object

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

Methods inherited from interface Builder

get, identity, update

Modifier and Type	Method	Description
default Retry	get()
default RetryConfig.Builder	identity()	Instance of this builder as the correct type.
default RetryConfig.Builder	update(Consumer<RetryConfig.Builder> consumer)	Update the builder in a fluent API way.

Methods inherited from interface Prototype.Builder

self

Modifier and Type	Method	Description
default RetryConfig.Builder	self()	Instance of this builder as the correct type.

Method Details

buildPrototype

public RetryConfig buildPrototype()

Create an instance of the prototype. Calling this method may update this builder from providers and decorators, so repeated calls may have side effects.

Specified by:

buildPrototype in interface Prototype.Builder<RetryConfig.Builder, RetryConfig>

Returns:

an instance of the setup object created from this builder

build

public Retry build()

Create an instance from this builder. Calling this method may update this builder from providers and decorators, so repeated calls may have side effects.

Specified by:

build in interface Builder<RetryConfig.Builder, Retry>

Returns:

instance of the built type