final case class EndpointCircuitBreaker(enabled: Option[Boolean] = None, trippedDuration: Duration, rollingWindow: Long, numBuckets: Long, volumeThreshold: Long, errorThresholdPercentage: Double) extends Product with Serializable
A class encapsulating the EndpointCircuitBreaker resource.
- enabled
trueif the module will be applied to traffic,falseto disable. defaulttrueif unspecified- trippedDuration
Integer number of seconds after which the circuit is tripped to wait before re-evaluating upstream health
- rollingWindow
Integer number of seconds in the statistical rolling window that metrics are retained for.
- numBuckets
Integer number of buckets into which metrics are retained. Max 128.
- volumeThreshold
Integer number of requests in a rolling window that will trip the circuit. Helpful if traffic volume is low.
- errorThresholdPercentage
Error threshold percentage should be between 0 - 1.0, not 0-100.0
- Alphabetic
- By Inheritance
- EndpointCircuitBreaker
- Serializable
- Product
- Equals
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new EndpointCircuitBreaker(enabled: Option[Boolean] = None, trippedDuration: Duration, rollingWindow: Long, numBuckets: Long, volumeThreshold: Long, errorThresholdPercentage: Double)
create a new EndpointCircuitBreaker.
create a new EndpointCircuitBreaker.
- enabled
trueif the module will be applied to traffic,falseto disable. defaulttrueif unspecified- trippedDuration
Integer number of seconds after which the circuit is tripped to wait before re-evaluating upstream health
- rollingWindow
Integer number of seconds in the statistical rolling window that metrics are retained for.
- numBuckets
Integer number of buckets into which metrics are retained. Max 128.
- volumeThreshold
Integer number of requests in a rolling window that will trip the circuit. Helpful if traffic volume is low.
- errorThresholdPercentage
Error threshold percentage should be between 0 - 1.0, not 0-100.0
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- Implicit
- This member is added by an implicit conversion from EndpointCircuitBreaker toany2stringadd[EndpointCircuitBreaker] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (EndpointCircuitBreaker, B)
- Implicit
- This member is added by an implicit conversion from EndpointCircuitBreaker toArrowAssoc[EndpointCircuitBreaker] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- val enabled: Option[Boolean]
- def ensuring(cond: (EndpointCircuitBreaker) => Boolean, msg: => Any): EndpointCircuitBreaker
- Implicit
- This member is added by an implicit conversion from EndpointCircuitBreaker toEnsuring[EndpointCircuitBreaker] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (EndpointCircuitBreaker) => Boolean): EndpointCircuitBreaker
- Implicit
- This member is added by an implicit conversion from EndpointCircuitBreaker toEnsuring[EndpointCircuitBreaker] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): EndpointCircuitBreaker
- Implicit
- This member is added by an implicit conversion from EndpointCircuitBreaker toEnsuring[EndpointCircuitBreaker] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): EndpointCircuitBreaker
- Implicit
- This member is added by an implicit conversion from EndpointCircuitBreaker toEnsuring[EndpointCircuitBreaker] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val errorThresholdPercentage: Double
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- val numBuckets: Long
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val rollingWindow: Long
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val trippedDuration: Duration
- val volumeThreshold: Long
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
Deprecated Value Members
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from EndpointCircuitBreaker toStringFormat[EndpointCircuitBreaker] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)instead ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
- def →[B](y: B): (EndpointCircuitBreaker, B)
- Implicit
- This member is added by an implicit conversion from EndpointCircuitBreaker toArrowAssoc[EndpointCircuitBreaker] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use
->instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.