Class CircuitBreakerConfig.Builder

java.lang.Object

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

io.helidon.faulttolerance.CircuitBreakerConfig.Builder

All Implemented Interfaces:

Prototype.Builder<CircuitBreakerConfig.Builder, CircuitBreakerConfig>, Builder<CircuitBreakerConfig.Builder, CircuitBreaker>, ConfigBuilderSupport.ConfiguredBuilder<CircuitBreakerConfig.Builder, CircuitBreakerConfig>, Supplier<CircuitBreaker>

Enclosing interface:

CircuitBreakerConfig

public static class CircuitBreakerConfig.Builder
extends CircuitBreakerConfig.BuilderBase<CircuitBreakerConfig.Builder, CircuitBreakerConfig>
implements Builder<CircuitBreakerConfig.Builder, CircuitBreaker>

Fluent API builder for CircuitBreaker.

Nested Class Summary

Nested classes/interfaces inherited from class CircuitBreakerConfig.BuilderBase

CircuitBreakerConfig.BuilderBase.CircuitBreakerConfigImpl

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

Method Summary

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

Methods inherited from class CircuitBreakerConfig.BuilderBase

addApplyOn, addApplyOn, addSkipOn, addSkipOn, applyOn, applyOn, clearApplyOn, clearExecutor, clearName, clearSkipOn, config, config, delay, delay, enableMetrics, enableMetrics, errorRatio, errorRatio, executor, executor, from, from, name, name, preBuildPrototype, skipOn, skipOn, successThreshold, successThreshold, toString, validatePrototype, volume, volume

Modifier and Type	Method	Description
CircuitBreakerConfig.Builder	addApplyOn(Class<? extends Throwable> applyOn)	These throwables will be considered failures.
CircuitBreakerConfig.Builder	addApplyOn(Set<Class<? extends Throwable>> applyOn)	These throwables will be considered failures.
CircuitBreakerConfig.Builder	addSkipOn(Class<? extends Throwable> skipOn)	These throwables will not be considered failures, all other will.
CircuitBreakerConfig.Builder	addSkipOn(Set<Class<? extends Throwable>> skipOn)	These throwables will not be considered failures, all other will.
Set<Class<? extends Throwable>>	applyOn()	These throwables will be considered failures.
CircuitBreakerConfig.Builder	applyOn(Set<Class<? extends Throwable>> applyOn)	These throwables will be considered failures.
CircuitBreakerConfig.Builder	clearApplyOn()	Clear all applyOn.
CircuitBreakerConfig.Builder	clearExecutor()	Clear existing value of executor.
CircuitBreakerConfig.Builder	clearName()	Clear existing value of name.
CircuitBreakerConfig.Builder	clearSkipOn()	Clear all skipOn.
protected Optional<Config>	config()	Configuration used to configure this instance.
CircuitBreakerConfig.Builder	config(Config config)	Update builder from configuration (node of this type).
Duration	delay()	How long to wait before transitioning from open to half-open state; must not be negative and must be small enough to represent in milliseconds.
CircuitBreakerConfig.Builder	delay(Duration delay)	How long to wait before transitioning from open to half-open state; must not be negative and must be small enough to represent in milliseconds.
boolean	enableMetrics()	Flag to enable metrics for this instance.
CircuitBreakerConfig.Builder	enableMetrics(boolean enableMetrics)	Flag to enable metrics for this instance.
int	errorRatio()	How many failures out of 100 will trigger the circuit to open; must be between 1 and 100, inclusive, and its product with the configured volume must not exceed 2,147,483,647.
CircuitBreakerConfig.Builder	errorRatio(int errorRatio)	How many failures out of 100 will trigger the circuit to open; must be between 1 and 100, inclusive, and its product with the configured volume must not exceed 2,147,483,647.
Optional<ExecutorService>	executor()	Executor service to schedule future tasks.
CircuitBreakerConfig.Builder	executor(ExecutorService executor)	Executor service to schedule future tasks.
CircuitBreakerConfig.Builder	from(CircuitBreakerConfig prototype)	Update this builder from an existing prototype instance.
CircuitBreakerConfig.Builder	from(CircuitBreakerConfig.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
Optional<String>	name()	Name of this circuit breaker.
CircuitBreakerConfig.Builder	name(String name)	Name of this circuit breaker.
protected void	preBuildPrototype()	Handles providers and decorators.
Set<Class<? extends Throwable>>	skipOn()	These throwables will not be considered failures, all other will.
CircuitBreakerConfig.Builder	skipOn(Set<Class<? extends Throwable>> skipOn)	These throwables will not be considered failures, all other will.
int	successThreshold()	How many successful calls will close a half-open circuit; must be at least 1.
CircuitBreakerConfig.Builder	successThreshold(int successThreshold)	How many successful calls will close a half-open circuit; must be at least 1.
String	toString()
protected void	validatePrototype()	Validates required properties.
int	volume()	Rolling window size used to calculate ratio of failed requests; must be at least 1 and its product with the configured error ratio must not exceed 2,147,483,647.
CircuitBreakerConfig.Builder	volume(int volume)	Rolling window size used to calculate ratio of failed requests; must be at least 1 and its product with the configured error ratio must not exceed 2,147,483,647.

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 CircuitBreaker	get()
default CircuitBreakerConfig.Builder	identity()	Instance of this builder as the correct type.
default CircuitBreakerConfig.Builder	update(Consumer<CircuitBreakerConfig.Builder> consumer)	Update the builder in a fluent API way.

Methods inherited from interface Prototype.Builder

self

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

Method Details

buildPrototype

public CircuitBreakerConfig 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<CircuitBreakerConfig.Builder, CircuitBreakerConfig>

Returns:

an instance of the setup object created from this builder

build

public CircuitBreaker 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<CircuitBreakerConfig.Builder, CircuitBreaker>

Returns:

instance of the built type