c

org.checkita.dqf.config.jobconf.Targets

CheckAlertEmailTargetConfig

final case class CheckAlertEmailTargetConfig(id: ID, recipients: Refined[Seq[Email], NonEmpty], checks: Seq[NonEmptyString] = Seq.empty, subjectTemplate: Option[NonEmptyString], template: Option[NonEmptyString], templateFile: Option[URI]) extends CheckAlertTargetConfig with EmailOutputConfig with Product with Serializable

Check alert target configuration with output to recipients via email

id

Check alert ID

recipients

Non-empty sequence of recipients' emails.

checks

Sequence of checks to send alerts for. Default: empty sequence (send alerts for all checks)

subjectTemplate

Mustache template used to customize email subject. If omitted, default subject name is used.

template

Mustache Html template for email body.

templateFile

Location of file with Mustache Html template for email body.

Note

Template for email body can be provided either explicitly in template argument or read from file provided in templateFile argument. Both of these arguments are allowed. Also, if both of these arguments are omitted, then default email body is used.

Linear Supertypes
Serializable, Serializable, Product, Equals, EmailOutputConfig, NotificationOutputConfig, OutputConfig, CheckAlertTargetConfig, TargetConfig, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CheckAlertEmailTargetConfig
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. EmailOutputConfig
  7. NotificationOutputConfig
  8. OutputConfig
  9. CheckAlertTargetConfig
  10. TargetConfig
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new CheckAlertEmailTargetConfig(id: ID, recipients: Refined[Seq[Email], NonEmpty], checks: Seq[NonEmptyString] = Seq.empty, subjectTemplate: Option[NonEmptyString], template: Option[NonEmptyString], templateFile: Option[URI])

    id

    Check alert ID

    recipients

    Non-empty sequence of recipients' emails.

    checks

    Sequence of checks to send alerts for. Default: empty sequence (send alerts for all checks)

    subjectTemplate

    Mustache template used to customize email subject. If omitted, default subject name is used.

    template

    Mustache Html template for email body.

    templateFile

    Location of file with Mustache Html template for email body.

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 checks: Seq[NonEmptyString]
    Definition Classes
    CheckAlertEmailTargetConfig → CheckAlertTargetConfig
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. val id: ID
    Definition Classes
    CheckAlertEmailTargetConfig → CheckAlertTargetConfig
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. val recipients: Refined[Seq[Email], NonEmpty]
    Definition Classes
    CheckAlertEmailTargetConfig → EmailOutputConfig
  16. val recipientsList: Seq[String]
    Definition Classes
    EmailOutputConfig → NotificationOutputConfig
  17. val subjectTemplate: Option[NonEmptyString]
    Definition Classes
    CheckAlertEmailTargetConfig → EmailOutputConfig → NotificationOutputConfig
  18. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  19. val template: Option[NonEmptyString]
    Definition Classes
    CheckAlertEmailTargetConfig → EmailOutputConfig → NotificationOutputConfig
  20. val templateFile: Option[URI]
    Definition Classes
    CheckAlertEmailTargetConfig → EmailOutputConfig → NotificationOutputConfig
  21. val templateFormat: TemplateFormat
    Definition Classes
    EmailOutputConfig → NotificationOutputConfig
  22. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from EmailOutputConfig

Inherited from NotificationOutputConfig

Inherited from OutputConfig

Inherited from CheckAlertTargetConfig

Inherited from TargetConfig

Inherited from AnyRef

Inherited from Any

Ungrouped