Packages

c

uk.gov.hmrc.alertconfig.builder

HttpEndpointAlert

case class HttpEndpointAlert(httpEndpoint: String, cronCheckSchedule: String, expectedHttpStatusCode: Int = 200, expectedQueryString: String = "", severity: AlertSeverity = AlertSeverity.Critical, alertingPlatform: AlertingPlatform = AlertingPlatform.Default) extends Product with Serializable

This alert will notify when it fails to receive the expected response (status code and/or string pattern) from the given endpoint

httpEndpoint

The HTTP endpoint to be checked.

cronCheckSchedule

The schedule for the cron job that will check the endpoint.

expectedHttpStatusCode

The expected HTTP status code from the endpoint. Defaults to 200.

expectedQueryString

The expected query string in the endpoint's response.

severity

The severity level of the alert (critical or warning). Defaults to critical.

alertingPlatform

The platform this alert will target. Defaults to the platform being migrated towards (e.g., Grafana).

Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. HttpEndpointAlert
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new HttpEndpointAlert(httpEndpoint: String, cronCheckSchedule: String, expectedHttpStatusCode: Int = 200, expectedQueryString: String = "", severity: AlertSeverity = AlertSeverity.Critical, alertingPlatform: AlertingPlatform = AlertingPlatform.Default)

    httpEndpoint

    The HTTP endpoint to be checked.

    cronCheckSchedule

    The schedule for the cron job that will check the endpoint.

    expectedHttpStatusCode

    The expected HTTP status code from the endpoint. Defaults to 200.

    expectedQueryString

    The expected query string in the endpoint's response.

    severity

    The severity level of the alert (critical or warning). Defaults to critical.

    alertingPlatform

    The platform this alert will target. Defaults to the platform being migrated towards (e.g., Grafana).

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val alertingPlatform: AlertingPlatform
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  7. val cronCheckSchedule: String
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. val expectedHttpStatusCode: Int
  10. val expectedQueryString: String
  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  12. val httpEndpoint: String
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  17. def productElementNames: Iterator[String]
    Definition Classes
    Product
  18. val severity: AlertSeverity
  19. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  22. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped