Skip to content

GetUploadJobResponse

Source code in docs_src/capo_customer_profiles/types/get_upload_job_response.py
class GetUploadJobResponse(TypedDict, closed=True):
    job_id: NotRequired["capo_customer_profiles.types.uuid.uuid"]
    """<p>The unique identifier of the upload job. </p>"""
    display_name: NotRequired["capo_customer_profiles.types.string1_to255.string1To255"]
    """<p>The unique name of the upload job. Could be a file name to identify the upload job. </p>"""
    status: NotRequired[
        "capo_customer_profiles.types.upload_job_status.UploadJobStatus"
    ]
    """<p>The status describing the status for the upload job. The following are Valid Values: </p> <ul> <li> <p> <b>CREATED</b>: The upload job has been created, but has not started processing yet. </p> </li> <li> <p> <b>IN_PROGRESS</b>: The upload job is currently in progress, ingesting and processing the profile data. </p> </li> <li> <p> <b>PARTIALLY_SUCCEEDED</b>: The upload job has successfully completed the ingestion and processing of all profile data. </p> </li> <li> <p> <b>SUCCEEDED</b>: The upload job has successfully completed the ingestion and processing of all profile data. </p> </li> <li> <p> <b>FAILED</b>: The upload job has failed to complete. </p> </li> <li> <p> <b>STOPPED</b>: The upload job has been manually stopped or terminated before completion. </p> </li> </ul>"""
    status_reason: NotRequired[
        "capo_customer_profiles.types.status_reason.StatusReason"
    ]
    """<p>The reason for the current status of the upload job. Possible reasons: </p> <ul> <li> <p> <b>VALIDATION_FAILURE</b>: The upload job has encountered an error or issue and was unable to complete the profile data ingestion. </p> </li> <li> <p> <b>INTERNAL_FAILURE</b>: Failure caused from service side </p> </li> </ul>"""
    created_at: NotRequired["capo_customer_profiles.types.timestamp.timestamp"]
    """<p>The timestamp when the upload job was created. </p>"""
    completed_at: NotRequired["capo_customer_profiles.types.timestamp.timestamp"]
    """<p>The timestamp when the upload job was completed. </p>"""
    fields: NotRequired["capo_customer_profiles.types.field_map.FieldMap"]
    """<p>The mapping between CSV Columns and Profile Object attributes for the upload job. </p>"""
    unique_key: NotRequired["capo_customer_profiles.types.text.text"]
    """<p>The unique key columns used for de-duping the keys in the upload job. </p>"""
    results_summary: NotRequired[
        "capo_customer_profiles.types.results_summary.ResultsSummary"
    ]
    """<p>The summary of results for the upload job, including the number of updated, created, and failed records. </p>"""
    data_expiry: NotRequired[
        "capo_customer_profiles.types.expiration_days_integer.expirationDaysInteger"
    ]
    """<p>The expiry duration for the profiles ingested with the upload job. </p>"""

completed_at instance-attribute

completed_at: NotRequired[timestamp]

The timestamp when the upload job was completed.

created_at instance-attribute

created_at: NotRequired[timestamp]

The timestamp when the upload job was created.

data_expiry instance-attribute

data_expiry: NotRequired[expirationDaysInteger]

The expiry duration for the profiles ingested with the upload job.

display_name instance-attribute

display_name: NotRequired[string1To255]

The unique name of the upload job. Could be a file name to identify the upload job.

fields instance-attribute

fields: NotRequired[FieldMap]

The mapping between CSV Columns and Profile Object attributes for the upload job.

job_id instance-attribute

job_id: NotRequired[uuid]

The unique identifier of the upload job.

results_summary instance-attribute

results_summary: NotRequired[ResultsSummary]

The summary of results for the upload job, including the number of updated, created, and failed records.

status instance-attribute

status: NotRequired[UploadJobStatus]

The status describing the status for the upload job. The following are Valid Values:

  • CREATED: The upload job has been created, but has not started processing yet.

  • IN_PROGRESS: The upload job is currently in progress, ingesting and processing the profile data.

  • PARTIALLY_SUCCEEDED: The upload job has successfully completed the ingestion and processing of all profile data.

  • SUCCEEDED: The upload job has successfully completed the ingestion and processing of all profile data.

  • FAILED: The upload job has failed to complete.

  • STOPPED: The upload job has been manually stopped or terminated before completion.

status_reason instance-attribute

status_reason: NotRequired[StatusReason]

The reason for the current status of the upload job. Possible reasons:

  • VALIDATION_FAILURE: The upload job has encountered an error or issue and was unable to complete the profile data ingestion.

  • INTERNAL_FAILURE: Failure caused from service side

unique_key instance-attribute

unique_key: NotRequired[text]

The unique key columns used for de-duping the keys in the upload job.