ChecksSuite

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

checkSuiteDescription: - dsecription of the check suite
tags: - any tags associated with the check suite
seqSingleDatasetMetricsChecks: - list of metric based checks to perform on single datasets
seqDualDatasetMetricChecks: - list of metric based checks where the metrics are compared across pairs of datasets
singleDatasetChecks: - arbitrary checks performed on single datasets
datasetComparisonChecks: - arbitrary checks performed on pairs of datasets
arbitraryChecks: - any other arbitrary checks
deequChecks: - checks to perform using deequ as the underlying checking mechanism
metricsPersister: - how to persist metrics
deequMetricsRepository: - how to persist deequ's metrics
checkResultCombiner: - how the overall result status should be calculated

Linear Supertypes

Serializable, Serializable, Product, Equals, ChecksSuiteBase, AnyRef, Any

Instance Constructors

new ChecksSuite(checkSuiteDescription: String, tags: Map[String, String] = Map.empty, seqSingleDatasetMetricsChecks: Seq[SingleDatasetMetricChecks] = Seq.empty, seqDualDatasetMetricChecks: Seq[DualDatasetMetricChecks] = Seq.empty, singleDatasetChecks: Seq[SingleDatasetCheckWithDs] = Seq.empty, datasetComparisonChecks: Seq[DatasetComparisonCheckWithDs] = Seq.empty, arbitraryChecks: Seq[ArbitraryCheck] = Seq.empty, deequChecks: Seq[DeequCheck] = Seq.empty, metricsPersister: MetricsPersister = NullMetricsPersister, deequMetricsRepository: DeequMetricsRepository = new DeequNullMetricsRepository, checkResultCombiner: (Seq[CheckResult]) ⇒ CheckSuiteStatus = ...)

checkSuiteDescription
- dsecription of the check suite
tags
- any tags associated with the check suite
seqSingleDatasetMetricsChecks
- list of metric based checks to perform on single datasets
seqDualDatasetMetricChecks
- list of metric based checks where the metrics are compared across pairs of datasets
singleDatasetChecks
- arbitrary checks performed on single datasets
datasetComparisonChecks
- arbitrary checks performed on pairs of datasets
arbitraryChecks
- any other arbitrary checks
deequChecks
- checks to perform using deequ as the underlying checking mechanism
metricsPersister
- how to persist metrics
deequMetricsRepository
- how to persist deequ's 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

- dsecription of the check suite
- dsecription of the check suite

Definition Classes
ChecksSuite → ChecksSuiteBase
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val datasetComparisonChecks: Seq[DatasetComparisonCheckWithDs]

- arbitrary checks performed on pairs of datasets
val deequChecks: Seq[DeequCheck]

- checks to perform using deequ as the underlying checking mechanism
val deequMetricsRepository: DeequMetricsRepository

- how to persist deequ's metrics
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
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
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
val seqDualDatasetMetricChecks: Seq[DualDatasetMetricChecks]

- list of metric based checks where the metrics are compared across pairs of datasets
val seqSingleDatasetMetricsChecks: Seq[SingleDatasetMetricChecks]

- list of metric based checks to perform on single datasets
val singleDatasetChecks: Seq[SingleDatasetCheckWithDs]

- arbitrary checks performed on single datasets
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 datasetComparisonChecks: Seq[DatasetComparisonCheckWithDs]

val deequChecks: Seq[DeequCheck]

val deequMetricsRepository: DeequMetricsRepository

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

final def getClass(): Class[_]

final def isInstanceOf[T0]: Boolean

val metricsPersister: MetricsPersister

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

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

val seqDualDatasetMetricChecks: Seq[DualDatasetMetricChecks]

val seqSingleDatasetMetricsChecks: Seq[SingleDatasetMetricChecks]

val singleDatasetChecks: Seq[SingleDatasetCheckWithDs]

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 ChecksSuiteBase

Inherited from AnyRef

Inherited from Any

Ungrouped