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. val arbitraryChecks: Seq[ArbitraryCheck]
  2. val checkResultCombiner: (Seq[CheckResult]) ⇒ CheckSuiteStatus
  3. val checkSuiteDescription: String

    Description of the check suite

    Description of the check suite

    Definition Classes
    ChecksSuite → ChecksSuiteBase
  4. val dualDsChecks: Map[DescribedDsPair, Seq[DualDsQCCheck]]
  5. val metricsPersister: MetricsPersister
  6. val metricsToTrack: Map[DescribedDs, Seq[MetricDescriptor]]
  7. val qcResultsRepository: QcResultsRepository
  8. 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
  9. val singleDsChecks: Map[DescribedDs, Seq[SingleDsCheck]]
  10. val tags: Map[String, String]