Skip to content

GetIdMappingJobOutput

Source code in docs_src/capo_entityresolution/types/get_id_mapping_job_output.py
class GetIdMappingJobOutput(TypedDict, closed=True):
    job_id: "capo_entityresolution.types.job_id.JobId"
    """<p>The ID of the job.</p>"""
    status: "capo_entityresolution.types.job_status.JobStatus"
    """<p>The current status of the job.</p>"""
    start_time: "datetime.datetime"
    """<p>The time at which the job was started.</p>"""
    end_time: NotRequired["datetime.datetime"]
    """<p>The time at which the job has finished.</p>"""
    metrics: NotRequired[
        "capo_entityresolution.types.id_mapping_job_metrics.IdMappingJobMetrics"
    ]
    """<p>Metrics associated with the execution, specifically total records processed, unique IDs generated, and records the execution skipped.</p>"""
    error_details: NotRequired["capo_entityresolution.types.error_details.ErrorDetails"]
    output_source_config: NotRequired[
        "capo_entityresolution.types.id_mapping_job_output_source_config.IdMappingJobOutputSourceConfig"
    ]
    """<p>A list of <code>OutputSource</code> objects.</p>"""
    job_type: NotRequired["capo_entityresolution.types.job_type.JobType"]
    """<p> The job type of the ID mapping job.</p> <p>A value of <code>INCREMENTAL</code> indicates that only new or changed data was processed since the last job run. This is the default job type if the workflow was created with an <code>incrementalRunConfig</code>.</p> <p>A value of <code>BATCH</code> indicates that all data was processed from the input source, regardless of previous job runs. This is the default job type if the workflow wasn't created with an <code>incrementalRunConfig</code>.</p> <p>A value of <code>DELETE_ONLY</code> indicates that only deletion requests from <code>BatchDeleteUniqueIds</code> were processed.</p>"""

end_time instance-attribute

end_time: NotRequired[datetime]

The time at which the job has finished.

error_details instance-attribute

error_details: NotRequired[ErrorDetails]

job_id instance-attribute

job_id: JobId

The ID of the job.

job_type instance-attribute

job_type: NotRequired[JobType]

The job type of the ID mapping job.

A value of INCREMENTAL indicates that only new or changed data was processed since the last job run. This is the default job type if the workflow was created with an incrementalRunConfig.

A value of BATCH indicates that all data was processed from the input source, regardless of previous job runs. This is the default job type if the workflow wasn't created with an incrementalRunConfig.

A value of DELETE_ONLY indicates that only deletion requests from BatchDeleteUniqueIds were processed.

metrics instance-attribute

metrics: NotRequired[IdMappingJobMetrics]

Metrics associated with the execution, specifically total records processed, unique IDs generated, and records the execution skipped.

output_source_config instance-attribute

output_source_config: NotRequired[IdMappingJobOutputSourceConfig]

A list of OutputSource objects.

start_time instance-attribute

start_time: datetime

The time at which the job was started.

status instance-attribute

status: JobStatus

The current status of the job.