/AWS1/CL_QQBDATASOURCESYNCJOB

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

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_executionid TYPE /AWS1/QQBEXECUTIONID /AWS1/QQBEXECUTIONID

The identifier of a data source synchronization job.

iv_starttime TYPE /AWS1/QQBTIMESTAMP /AWS1/QQBTIMESTAMP

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

iv_endtime TYPE /AWS1/QQBTIMESTAMP /AWS1/QQBTIMESTAMP

The Unix timestamp when the synchronization job completed.

iv_status TYPE /AWS1/QQBDATASRCSYNCJOBSTATUS /AWS1/QQBDATASRCSYNCJOBSTATUS

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.

io_error TYPE REF TO /AWS1/CL_QQBERRORDETAIL /AWS1/CL_QQBERRORDETAIL

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

iv_datasourceerrorcode TYPE /AWS1/QQBSTRING /AWS1/QQBSTRING

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.

io_metrics TYPE REF TO /AWS1/CL_QQBDATASRCSYNCJOBMET /AWS1/CL_QQBDATASRCSYNCJOBMET

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.

---

Queryable Attributes

executionId

The identifier of a data source synchronization job.

Accessible with the following methods

Method	Description
GET_EXECUTIONID()	Getter for EXECUTIONID, with configurable default
ASK_EXECUTIONID()	Getter for EXECUTIONID w/ exceptions if field has no value
HAS_EXECUTIONID()	Determine if EXECUTIONID has a value

startTime

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

Accessible with the following methods

Method	Description
GET_STARTTIME()	Getter for STARTTIME, with configurable default
ASK_STARTTIME()	Getter for STARTTIME w/ exceptions if field has no value
HAS_STARTTIME()	Determine if STARTTIME has a value

endTime

The Unix timestamp when the synchronization job completed.

Accessible with the following methods

Method	Description
GET_ENDTIME()	Getter for ENDTIME, with configurable default
ASK_ENDTIME()	Getter for ENDTIME w/ exceptions if field has no value
HAS_ENDTIME()	Determine if ENDTIME has a value

status

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.

Accessible with the following methods

Method	Description
GET_STATUS()	Getter for STATUS, with configurable default
ASK_STATUS()	Getter for STATUS w/ exceptions if field has no value
HAS_STATUS()	Determine if STATUS has a value

error

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

Accessible with the following methods

Method	Description
GET_ERROR()	Getter for ERROR

dataSourceErrorCode

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.

Accessible with the following methods

Method	Description
GET_DATASOURCEERRORCODE()	Getter for DATASOURCEERRORCODE, with configurable default
ASK_DATASOURCEERRORCODE()	Getter for DATASOURCEERRORCODE w/ exceptions if field has no
HAS_DATASOURCEERRORCODE()	Determine if DATASOURCEERRORCODE has a value

metrics

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.

Accessible with the following methods

Method	Description
GET_METRICS()	Getter for METRICS

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_DATASOURCESYNCJOBS

TYPES TT_DATASOURCESYNCJOBS TYPE STANDARD TABLE OF REF TO /AWS1/CL_QQBDATASOURCESYNCJOB WITH DEFAULT KEY
.