Skip to content

DataSourceSyncJob

Source code in docs_src/capo_qbusiness/types/data_source_sync_job.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
class DataSourceSyncJob(TypedDict, closed=True):
    execution_id: NotRequired["capo_qbusiness.types.execution_id.ExecutionId"]
    """<p>The identifier of a data source synchronization job.</p>"""
    start_time: NotRequired["capo_qbusiness.types.timestamp.Timestamp"]
    """<p>The Unix time stamp when the data source synchronization job started.</p>"""
    end_time: NotRequired["capo_qbusiness.types.timestamp.Timestamp"]
    """<p>The Unix timestamp when the synchronization job completed.</p>"""
    status: NotRequired[
        "capo_qbusiness.types.data_source_sync_job_status.DataSourceSyncJobStatus"
    ]
    """<p>The status of the synchronization job. When the <code>Status</code> field is set to <code>SUCCEEDED</code>, the synchronization job is done. If the status code is <code>FAILED</code>, the <code>ErrorCode</code> and <code>ErrorMessage</code> fields give you the reason for the failure.</p>"""
    error: NotRequired["capo_qbusiness.types.error_detail.ErrorDetail"]
    """<p>If the <code>Status</code> field is set to <code>FAILED</code>, the <code>ErrorCode</code> field indicates the reason the synchronization failed. </p>"""
    data_source_error_code: NotRequired["capo_qbusiness.types.string.String"]
    """<p>If the reason that the synchronization failed is due to an error with the underlying data source, this field contains a code that identifies the error.</p>"""
    metrics: NotRequired[
        "capo_qbusiness.types.data_source_sync_job_metrics.DataSourceSyncJobMetrics"
    ]
    """<p>Maps a batch delete document request to a specific data source sync job. This is optional and should only be supplied when documents are deleted by a data source connector.</p>"""

data_source_error_code instance-attribute 

data_source_error_code: NotRequired[String]

If the reason that the synchronization failed is due to an error with the underlying data source, this field contains a code that identifies the error.

end_time instance-attribute 

end_time: NotRequired[Timestamp]

The Unix timestamp when the synchronization job completed.

error instance-attribute 

error: NotRequired[ErrorDetail]

If the Status field is set to FAILED, the ErrorCode field indicates the reason the synchronization failed.

execution_id instance-attribute 

execution_id: NotRequired[ExecutionId]

The identifier of a data source synchronization job.

metrics instance-attribute 

metrics: NotRequired[DataSourceSyncJobMetrics]

Maps a batch delete document request to a specific data source sync job. This is optional and should only be supplied when documents are deleted by a data source connector.

start_time instance-attribute 

start_time: NotRequired[Timestamp]

The Unix time stamp when the data source synchronization job started.

status instance-attribute 

status: NotRequired[DataSourceSyncJobStatus]

The status of the synchronization job. When the Status field is set to SUCCEEDED, the synchronization job is done. If the status code is FAILED, the ErrorCode and ErrorMessage fields give you the reason for the failure.