Class DatascanDataQualitySpecRule


  • public final class DatascanDataQualitySpecRule
    extends java.lang.Object
    • Method Detail

      • column

        public java.util.Optional<java.lang.String> column()
        Returns:
        The unnested column which this rule is evaluated against.
      • description

        public java.util.Optional<java.lang.String> description()
        Returns:
        Description of the rule. The maximum length is 1,024 characters.
      • dimension

        public java.lang.String dimension()
        Returns:
        The dimension a rule belongs to. Results are also aggregated at the dimension level. Supported dimensions are ["COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "INTEGRITY"]
      • ignoreNull

        public java.util.Optional<java.lang.Boolean> ignoreNull()
        Returns:
        Rows with null values will automatically fail a rule, unless ignoreNull is true. In that case, such null rows are trivially considered passing. Only applicable to ColumnMap rules.
      • name

        public java.util.Optional<java.lang.String> name()
        Returns:
        A mutable name for the rule. The name must contain only letters (a-z, A-Z), numbers (0-9), or hyphens (-). The maximum length is 63 characters. Must start with a letter. Must end with a number or a letter.
      • rangeExpectation

        public java.util.Optional<DatascanDataQualitySpecRuleRangeExpectation> rangeExpectation()
        Returns:
        ColumnMap rule which evaluates whether each column value lies between a specified range. Structure is documented below.
      • regexExpectation

        public java.util.Optional<DatascanDataQualitySpecRuleRegexExpectation> regexExpectation()
        Returns:
        ColumnMap rule which evaluates whether each column value matches a specified regex. Structure is documented below.
      • setExpectation

        public java.util.Optional<DatascanDataQualitySpecRuleSetExpectation> setExpectation()
        Returns:
        ColumnMap rule which evaluates whether each column value is contained by a specified set. Structure is documented below.
      • statisticRangeExpectation

        public java.util.Optional<DatascanDataQualitySpecRuleStatisticRangeExpectation> statisticRangeExpectation()
        Returns:
        ColumnAggregate rule which evaluates whether the column aggregate statistic lies between a specified range. Structure is documented below.
      • threshold

        public java.util.Optional<java.lang.Double> threshold()
        Returns:
        The minimum ratio of passing_rows / total_rows required to pass this rule, with a range of [0.0, 1.0]. 0 indicates default value (i.e. 1.0).