object SingleMetricCheck extends Serializable
- Alphabetic
- By Inheritance
- SingleMetricCheck
- Serializable
- Serializable
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
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
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
def
complianceCheck(threshold: AbsoluteThreshold[Double], complianceFn: ComplianceFn, filter: MetricFilter = MetricFilter.noFilter): SingleMetricCheck[DoubleMetric]
Checks the fraction of rows that are compliant with the given complianceFn
Checks the fraction of rows that are compliant with the given complianceFn
- threshold
- the threshold for what fraction of rows is acceptable
- complianceFn
- the function rows are tested with to see if they are compliant
- filter
- the filter that is applied before the compliance fraction is calculated
-
def
distinctValuesCheck(threshold: AbsoluteThreshold[Long], onColumns: List[String], filter: MetricFilter = MetricFilter.noFilter): SingleMetricCheck[LongMetric]
Checks the number of distinct values across the given columns
Checks the number of distinct values across the given columns
- threshold
- the threshold for what number of distinct values is acceptable
- onColumns
- the columns to check for distinct values in
- filter
- the filter that is applied before the distinct value count is done
-
def
distinctnessCheck(threshold: AbsoluteThreshold[Double], onColumns: List[String], filter: MetricFilter = MetricFilter.noFilter): SingleMetricCheck[DoubleMetric]
Checks the distinctness level of values across the given columns (result of 1 means every value is distinct)
Checks the distinctness level of values across the given columns (result of 1 means every value is distinct)
- threshold
- the threshold for what number of distinct values is acceptable
- onColumns
- the columns to check for distinct values in
- filter
- the filter that is applied before the distinct value count is done
-
def
doubleMaxValueCheck(threshold: AbsoluteThreshold[Double], onColumn: String, filter: MetricFilter = MetricFilter.noFilter): SingleMetricCheck[OptDoubleMetric]
Checks the max value of a given Double column in a dataset after the given filter is applied is within the given threshold
Checks the max value of a given Double column in a dataset after the given filter is applied is within the given threshold
- threshold
the threshold for what fraction of rows is acceptable
- onColumn
column on which max value needs to be computed
- filter
the filter that is applied before the dataset max value is computed
-
def
doubleMinValueCheck(threshold: AbsoluteThreshold[Double], onColumn: String, filter: MetricFilter = MetricFilter.noFilter): SingleMetricCheck[OptDoubleMetric]
Checks the min value of a given Double column in a dataset after the given filter is applied is within the given threshold
Checks the min value of a given Double column in a dataset after the given filter is applied is within the given threshold
- threshold
the threshold for what fraction of rows is acceptable
- onColumn
column on which min value needs to be computed
- filter
the filter that is applied before the dataset min value is computed
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
longMaxValueCheck(threshold: AbsoluteThreshold[Long], onColumn: String, filter: MetricFilter = MetricFilter.noFilter): SingleMetricCheck[OptLongMetric]
Checks the max value of a given Int or Long column in a dataset after the given filter is applied is within the given threshold
Checks the max value of a given Int or Long column in a dataset after the given filter is applied is within the given threshold
- threshold
the threshold for what fraction of rows is acceptable
- onColumn
column on which max value needs to be computed
- filter
the filter that is applied before the dataset max value is computed
-
def
longMinValueCheck(threshold: AbsoluteThreshold[Long], onColumn: String, filter: MetricFilter = MetricFilter.noFilter): SingleMetricCheck[OptLongMetric]
Checks the min value of a given Int or Long column in a dataset after the given filter is applied is within the given threshold
Checks the min value of a given Int or Long column in a dataset after the given filter is applied is within the given threshold
- threshold
the threshold for what fraction of rows is acceptable
- onColumn
column on which min value needs to be computed
- filter
the filter that is applied before the dataset min value is computed
-
def
maxValueCheck[MV <: OptNumericMetricValue](threshold: AbsoluteThreshold[SingleMetricCheck.maxValueCheck.MV.U], onColumn: String, filter: MetricFilter = MetricFilter.noFilter)(implicit arg0: MetricValueConstructor[MV]): SingleMetricCheck[MV]
Checks the max value of a given column in a dataset after the given filter is applied is within the given threshold
Checks the max value of a given column in a dataset after the given filter is applied is within the given threshold
- MV
- type of optional metric value that will be used (should match the column type you're calculating the metric on)
- threshold
the threshold for what fraction of rows is acceptable
- onColumn
column on which min value needs to be computed
- filter
the filter that is applied before the dataset min value is computed
-
def
minValueCheck[MV <: OptNumericMetricValue](threshold: AbsoluteThreshold[SingleMetricCheck.minValueCheck.MV.U], onColumn: String, filter: MetricFilter = MetricFilter.noFilter)(implicit arg0: MetricValueConstructor[MV]): SingleMetricCheck[MV]
Checks the min value of a given column in a dataset after the given filter is applied is within the given threshold
Checks the min value of a given column in a dataset after the given filter is applied is within the given threshold
- MV
- type of optional metric value that will be used (should match the column type you're calculating the metric on)
- threshold
the threshold for what fraction of rows is acceptable
- onColumn
column on which min value needs to be computed
- filter
the filter that is applied before the dataset min value is computed
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
def
optThresholdBasedCheck[MV <: OptNumericMetricValue](metricDescriptor: MetricDescriptor { type MetricType = MV }, description: String, threshold: AbsoluteThreshold[SingleMetricCheck.optThresholdBasedCheck.MV.U]): SingleMetricCheck[MV]
A check based on a single optional metric that checks if that metric is within the given threshold.
A check based on a single optional metric that checks if that metric is within the given threshold. If the metric has a value of None the check will automatically fail
- MV
- the type of the MetricValue that will be calculated in order to complete this check
- metricDescriptor
- describes the metric the check will be done on
- description
- the user friendly description for this check
- threshold
- the threshold that the metric must be within to pass
-
def
sizeCheck(threshold: AbsoluteThreshold[Long], filter: MetricFilter = MetricFilter.noFilter): SingleMetricCheck[LongMetric]
Checks the count of rows in a dataset after the given filter is applied is within the given threshold
Checks the count of rows in a dataset after the given filter is applied is within the given threshold
- filter
- filter to be applied before rows are counted
-
def
sumValueCheck[MV <: NumericMetricValue](threshold: AbsoluteThreshold[SingleMetricCheck.sumValueCheck.MV.T], onColumn: String, filter: MetricFilter = MetricFilter.noFilter)(implicit arg0: MetricValueConstructor[MV]): SingleMetricCheck[MV]
Checks the sum of value of rows in a dataset for a given col after the given filter is applied is within the given threshold
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
thresholdBasedCheck[MV <: MetricValue](metricDescriptor: MetricDescriptor { type MetricType = MV }, description: String, threshold: AbsoluteThreshold[SingleMetricCheck.thresholdBasedCheck.MV.T]): SingleMetricCheck[MV]
A check based on a single metric that checks if that metric is within the given threshold
A check based on a single metric that checks if that metric is within the given threshold
- MV
- the type of the MetricValue that will be calculated in order to complete this check
- metricDescriptor
- describes the metric the check will be done on
- description
- the user friendly description for this check
- threshold
- the threshold that the metric must be within to pass
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
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( ... ) @native()