Class CircuitBreakerBuilder

java.lang.Object

io.vertx.rxjava3.circuitbreaker.CircuitBreakerBuilder

All Implemented Interfaces:

io.vertx.lang.rx.RxDelegate

public class CircuitBreakerBuilder
extends Object
implements io.vertx.lang.rx.RxDelegate

A builder for CircuitBreaker.

Unlike CircuitBreaker.openHandler(Handler), CircuitBreaker.halfOpenHandler(Handler) and CircuitBreaker.closeHandler(Handler), the handlers configured through this builder are baked in as immutable when build() is called: calling the corresponding mutator method again on the built circuit breaker throws an IllegalStateException.

NOTE: This class has been automatically generated from the original non RX-ified interface using Vert.x codegen.

Field Summary

Fields

Modifier and Type	Field	Description
static final io.vertx.lang.rx.TypeArg<CircuitBreakerBuilder>	__TYPE_ARG

Constructor Summary

Constructors

Constructor	Description
CircuitBreakerBuilder(CircuitBreakerBuilder delegate)
CircuitBreakerBuilder(Object delegate)

Method Summary

Modifier and Type	Method	Description
CircuitBreaker	build()	Build and return the circuit breaker.
CircuitBreakerBuilder	closeHandler(Handler<Void> handler)	Set the handler invoked when the circuit breaker state switches to closed.
boolean	equals(Object o)
<T> CircuitBreakerBuilder	failurePolicy(FailurePolicy<T> failurePolicy)	Set the failure policy, see CircuitBreaker.failurePolicy(FailurePolicy).
<T> CircuitBreakerBuilder	fallback(Function<Throwable, T> handler)	Set the default fallback function, see CircuitBreaker.fallback(Function).
CircuitBreakerBuilder	getDelegate()
CircuitBreakerBuilder	halfOpenHandler(Handler<Void> handler)	Set the handler invoked when the circuit breaker state switches to half-open.
int	hashCode()
static CircuitBreakerBuilder	newInstance(CircuitBreakerBuilder arg)
CircuitBreakerBuilder	openHandler(Handler<Void> handler)	Set the handler invoked when the circuit breaker state switches to open.
CircuitBreakerBuilder	retryPolicy(RetryPolicy retryPolicy)	Set the retry policy, see CircuitBreaker.retryPolicy(RetryPolicy).
String	toString()
CircuitBreakerBuilder	with(CircuitBreakerOptions options)	Configure the circuit breaker options.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

__TYPE_ARG

public static final io.vertx.lang.rx.TypeArg<CircuitBreakerBuilder> __TYPE_ARG

Constructor Details

CircuitBreakerBuilder

public CircuitBreakerBuilder(CircuitBreakerBuilder delegate)

CircuitBreakerBuilder

public CircuitBreakerBuilder(Object delegate)

Method Details

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getDelegate

public CircuitBreakerBuilder getDelegate()

Specified by:

getDelegate in interface io.vertx.lang.rx.RxDelegate

with

public CircuitBreakerBuilder with(CircuitBreakerOptions options)

Configure the circuit breaker options.

Parameters:

options - the configuration options

Returns:

a reference to this, so the API can be used fluently

openHandler

public CircuitBreakerBuilder openHandler(Handler<Void> handler)

Set the handler invoked when the circuit breaker state switches to open.

Parameters:

handler - the handler

Returns:

a reference to this, so the API can be used fluently

halfOpenHandler

public CircuitBreakerBuilder halfOpenHandler(Handler<Void> handler)

Set the handler invoked when the circuit breaker state switches to half-open.

Parameters:

handler - the handler

Returns:

a reference to this, so the API can be used fluently

closeHandler

public CircuitBreakerBuilder closeHandler(Handler<Void> handler)

Set the handler invoked when the circuit breaker state switches to closed.

Parameters:

handler - the handler

Returns:

a reference to this, so the API can be used fluently

fallback

public <T> CircuitBreakerBuilder fallback(Function<Throwable, T> handler)

Set the default fallback function, see CircuitBreaker.fallback(Function).

Parameters:

handler - the fallback function

Returns:

a reference to this, so the API can be used fluently

failurePolicy

public <T> CircuitBreakerBuilder failurePolicy(FailurePolicy<T> failurePolicy)

Set the failure policy, see CircuitBreaker.failurePolicy(FailurePolicy).

Parameters:

failurePolicy - the failure policy

Returns:

a reference to this, so the API can be used fluently

retryPolicy

public CircuitBreakerBuilder retryPolicy(RetryPolicy retryPolicy)

Set the retry policy, see CircuitBreaker.retryPolicy(RetryPolicy).

Parameters:

retryPolicy - the retry policy

Returns:

a reference to this, so the API can be used fluently

build

public CircuitBreaker build()

Build and return the circuit breaker.

Returns:

the circuit breaker as configured by this builder

newInstance

public static CircuitBreakerBuilder newInstance(CircuitBreakerBuilder arg)