c

org.checkita.dqf.config.jobconf.Targets

SummaryEmailTargetConfig

final case class SummaryEmailTargetConfig(recipients: Refined[Seq[Email], NonEmpty], attachMetricErrors: Boolean = false, attachFailedChecks: Boolean = false, metrics: Seq[NonEmptyString] = Seq.empty, dumpSize: Option[PositiveInt], subjectTemplate: Option[NonEmptyString], template: Option[NonEmptyString], templateFile: Option[URI]) extends SummaryTargetConfig with EmailOutputConfig with Product with Serializable

Summary target configuration with output to recipients via email.

recipients

Non-empty sequence of recipients' emails.

attachMetricErrors

Boolean flag indicating whether to attach metric error collection report to summary email. Default: false

metrics

Sequence of metrics to collect errors for. Default: empty sequence (collect errors for all metrics)

dumpSize

Maximum number of errors collected per each metric. Default: 100

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, SummaryTargetConfig, TargetConfig, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SummaryEmailTargetConfig
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. EmailOutputConfig
  7. NotificationOutputConfig
  8. OutputConfig
  9. SummaryTargetConfig
  10. TargetConfig
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SummaryEmailTargetConfig(recipients: Refined[Seq[Email], NonEmpty], attachMetricErrors: Boolean = false, attachFailedChecks: Boolean = false, metrics: Seq[NonEmptyString] = Seq.empty, dumpSize: Option[PositiveInt], subjectTemplate: Option[NonEmptyString], template: Option[NonEmptyString], templateFile: Option[URI])

    recipients

    Non-empty sequence of recipients' emails.

    attachMetricErrors

    Boolean flag indicating whether to attach metric error collection report to summary email. Default: false

    metrics

    Sequence of metrics to collect errors for. Default: empty sequence (collect errors for all metrics)

    dumpSize

    Maximum number of errors collected per each metric. Default: 100

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

Inherited from TargetConfig

Inherited from AnyRef

Inherited from Any

Ungrouped