/AWS1/CL_KNDDATASOURCESYNCJOB

Provides information about a data source synchronization job.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_executionid TYPE /AWS1/KNDSTRING /AWS1/KNDSTRING

A identifier for the synchronization job.

iv_starttime TYPE /AWS1/KNDTIMESTAMP /AWS1/KNDTIMESTAMP

The Unix timestamp when the synchronization job started.

iv_endtime TYPE /AWS1/KNDTIMESTAMP /AWS1/KNDTIMESTAMP

The Unix timestamp when the synchronization job completed.

iv_status TYPE /AWS1/KNDDATASRCSYNCJOBSTATUS /AWS1/KNDDATASRCSYNCJOBSTATUS

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

iv_errormessage TYPE /AWS1/KNDERRORMESSAGE /AWS1/KNDERRORMESSAGE

If the Status field is set to ERROR, the ErrorMessage field contains a description of the error that caused the synchronization to fail.

iv_errorcode TYPE /AWS1/KNDERRORCODE /AWS1/KNDERRORCODE

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

iv_datasourceerrorcode TYPE /AWS1/KNDSTRING /AWS1/KNDSTRING

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_KNDDATASRCSYNCJOBMET /AWS1/CL_KNDDATASRCSYNCJOBMET

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

A identifier for the 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 timestamp when the 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 execution status of the synchronization job. When the Status field is set to SUCCEEDED, the synchronization job is done. If the status code is set to 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

ErrorMessage

If the Status field is set to ERROR, the ErrorMessage field contains a description of the error that caused the synchronization to fail.

Accessible with the following methods

Method	Description
GET_ERRORMESSAGE()	Getter for ERRORMESSAGE, with configurable default
ASK_ERRORMESSAGE()	Getter for ERRORMESSAGE w/ exceptions if field has no value
HAS_ERRORMESSAGE()	Determine if ERRORMESSAGE has a value

ErrorCode

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_ERRORCODE()	Getter for ERRORCODE, with configurable default
ASK_ERRORCODE()	Getter for ERRORCODE w/ exceptions if field has no value
HAS_ERRORCODE()	Determine if ERRORCODE has a value

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_DATASRCSYNCJOBHISTORYLIST

TYPES TT_DATASRCSYNCJOBHISTORYLIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_KNDDATASOURCESYNCJOB WITH DEFAULT KEY
.