Skip to content

StatisticSummary

Source code in docs_src/capo_glue/types/statistic_summary.py
class StatisticSummary(TypedDict, closed=True):
    statistic_id: NotRequired["capo_glue.types.hash_string.HashString"]
    """<p>The Statistic ID.</p>"""
    profile_id: NotRequired["capo_glue.types.hash_string.HashString"]
    """<p>The Profile ID.</p>"""
    run_identifier: NotRequired["capo_glue.types.run_identifier.RunIdentifier"]
    """<p>The Run Identifier</p>"""
    statistic_name: NotRequired[
        "capo_glue.types.statistic_name_string.StatisticNameString"
    ]
    """<p>The name of the statistic.</p>"""
    double_value: "capo_glue.types.double.Double"
    """<p>The value of the statistic.</p>"""
    distribution_value: NotRequired[
        "capo_glue.types.distribution_data.DistributionData"
    ]
    """<p>The distribution value for the statistic.</p>"""
    evaluation_level: NotRequired[
        "capo_glue.types.statistic_evaluation_level.StatisticEvaluationLevel"
    ]
    """<p>The evaluation level of the statistic. Possible values: <code>Dataset</code>, <code>Column</code>, <code>Multicolumn</code>.</p>"""
    columns_referenced: NotRequired["capo_glue.types.column_name_list.ColumnNameList"]
    """<p>The list of columns referenced by the statistic.</p>"""
    referenced_datasets: NotRequired[
        "capo_glue.types.reference_datasets_list.ReferenceDatasetsList"
    ]
    """<p>The list of datasets referenced by the statistic.</p>"""
    statistic_properties: NotRequired[
        "capo_glue.types.statistic_properties_map.StatisticPropertiesMap"
    ]
    """<p>A <code>StatisticPropertiesMap</code>, which contains a <code>NameString</code> and <code>DescriptionString</code> </p>"""
    recorded_on: NotRequired["capo_glue.types.timestamp.Timestamp"]
    """<p>The timestamp when the statistic was recorded.</p>"""
    inclusion_annotation: NotRequired[
        "capo_glue.types.timestamped_inclusion_annotation.TimestampedInclusionAnnotation"
    ]
    """<p>The inclusion annotation for the statistic.</p>"""

columns_referenced instance-attribute

columns_referenced: NotRequired[ColumnNameList]

The list of columns referenced by the statistic.

distribution_value instance-attribute

distribution_value: NotRequired[DistributionData]

The distribution value for the statistic.

double_value instance-attribute

double_value: Double

The value of the statistic.

evaluation_level instance-attribute

evaluation_level: NotRequired[StatisticEvaluationLevel]

The evaluation level of the statistic. Possible values: Dataset, Column, Multicolumn.

inclusion_annotation instance-attribute

inclusion_annotation: NotRequired[TimestampedInclusionAnnotation]

The inclusion annotation for the statistic.

profile_id instance-attribute

profile_id: NotRequired[HashString]

The Profile ID.

recorded_on instance-attribute

recorded_on: NotRequired[Timestamp]

The timestamp when the statistic was recorded.

referenced_datasets instance-attribute

referenced_datasets: NotRequired[ReferenceDatasetsList]

The list of datasets referenced by the statistic.

run_identifier instance-attribute

run_identifier: NotRequired[RunIdentifier]

The Run Identifier

statistic_id instance-attribute

statistic_id: NotRequired[HashString]

The Statistic ID.

statistic_name instance-attribute

statistic_name: NotRequired[StatisticNameString]

The name of the statistic.

statistic_properties instance-attribute

statistic_properties: NotRequired[StatisticPropertiesMap]

A StatisticPropertiesMap, which contains a NameString and DescriptionString