/AWS1/CL_BDADATASOURCE¶
Contains details about a data source.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
IV_KNOWLEDGEBASEID TYPE /AWS1/BDAID /AWS1/BDAID¶
The unique identifier of the knowledge base to which the data source belongs.
IV_DATASOURCEID TYPE /AWS1/BDAID /AWS1/BDAID¶
The unique identifier of the data source.
IV_NAME TYPE /AWS1/BDANAME /AWS1/BDANAME¶
The name of the data source.
IV_STATUS TYPE /AWS1/BDADATASOURCESTATUS /AWS1/BDADATASOURCESTATUS¶
The status of the data source. The following statuses are possible:
Available – The data source has been created and is ready for ingestion into the knowledge base.
Deleting – The data source is being deleted.
IO_DATASOURCECONFIGURATION TYPE REF TO /AWS1/CL_BDADATASOURCECONF /AWS1/CL_BDADATASOURCECONF¶
The connection configuration for the data source.
IV_CREATEDAT TYPE /AWS1/BDADATETIMESTAMP /AWS1/BDADATETIMESTAMP¶
The time at which the data source was created.
IV_UPDATEDAT TYPE /AWS1/BDADATETIMESTAMP /AWS1/BDADATETIMESTAMP¶
The time at which the data source was last updated.
Optional arguments:¶
IV_DESCRIPTION TYPE /AWS1/BDADESCRIPTION /AWS1/BDADESCRIPTION¶
The description of the data source.
IO_SERVERSIDEENCRYPTIONCONF TYPE REF TO /AWS1/CL_BDASERVERSIDEENCCONF /AWS1/CL_BDASERVERSIDEENCCONF¶
Contains details about the configuration of the server-side encryption.
IO_VECTORINGESTIONCONF TYPE REF TO /AWS1/CL_BDAVECTORINGESTIONC00 /AWS1/CL_BDAVECTORINGESTIONC00¶
Contains details about how to ingest the documents in the data source.
IV_DATADELETIONPOLICY TYPE /AWS1/BDADATADELETIONPOLICY /AWS1/BDADATADELETIONPOLICY¶
The data deletion policy for the data source.
IT_FAILUREREASONS TYPE /AWS1/CL_BDAFAILUREREASONS_W=>TT_FAILUREREASONS TT_FAILUREREASONS¶
The detailed reasons on the failure to delete a data source.
Queryable Attributes¶
knowledgeBaseId¶
The unique identifier of the knowledge base to which the data source belongs.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_KNOWLEDGEBASEID() |
Getter for KNOWLEDGEBASEID, with configurable default |
ASK_KNOWLEDGEBASEID() |
Getter for KNOWLEDGEBASEID w/ exceptions if field has no val |
HAS_KNOWLEDGEBASEID() |
Determine if KNOWLEDGEBASEID has a value |
dataSourceId¶
The unique identifier of the data source.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DATASOURCEID() |
Getter for DATASOURCEID, with configurable default |
ASK_DATASOURCEID() |
Getter for DATASOURCEID w/ exceptions if field has no value |
HAS_DATASOURCEID() |
Determine if DATASOURCEID has a value |
name¶
The name of the data source.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NAME() |
Getter for NAME, with configurable default |
ASK_NAME() |
Getter for NAME w/ exceptions if field has no value |
HAS_NAME() |
Determine if NAME has a value |
status¶
The status of the data source. The following statuses are possible:
Available – The data source has been created and is ready for ingestion into the knowledge base.
Deleting – The data source is being deleted.
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 |
description¶
The description of the data source.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DESCRIPTION() |
Getter for DESCRIPTION, with configurable default |
ASK_DESCRIPTION() |
Getter for DESCRIPTION w/ exceptions if field has no value |
HAS_DESCRIPTION() |
Determine if DESCRIPTION has a value |
dataSourceConfiguration¶
The connection configuration for the data source.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DATASOURCECONFIGURATION() |
Getter for DATASOURCECONFIGURATION |
serverSideEncryptionConfiguration¶
Contains details about the configuration of the server-side encryption.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SERVERSIDEENCRYPTIONCONF() |
Getter for SERVERSIDEENCRYPTIONCONF |
vectorIngestionConfiguration¶
Contains details about how to ingest the documents in the data source.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_VECTORINGESTIONCONF() |
Getter for VECTORINGESTIONCONFIGURATION |
dataDeletionPolicy¶
The data deletion policy for the data source.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DATADELETIONPOLICY() |
Getter for DATADELETIONPOLICY, with configurable default |
ASK_DATADELETIONPOLICY() |
Getter for DATADELETIONPOLICY w/ exceptions if field has no |
HAS_DATADELETIONPOLICY() |
Determine if DATADELETIONPOLICY has a value |
createdAt¶
The time at which the data source was created.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREATEDAT() |
Getter for CREATEDAT, with configurable default |
ASK_CREATEDAT() |
Getter for CREATEDAT w/ exceptions if field has no value |
HAS_CREATEDAT() |
Determine if CREATEDAT has a value |
updatedAt¶
The time at which the data source was last updated.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_UPDATEDAT() |
Getter for UPDATEDAT, with configurable default |
ASK_UPDATEDAT() |
Getter for UPDATEDAT w/ exceptions if field has no value |
HAS_UPDATEDAT() |
Determine if UPDATEDAT has a value |
failureReasons¶
The detailed reasons on the failure to delete a data source.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_FAILUREREASONS() |
Getter for FAILUREREASONS, with configurable default |
ASK_FAILUREREASONS() |
Getter for FAILUREREASONS w/ exceptions if field has no valu |
HAS_FAILUREREASONS() |
Determine if FAILUREREASONS has a value |