Top Description Inners Methods

io.github.resilience4j.circuitbreaker.event

public Interface CircuitBreakerEvent

Known Direct Implementers: io.github.resilience4j.circuitbreaker.event.AbstractCircuitBreakerEvent
Imports: java.time.ZonedDateTime

An event which is created by a CircuitBreaker.

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static enum	CircuitBreakerEvent.Type Event types which are created by a CircuitBreaker.

Method Summary

Modifier and Type	Method and Description
public String	Returns: the name of the CircuitBreaker which has created the event getCircuitBreakerName() Returns the name of the CircuitBreaker which has created the event.
public ZonedDateTime	Returns: the creation time of CircuitBreaker event getCreationTime() Returns the creation time of CircuitBreaker event.
public CircuitBreakerEvent.Type	Returns: the type of the CircuitBreaker event getEventType() Returns the type of the CircuitBreaker event.

Method Detail

getCircuitBreakerName

back to summary

public String getCircuitBreakerName()

Returns the name of the CircuitBreaker which has created the event.

Returns:String: the name of the CircuitBreaker which has created the event

getCreationTime

back to summary

public ZonedDateTime getCreationTime()

Returns the creation time of CircuitBreaker event.

Returns:ZonedDateTime: the creation time of CircuitBreaker event

getEventType

back to summary

public CircuitBreakerEvent.Type getEventType()

Returns the type of the CircuitBreaker event.

Returns:CircuitBreakerEvent.Type: the type of the CircuitBreaker event

io.github.resilience4j.circuitbreaker.event back to summary

public final Enum CircuitBreakerEvent.Type

Class Inheritance

extends Enum<CircuitBreakerEvent.Type>

java.lang.Object
java.lang.Enum
io.github.resilience4j.circuitbreaker.event.CircuitBreakerEvent.Type

Event types which are created by a CircuitBreaker.

Field Summary

Modifier and Type	Field and Description
public static final CircuitBreakerEvent.Type	DISABLED A CircuitBreakerEvent which informs the CircuitBreaker has been disabled
public static final CircuitBreakerEvent.Type	ERROR A CircuitBreakerEvent which informs that an error has been recorded
public static final CircuitBreakerEvent.Type	FAILURE_RATE_EXCEEDED A CircuitBreakerEvent which informs the CircuitBreaker failure rate has been breached
public static final CircuitBreakerEvent.Type	FORCED_OPEN A CircuitBreakerEvent which informs the CircuitBreaker has been forced open
public final boolean	forcePublish
public static final CircuitBreakerEvent.Type	IGNORED_ERROR A CircuitBreakerEvent which informs that an error has been ignored
public static final CircuitBreakerEvent.Type	NOT_PERMITTED A CircuitBreakerEvent which informs that a call was not permitted because the CircuitBreaker state is OPEN
public static final CircuitBreakerEvent.Type	RESET A CircuitBreakerEvent which informs the CircuitBreaker has been reset
public static final CircuitBreakerEvent.Type	SLOW_CALL_RATE_EXCEEDED A CircuitBreakerEvent which informs the CircuitBreaker show call rate has been breached
public static final CircuitBreakerEvent.Type	STATE_TRANSITION A CircuitBreakerEvent which informs the state of the CircuitBreaker has been changed
public static final CircuitBreakerEvent.Type	SUCCESS A CircuitBreakerEvent which informs that a success has been recorded

Constructor Summary

Access	Constructor and Description
private	Type(boolean forcePublish)

Method Summary

Modifier and Type	Method and Description
public static CircuitBreakerEvent.Type	valueOf(String name)
public static CircuitBreakerEvent.Type[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

DISABLED	back to summary
public static final CircuitBreakerEvent.Type DISABLED A CircuitBreakerEvent which informs the CircuitBreaker has been disabled

ERROR	back to summary
public static final CircuitBreakerEvent.Type ERROR A CircuitBreakerEvent which informs that an error has been recorded

FAILURE_RATE_EXCEEDED	back to summary
public static final CircuitBreakerEvent.Type FAILURE_RATE_EXCEEDED A CircuitBreakerEvent which informs the CircuitBreaker failure rate has been breached

FORCED_OPEN	back to summary
public static final CircuitBreakerEvent.Type FORCED_OPEN A CircuitBreakerEvent which informs the CircuitBreaker has been forced open

forcePublish	back to summary
public final boolean forcePublish

IGNORED_ERROR	back to summary
public static final CircuitBreakerEvent.Type IGNORED_ERROR A CircuitBreakerEvent which informs that an error has been ignored

NOT_PERMITTED	back to summary
public static final CircuitBreakerEvent.Type NOT_PERMITTED A CircuitBreakerEvent which informs that a call was not permitted because the CircuitBreaker state is OPEN

RESET	back to summary
public static final CircuitBreakerEvent.Type RESET A CircuitBreakerEvent which informs the CircuitBreaker has been reset

SLOW_CALL_RATE_EXCEEDED	back to summary
public static final CircuitBreakerEvent.Type SLOW_CALL_RATE_EXCEEDED A CircuitBreakerEvent which informs the CircuitBreaker show call rate has been breached

STATE_TRANSITION	back to summary
public static final CircuitBreakerEvent.Type STATE_TRANSITION A CircuitBreakerEvent which informs the state of the CircuitBreaker has been changed

SUCCESS	back to summary
public static final CircuitBreakerEvent.Type SUCCESS A CircuitBreakerEvent which informs that a success has been recorded

Constructor Detail

Type	back to summary
private Type(boolean forcePublish)

Method Detail

valueOf	back to summary
public static CircuitBreakerEvent.Type valueOf(String name)

values	back to summary
public static CircuitBreakerEvent.Type[] values()