c

uk.gov.hmrc.alertconfig.builder.custom

CustomHttpEndpointAlert

case class CustomHttpEndpointAlert(checkName: String, componentName: String, cronCheckSchedule: String, environmentsEnabled: EnvironmentsEnabled, expectedHttpStatusCode: Option[Int] = None, expectedStringInResponse: Option[String] = None, httpEndpoint: String, integrations: Seq[String], runbookUrl: Option[String], severity: CustomAlertSeverity.AlertSeverity) extends CustomAlert with 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

checkName

Name to be used in the metric path. Only lowercase letters and - are allowed: ^[a-z-]+$

componentName

The name of the component you are testing. e.g. jira / proxy / sensu / mongo. Only lowercase letters and - are allowed: ^[a-z-]+$

cronCheckSchedule

The cron schedule for how often the endpoint will be checked creating a metric data point.

environmentsEnabled

The specific environments to enable this alert in

expectedHttpStatusCode

The HTTP status code expected from the endpoint.

expectedStringInResponse

A substring that is expect in the endpoint's response.

httpEndpoint

The HTTP endpoint to be checked.

integrations

Which PagerDuty integrations to direct this alert to

runbookUrl

Runbook for when this alert fires

severity

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

Annotations
@JsonFilter()
Linear Supertypes
Serializable, Product, Equals, CustomAlert, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CustomHttpEndpointAlert
  2. Serializable
  3. Product
  4. Equals
  5. CustomAlert
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new CustomHttpEndpointAlert(checkName: String, componentName: String, cronCheckSchedule: String, environmentsEnabled: EnvironmentsEnabled, expectedHttpStatusCode: Option[Int] = None, expectedStringInResponse: Option[String] = None, httpEndpoint: String, integrations: Seq[String], runbookUrl: Option[String], severity: CustomAlertSeverity.AlertSeverity)

    checkName

    Name to be used in the metric path. Only lowercase letters and - are allowed: ^[a-z-]+$

    componentName

    The name of the component you are testing. e.g. jira / proxy / sensu / mongo. Only lowercase letters and - are allowed: ^[a-z-]+$

    cronCheckSchedule

    The cron schedule for how often the endpoint will be checked creating a metric data point.

    environmentsEnabled

    The specific environments to enable this alert in

    expectedHttpStatusCode

    The HTTP status code expected from the endpoint.

    expectedStringInResponse

    A substring that is expect in the endpoint's response.

    httpEndpoint

    The HTTP endpoint to be checked.

    integrations

    Which PagerDuty integrations to direct this alert to

    runbookUrl

    Runbook for when this alert fires

    severity

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

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. val checkName: String
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  7. val componentName: String
  8. val cronCheckSchedule: String
  9. val environmentsEnabled: EnvironmentsEnabled
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. val expectedHttpStatusCode: Option[Int]
  12. val expectedStringInResponse: Option[String]
  13. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  14. val httpEndpoint: String
  15. val integrations: Seq[String]
    Definition Classes
    CustomHttpEndpointAlertCustomAlert
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  20. def productElementNames: Iterator[String]
    Definition Classes
    Product
  21. val runbookUrl: Option[String]
  22. val severity: CustomAlertSeverity.AlertSeverity
    Definition Classes
    CustomHttpEndpointAlertCustomAlert
  23. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  26. 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 CustomAlert

Inherited from AnyRef

Inherited from Any

Ungrouped