Skip to content

DataQualityRuleResult

Source code in docs_src/capo_glue/types/data_quality_rule_result.py
class DataQualityRuleResult(TypedDict, closed=True):
    name: NotRequired["capo_glue.types.name_string.NameString"]
    """<p>The name of the data quality rule.</p>"""
    description: NotRequired[
        "capo_glue.types.data_quality_rule_result_description.DataQualityRuleResultDescription"
    ]
    """<p>A description of the data quality rule.</p>"""
    evaluation_message: NotRequired[
        "capo_glue.types.data_quality_rule_result_description.DataQualityRuleResultDescription"
    ]
    """<p>An evaluation message.</p>"""
    result: NotRequired[
        "capo_glue.types.data_quality_rule_result_status.DataQualityRuleResultStatus"
    ]
    """<p>A pass or fail status for the rule.</p>"""
    evaluated_metrics: NotRequired[
        "capo_glue.types.evaluated_metrics_map.EvaluatedMetricsMap"
    ]
    """<p>A map of metrics associated with the evaluation of the rule.</p>"""
    evaluated_rule: NotRequired[
        "capo_glue.types.data_quality_rule_result_description.DataQualityRuleResultDescription"
    ]
    """<p>The evaluated rule.</p>"""
    rule_metrics: NotRequired["capo_glue.types.rule_metrics_map.RuleMetricsMap"]
    """<p>A map containing metrics associated with the evaluation of the rule based on row-level results. </p>"""
    labels: NotRequired["capo_glue.types.labels.Labels"]
    """<p>A map containing labels assigned to the data quality rule. </p>"""

description instance-attribute

description: NotRequired[DataQualityRuleResultDescription]

A description of the data quality rule.

evaluated_metrics instance-attribute

evaluated_metrics: NotRequired[EvaluatedMetricsMap]

A map of metrics associated with the evaluation of the rule.

evaluated_rule instance-attribute

evaluated_rule: NotRequired[DataQualityRuleResultDescription]

The evaluated rule.

evaluation_message instance-attribute

evaluation_message: NotRequired[DataQualityRuleResultDescription]

An evaluation message.

labels instance-attribute

labels: NotRequired[Labels]

A map containing labels assigned to the data quality rule.

name instance-attribute

name: NotRequired[NameString]

The name of the data quality rule.

result instance-attribute

result: NotRequired[DataQualityRuleResultStatus]

A pass or fail status for the rule.

rule_metrics instance-attribute

rule_metrics: NotRequired[RuleMetricsMap]

A map containing metrics associated with the evaluation of the rule based on row-level results.