Type Members

1.  final case class ApproxDistinctValuesParams(accuracyError: AccuracyDouble = 0.01) extends Params with Product with Serializable

   Parameters for approximateDistinctValues metric

   Parameters for approximateDistinctValues metric

   accuracyError

   Calculation accuracy error in interval [0,1] Default: 0.01

2.  final case class ApproxSequenceCompletenessParams(increment: PositiveInt = 1, accuracyError: AccuracyDouble = 0.01) extends Params with Product with Serializable

   Parameters for sequence completeness metric

   Parameters for sequence completeness metric

   increment

   sequence increment. Default: 1

   accuracyError

   Calculation accuracy error in interval [0,1] Default: 0.01

3.  final case class CompletenessParams(includeEmptyStrings: Boolean = false) extends Params with Product with Serializable

   Parameters for completeness metric

   Parameters for completeness metric

   includeEmptyStrings

   boolean flag indicating whether empty strings should be taken into account. Default: false - only null values are considered.

4.  final case class DayDistanceParams(threshold: PositiveInt, dateFormat: DateFormat = '>...) extends Params with Product with Serializable

   Parameters for dayDistance metric

   Parameters for dayDistance metric

   threshold

   Maximum allowed day distance between dates

   dateFormat

   Date format of checked columns. Default: "yyyy-MM-dd'T'HH:mm:ss.SSSZ"

5.  final case class FormattedDateParams(dateFormat: DateFormat = '>...) extends Params with Product with Serializable

   Parameters for formatted date metric

   Parameters for formatted date metric

   dateFormat

   Required datetime format pattern. Default: "yyyy-MM-dd'T'HH:mm:ss.SSSZ"

6.  final case class FormattedNumberParams(precision: PositiveInt, scale: PositiveInt, compareRule: PrecisionCompareRule = PrecisionCompareRule.Inbound) extends Params with Product with Serializable

   Parameters for formatted number metric

   Parameters for formatted number metric

   precision

   Required number precision

   scale

   Required number scale

   compareRule

   Precision compare rule (whether number should fit to required precision and scale or not)

7.  final case class LevenshteinDistanceParams(threshold: Double, normalize: Boolean = false) extends Params with Product with Serializable

   Parameters for levenshteinDistance metric

   Parameters for levenshteinDistance metric

   threshold

   Maximum allowed levenshtein distance.

   normalize

   Boolean flag indicating whether levenshtein distance should be normalized. If true, then threshold must be in interval [0, 1]. Default: false

8.  final case class NumberCompareParams(compareValue: Double, includeBound: Boolean = false) extends Params with Product with Serializable

   Parameters for numberlessThan and numberGreaterThan metrics

   Parameters for numberlessThan and numberGreaterThan metrics

   compareValue

   Value to compare with

   includeBound

   Boolean flag indicating whether to include (less/greater than or equal to) or not (strict less/greater than) compareValue into allowed interval. Default: false

9.  final case class NumberDomainParams(domain: NonEmptyDoubleSeq) extends Params with Product with Serializable

   Parameters for number domain metric

   Parameters for number domain metric

   domain

   Sequence of string values that forms a domain

10.  final case class NumberIntervalParams(lowerCompareValue: Double, upperCompareValue: Double, includeBound: Boolean = false) extends Params with Product with Serializable

    Parameters for numberBetween and numberNotBetween metrics

    Parameters for numberBetween and numberNotBetween metrics

    lowerCompareValue

    Lower bound value to compare with

    upperCompareValue

    Upper bound value to compare with

    includeBound

    Boolean flag indicating whether to include (less/greater than or equal to) or not (strict less/greater than) bounds into allowed interval. Default: false

11.  final case class NumberValuesParams(compareValue: Double) extends Params with Product with Serializable

    Parameters for number values metric

    Parameters for number values metric

    compareValue

    Required number value

12.  sealed abstract class Params extends AnyRef

    Base class for metric parameters configurations

13.  final case class RegexParams(regex: RegexPattern) extends Params with Product with Serializable

    Parameters for regex match and mismatch metrics

    Parameters for regex match and mismatch metrics

    regex

    Regex pattern to check for match/mismatch

14.  final case class SequenceCompletenessParams(increment: PositiveInt = 1) extends Params with Product with Serializable

    Parameters for sequence completeness metric

    Parameters for sequence completeness metric

    increment

    sequence increment. Default: 1

15.  final case class StringDomainParams(domain: NonEmptyStringSeq) extends Params with Product with Serializable

    Parameters for string domain metric

    Parameters for string domain metric

    domain

    Sequence of string values that forms a domain

16.  final case class StringLengthParams(length: PositiveInt, compareRule: CompareRule) extends Params with Product with Serializable

    Parameters for string length metric

    Parameters for string length metric

    length

    Required string length

    compareRule

    Compare rule to use for metric calculation

17.  final case class StringValuesParams(compareValue: NonEmptyString) extends Params with Product with Serializable

    Parameters for string values metric

    Parameters for string values metric

    compareValue

    Required string value

18.  final case class TDigestGeqPercentileParams(accuracyError: AccuracyDouble = 0.005, target: Double) extends Params with Product with Serializable

    Parameters for TDigest getPercentile metric

    Parameters for TDigest getPercentile metric

    accuracyError

    Calculation accuracy error in interval [0,1] Default: 0.005

    target

    Arbitrary number from set of column values for which the percentile is calculated.

19.  final case class TDigestGeqQuantileParams(accuracyError: AccuracyDouble = 0.005, target: PercentileDouble) extends Params with Product with Serializable

    Parameters for TDigest getQuantile metric

    Parameters for TDigest getQuantile metric

    accuracyError

    Calculation accuracy error in interval [0,1] Default: 0.005

    target

    Required quantile to be calculated. Number in interval [0, 1]

20.  final case class TDigestParams(accuracyError: AccuracyDouble = 0.005) extends Params with Product with Serializable

    Parameters for TDigest metrics except getQuantile and geqPercentile

    Parameters for TDigest metrics except getQuantile and geqPercentile

    accuracyError

    Calculation accuracy error in interval [0,1] Default: 0.005

21.  final case class TopNParams(targetNumber: PositiveInt = 10, maxCapacity: PositiveInt = 100) extends Params with Product with Serializable

    Parameters for topN metric

    Parameters for topN metric

    targetNumber

    Required number of top values for search. Default: 10

    maxCapacity

    Maximum capacity of container for storing top values. Default: 100