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

DataSourceSyncJob

class DataSourceSyncJob

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

Types

Builder

class Builder

Companion

object Companion

Properties

dataSourceErrorCode

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.

endTime

val endTime: Instant?

The Unix timestamp when the synchronization job completed.

error

val error: ErrorDetail?

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

executionId

val executionId: String?

The identifier of a data source synchronization job.

metrics

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.

startTime

val startTime: Instant?

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

status

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

copy

inline fun copy(block: DataSourceSyncJob.Builder.() -> Unit = {}): DataSourceSyncJob

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String