ChecksSuite

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, AnyRef, Any

Instance Constructors

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

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
val arbitraryChecks: Seq[ArbitraryCheck]

- any other arbitrary checks
final def asInstanceOf[T0]: T0

Definition Classes
Any
val checkResultCombiner: (Seq[CheckResult]) ⇒ CheckSuiteStatus

- how the overall result status should be calculated
val checkSuiteDescription: String

- description of the check suite
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val dualDsChecks: Map[DescribedDsPair, Seq[DualDsQCCheck]]

- map from a pair of datasets to a list of checks to do on that pair of datasets
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val metricsPersister: MetricsPersister

- how to persist metrics
val metricsToTrack: Map[DescribedDs, Seq[MetricDescriptor]]

- metrics to track (even if no checks on them)
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val qcResultsRepository: QcResultsRepository
def run(timestamp: Instant)(implicit ec: ExecutionContext): Future[ChecksSuiteResult]

Run all checks in the ChecksSuite asynchronously, returning a Future
Run all checks in the ChecksSuite asynchronously, returning a Future
timestamp
- time the checks are being run
ec
- execution context
def runBlocking(timestamp: Instant, timeout: Duration = 1 minute)(implicit ec: ExecutionContext): ChecksSuiteResult

Run all checks in the ChecksSuite and waits for computations to finish before returning (blocking the thread)
Run all checks in the ChecksSuite and waits for computations to finish before returning (blocking the thread)
timestamp
- time the checks are being run
ec
- execution context
val singleDsChecks: Map[DescribedDs, Seq[SingleDsCheck]]

- map from a single dataset to a list of checks on that dataset
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val tags: Map[String, String]

- any tags associated with the check suite
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package checkssuite

Instance Constructors

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

val arbitraryChecks: Seq[ArbitraryCheck]

final def asInstanceOf[T0]: T0

val checkResultCombiner: (Seq[CheckResult]) ⇒ CheckSuiteStatus

val checkSuiteDescription: String

def clone(): AnyRef

val dualDsChecks: Map[DescribedDsPair, Seq[DualDsQCCheck]]

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

final def getClass(): Class[_]

final def isInstanceOf[T0]: Boolean

val metricsPersister: MetricsPersister

val metricsToTrack: Map[DescribedDs, Seq[MetricDescriptor]]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val qcResultsRepository: QcResultsRepository

def run(timestamp: Instant)(implicit ec: ExecutionContext): Future[ChecksSuiteResult]

def runBlocking(timestamp: Instant, timeout: Duration = 1 minute)(implicit ec: ExecutionContext): ChecksSuiteResult

val singleDsChecks: Map[DescribedDs, Seq[SingleDsCheck]]

final def synchronized[T0](arg0: ⇒ T0): T0

val tags: Map[String, String]

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped