Packages

case class ChecksSuite(checkSuiteDescription: String, tags: Map[String, String] = Map.empty, singleDsChecks: Map[DescribedDs, Seq[SingleDsCheck]] = Map.empty, dualDsChecks: Map[DescribedDsPair, Seq[DualDsQCCheck]] = Map.empty, arbitraryChecks: Seq[ArbitraryCheck] = Seq.empty, metricsToTrack: Map[DescribedDs, Seq[MetricDescriptor]] = Map.empty, metricsPersister: MetricsPersister = NullMetricsPersister, qcResultsRepository: QcResultsRepository = new NullQcResultsRepository, checkResultCombiner: (Seq[CheckResult]) ⇒ CheckSuiteStatus = ...) extends ChecksSuiteBase with Product with Serializable

Main entry point which contains the suite of checks you want to perform

checkSuiteDescription

- description of the check suite

tags

- any tags associated with the check suite

singleDsChecks

- map from a single dataset to a list of checks on that dataset

dualDsChecks

- map from a pair of datasets to a list of checks to do on that pair of datasets

arbitraryChecks

- any other arbitrary checks

metricsToTrack

- metrics to track (even if no checks on them)

metricsPersister

- how to persist metrics

checkResultCombiner

- how the overall result status should be calculated

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

Instance Constructors

  1. new ChecksSuite(checkSuiteDescription: String, tags: Map[String, String] = Map.empty, singleDsChecks: Map[DescribedDs, Seq[SingleDsCheck]] = Map.empty, dualDsChecks: Map[DescribedDsPair, Seq[DualDsQCCheck]] = Map.empty, arbitraryChecks: Seq[ArbitraryCheck] = Seq.empty, metricsToTrack: Map[DescribedDs, Seq[MetricDescriptor]] = Map.empty, metricsPersister: MetricsPersister = NullMetricsPersister, qcResultsRepository: QcResultsRepository = new NullQcResultsRepository, checkResultCombiner: (Seq[CheckResult]) ⇒ CheckSuiteStatus = ...)

    checkSuiteDescription

    - description of the check suite

    tags

    - any tags associated with the check suite

    singleDsChecks

    - map from a single dataset to a list of checks on that dataset

    dualDsChecks

    - map from a pair of datasets to a list of checks to do on that pair of datasets

    arbitraryChecks

    - any other arbitrary checks

    metricsToTrack

    - metrics to track (even if no checks on them)

    metricsPersister

    - how to persist metrics

    checkResultCombiner

    - how the overall result status should be calculated

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 arbitraryChecks: Seq[ArbitraryCheck]
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. val checkResultCombiner: (Seq[CheckResult]) ⇒ CheckSuiteStatus
  7. val checkSuiteDescription: String

    Description of the check suite

    Description of the check suite

    Definition Classes
    ChecksSuite → ChecksSuiteBase
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  9. val dualDsChecks: Map[DescribedDsPair, Seq[DualDsQCCheck]]
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. val metricsPersister: MetricsPersister
  15. val metricsToTrack: Map[DescribedDs, Seq[MetricDescriptor]]
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  19. val qcResultsRepository: QcResultsRepository
  20. def run(timestamp: Instant)(implicit ec: ExecutionContext): Future[ChecksSuiteResult]

    Run all checks in the ChecksSuite

    Run all checks in the ChecksSuite

    timestamp

    - time the checks are being run

    ec

    - execution context

    Definition Classes
    ChecksSuite → ChecksSuiteBase
  21. val singleDsChecks: Map[DescribedDs, Seq[SingleDsCheck]]
  22. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  23. val tags: Map[String, String]
  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 ChecksSuiteBase

Inherited from AnyRef

Inherited from Any

Ungrouped