Skip to content

IdMappingJobMetrics

Source code in docs_src/capo_entityresolution/types/id_mapping_job_metrics.py
class IdMappingJobMetrics(TypedDict, closed=True):
    input_records: NotRequired["int"]
    """<p>The total number of records that were input for processing.</p>"""
    total_records_processed: NotRequired["int"]
    """<p>The total number of records that were processed.</p>"""
    records_not_processed: NotRequired["int"]
    """<p>The total number of records that did not get processed.</p>"""
    delete_records_processed: NotRequired["int"]
    """<p>The number of records processed that were marked for deletion in the input file using the DELETE schema mapping field. These are the records to be removed from the ID mapping table.</p>"""
    total_mapped_records: NotRequired["int"]
    """<p> The total number of records that were mapped.</p>"""
    total_mapped_source_records: NotRequired["int"]
    """<p> The total number of mapped source records.</p>"""
    total_mapped_target_records: NotRequired["int"]
    """<p> The total number of distinct mapped target records.</p>"""
    unique_records_loaded: NotRequired["int"]
    """<p>The number of de-duplicated processed records across all runs, excluding deletion-related records. Duplicates are determined by the field marked as UNIQUE_ID in your schema mapping. Records sharing the same value in this field are considered duplicates. For example, if you specified "customer_id" as a UNIQUE_ID field and had three records with the same customer_id value, they would count as one unique record in this metric. </p>"""
    new_mapped_records: NotRequired["int"]
    """<p> The number of new mapped records.</p>"""
    new_mapped_source_records: NotRequired["int"]
    """<p> The number of new source records mapped.</p>"""
    new_mapped_target_records: NotRequired["int"]
    """<p> The number of new mapped target records.</p>"""
    new_unique_records_loaded: NotRequired["int"]
    """<p>The number of new unique records processed in the current job run, after removing duplicates. This metric excludes deletion-related records. Duplicates are determined by the field marked as UNIQUE_ID in your schema mapping. Records sharing the same value in this field are considered duplicates. For example, if your current run processes five new records with the same UNIQUE_ID value, they would count as one new unique record in this metric.</p>"""
    mapped_records_removed: NotRequired["int"]
    """<p> The number of mapped records removed.</p>"""
    mapped_source_records_removed: NotRequired["int"]
    """<p> The number of source records removed due to ID mapping.</p>"""
    mapped_target_records_removed: NotRequired["int"]
    """<p> The number of mapped target records removed.</p>"""

delete_records_processed instance-attribute

delete_records_processed: NotRequired[int]

The number of records processed that were marked for deletion in the input file using the DELETE schema mapping field. These are the records to be removed from the ID mapping table.

input_records instance-attribute

input_records: NotRequired[int]

The total number of records that were input for processing.

mapped_records_removed instance-attribute

mapped_records_removed: NotRequired[int]

The number of mapped records removed.

mapped_source_records_removed instance-attribute

mapped_source_records_removed: NotRequired[int]

The number of source records removed due to ID mapping.

mapped_target_records_removed instance-attribute

mapped_target_records_removed: NotRequired[int]

The number of mapped target records removed.

new_mapped_records instance-attribute

new_mapped_records: NotRequired[int]

The number of new mapped records.

new_mapped_source_records instance-attribute

new_mapped_source_records: NotRequired[int]

The number of new source records mapped.

new_mapped_target_records instance-attribute

new_mapped_target_records: NotRequired[int]

The number of new mapped target records.

new_unique_records_loaded instance-attribute

new_unique_records_loaded: NotRequired[int]

The number of new unique records processed in the current job run, after removing duplicates. This metric excludes deletion-related records. Duplicates are determined by the field marked as UNIQUE_ID in your schema mapping. Records sharing the same value in this field are considered duplicates. For example, if your current run processes five new records with the same UNIQUE_ID value, they would count as one new unique record in this metric.

records_not_processed instance-attribute

records_not_processed: NotRequired[int]

The total number of records that did not get processed.

total_mapped_records instance-attribute

total_mapped_records: NotRequired[int]

The total number of records that were mapped.

total_mapped_source_records instance-attribute

total_mapped_source_records: NotRequired[int]

The total number of mapped source records.

total_mapped_target_records instance-attribute

total_mapped_target_records: NotRequired[int]

The total number of distinct mapped target records.

total_records_processed instance-attribute

total_records_processed: NotRequired[int]

The total number of records that were processed.

unique_records_loaded instance-attribute

unique_records_loaded: NotRequired[int]

The number of de-duplicated processed records across all runs, excluding deletion-related records. Duplicates are determined by the field marked as UNIQUE_ID in your schema mapping. Records sharing the same value in this field are considered duplicates. For example, if you specified "customer_id" as a UNIQUE_ID field and had three records with the same customer_id value, they would count as one unique record in this metric.