checkssuite

Type Members

1. sealed trait CheckSuiteStatus extends EnumEntry

   

   Represents the overall status of a CheckSuite

2. 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 Product with Serializable

   

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

   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

3. case class ChecksSuiteResult(overallStatus: CheckSuiteStatus, checkSuiteDescription: String, checkResults: Seq[CheckResult], timestamp: Instant, checkTags: Map[String, String]) extends Product with Serializable

   
   overallStatus

   - Overall status of the CheckSuite. Dependent on the checks within the check suite

   checkSuiteDescription

   - Description of the suite of checks that was run

   checkResults

   - Sequence of CheckResult for every check in the CheckSuite

   timestamp

   - the time the checks were run

   checkTags

   - any tags associated with the CheckSuite

4. case class ChecksSuitesResults(results: Seq[ChecksSuiteResult]) extends Product with Serializable

   

5. case class DescribedDs(ds: Dataset[_], description: String) extends Product with Serializable

   

   A dataset with description

   A dataset with description

   ds

   - the dataset

   description

   - description of the dataset

6. case class DescribedDsPair(ds: DescribedDs, dsToCompare: DescribedDs) extends Product with Serializable

   

   A pair of DescribedDss

   A pair of DescribedDss

   ds

   - the first described dataset

   dsToCompare

   - the second described dataset