qbusiness/aws.sdk.kotlin.services.qbusiness.model/DataSourceSyncJob

DataSourceSyncJob

class DataSourceSyncJob

Provides information about an Amazon Q data source connector synchronization job.

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val dataSourceErrorCode: 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.

Link copied to clipboard
val endTime: Instant?

The Unix timestamp when the synchronization job completed.

Link copied to clipboard
val error: ErrorDetail?

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

Link copied to clipboard
val executionId: String?

The identifier of a data source synchronization job.

Link copied to clipboard
val metrics: 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.

Link copied to clipboard
val startTime: Instant?

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

Link copied to clipboard
val status: 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.

Functions

Link copied to clipboard
inline fun copy(block: DataSourceSyncJob.Builder.() -> Unit = {}): DataSourceSyncJob
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String