Skip to content

DataQualityResultV2Item

Source code in docs_src/capo_glue/types/data_quality_result_v2_item.py
class DataQualityResultV2Item(TypedDict, closed=True):
    result_id: "capo_glue.types.hash_string.HashString"
    """<p>A unique result ID for the data quality result.</p>"""
    data_source: NotRequired["capo_glue.types.data_source.DataSource"]
    """<p>The table associated with the data quality result, if any.</p>"""
    dimensions: NotRequired[
        "capo_glue.types.publish_data_quality_result_dimensions.PublishDataQualityResultDimensions"
    ]
    """<p>A map of platform-specific identifiers, such as cluster, application, workgroup, or project IDs, that identify where the data quality evaluation ran.</p>"""
    tags: NotRequired[
        "capo_glue.types.publish_data_quality_result_tags.PublishDataQualityResultTags"
    ]
    """<p>A map of tags associated with the data quality result.</p>"""
    execution_started_on: NotRequired["capo_glue.types.timestamp.Timestamp"]
    """<p>The date and time when this data quality run started.</p>"""
    execution_completed_on: NotRequired["capo_glue.types.timestamp.Timestamp"]
    """<p>The date and time when this data quality run completed.</p>"""
    result_published_on: NotRequired["capo_glue.types.timestamp.Timestamp"]
    """<p>The date and time when this data quality result was published.</p>"""
    score: NotRequired["capo_glue.types.generic_bounded_double.GenericBoundedDouble"]
    """<p>An aggregate data quality score. Represents the ratio of rules that passed to the total number of rules.</p>"""
    rule_results: NotRequired[
        "capo_glue.types.data_quality_rule_results.DataQualityRuleResults"
    ]
    """<p>A list of <code>DataQualityRuleResult</code> objects representing the results for each rule.</p>"""
    analyzer_results: NotRequired[
        "capo_glue.types.data_quality_analyzer_results.DataQualityAnalyzerResults"
    ]
    """<p>A list of <code>DataQualityAnalyzerResult</code> objects representing the results for each analyzer.</p>"""
    observations: NotRequired[
        "capo_glue.types.data_quality_observations.DataQualityObservations"
    ]
    """<p>A list of <code>DataQualityObservation</code> objects representing the anomaly detection observations generated after evaluating the rules and analyzers.</p>"""
    evaluation_context: NotRequired["capo_glue.types.name_string.NameString"]
    """<p>The evaluation context for the data quality result. This value identifies a specific data quality result, or a series of related results, within a run.</p>"""
    descriptors: NotRequired[
        "capo_glue.types.publish_data_quality_result_descriptors.PublishDataQualityResultDescriptors"
    ]
    """<p>A map of user-provided descriptors that add contextual metadata and configuration to the data quality result, such as database name, table name, team, or environment.</p>"""
    aggregated_metrics: NotRequired[
        "capo_glue.types.data_quality_aggregated_metrics.DataQualityAggregatedMetrics"
    ]
    """<p>A summary of <code>DataQualityAggregatedMetrics</code> objects showing the total counts of processed rows and rules, including their pass/fail statistics based on row-level results.</p>"""
    ruleset_name: NotRequired["capo_glue.types.name_string.NameString"]
    """<p>The name of the ruleset associated with the data quality result.</p>"""

aggregated_metrics instance-attribute

aggregated_metrics: NotRequired[DataQualityAggregatedMetrics]

A summary of DataQualityAggregatedMetrics objects showing the total counts of processed rows and rules, including their pass/fail statistics based on row-level results.

analyzer_results instance-attribute

analyzer_results: NotRequired[DataQualityAnalyzerResults]

A list of DataQualityAnalyzerResult objects representing the results for each analyzer.

data_source instance-attribute

data_source: NotRequired[DataSource]

The table associated with the data quality result, if any.

descriptors instance-attribute

descriptors: NotRequired[PublishDataQualityResultDescriptors]

A map of user-provided descriptors that add contextual metadata and configuration to the data quality result, such as database name, table name, team, or environment.

dimensions instance-attribute

dimensions: NotRequired[PublishDataQualityResultDimensions]

A map of platform-specific identifiers, such as cluster, application, workgroup, or project IDs, that identify where the data quality evaluation ran.

evaluation_context instance-attribute

evaluation_context: NotRequired[NameString]

The evaluation context for the data quality result. This value identifies a specific data quality result, or a series of related results, within a run.

execution_completed_on instance-attribute

execution_completed_on: NotRequired[Timestamp]

The date and time when this data quality run completed.

execution_started_on instance-attribute

execution_started_on: NotRequired[Timestamp]

The date and time when this data quality run started.

observations instance-attribute

observations: NotRequired[DataQualityObservations]

A list of DataQualityObservation objects representing the anomaly detection observations generated after evaluating the rules and analyzers.

result_id instance-attribute

result_id: HashString

A unique result ID for the data quality result.

result_published_on instance-attribute

result_published_on: NotRequired[Timestamp]

The date and time when this data quality result was published.

rule_results instance-attribute

rule_results: NotRequired[DataQualityRuleResults]

A list of DataQualityRuleResult objects representing the results for each rule.

ruleset_name instance-attribute

ruleset_name: NotRequired[NameString]

The name of the ruleset associated with the data quality result.

score instance-attribute

score: NotRequired[GenericBoundedDouble]

An aggregate data quality score. Represents the ratio of rules that passed to the total number of rules.

tags instance-attribute

tags: NotRequired[PublishDataQualityResultTags]

A map of tags associated with the data quality result.