/AWS1/IF_BDA=>LISTINGESTIONJOBS()

About ListIngestionJobs

Lists the data ingestion jobs for a data source. The list also includes information about each job.

Method Signature

METHODS /AWS1/IF_BDA~LISTINGESTIONJOBS
  IMPORTING
    !IV_KNOWLEDGEBASEID TYPE /AWS1/BDAID OPTIONAL
    !IV_DATASOURCEID TYPE /AWS1/BDAID OPTIONAL
    !IT_FILTERS TYPE /AWS1/CL_BDAINGESTIONJOBFILTER=>TT_INGESTIONJOBFILTERS OPTIONAL
    !IO_SORTBY TYPE REF TO /AWS1/CL_BDAINGESTIONJOBSORTBY OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/BDAMAXRESULTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/BDANEXTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_bdalstingestionjobs01
  RAISING
    /AWS1/CX_BDAACCESSDENIEDEX
    /AWS1/CX_BDAINTERNALSERVEREX
    /AWS1/CX_BDARESOURCENOTFOUNDEX
    /AWS1/CX_BDATHROTTLINGEX
    /AWS1/CX_BDAVALIDATIONEX
    /AWS1/CX_BDACLIENTEXC
    /AWS1/CX_BDASERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_knowledgebaseid TYPE /AWS1/BDAID /AWS1/BDAID

The unique identifier of the knowledge base for the list of data ingestion jobs.

iv_datasourceid TYPE /AWS1/BDAID /AWS1/BDAID

The unique identifier of the data source for the list of data ingestion jobs.

Optional arguments:

it_filters TYPE /AWS1/CL_BDAINGESTIONJOBFILTER=>TT_INGESTIONJOBFILTERS TT_INGESTIONJOBFILTERS

Contains information about the filters for filtering the data.

io_sortby TYPE REF TO /AWS1/CL_BDAINGESTIONJOBSORTBY /AWS1/CL_BDAINGESTIONJOBSORTBY

Contains details about how to sort the data.

iv_maxresults TYPE /AWS1/BDAMAXRESULTS /AWS1/BDAMAXRESULTS

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

iv_nexttoken TYPE /AWS1/BDANEXTTOKEN /AWS1/BDANEXTTOKEN

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

RETURNING

oo_output TYPE REF TO /aws1/cl_bdalstingestionjobs01 /AWS1/CL_BDALSTINGESTIONJOBS01

Domain	/AWS1/RT_ACCOUNT_ID
Primitive Type	NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->listingestionjobs(
  io_sortby = new /aws1/cl_bdaingestionjobsortby(
    iv_attribute = |string|
    iv_order = |string|
  )
  it_filters = VALUE /aws1/cl_bdaingestionjobfilter=>tt_ingestionjobfilters(
    (
      new /aws1/cl_bdaingestionjobfilter(
        it_values = VALUE /aws1/cl_bdaingestionjobfilt00=>tt_ingestionjobfiltervalues(
          ( new /aws1/cl_bdaingestionjobfilt00( |string| ) )
        )
        iv_attribute = |string|
        iv_operator = |string|
      )
    )
  )
  iv_datasourceid = |string|
  iv_knowledgebaseid = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_ingestionjobsummaries( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_id = lo_row_1->get_knowledgebaseid( ).
      lv_id = lo_row_1->get_datasourceid( ).
      lv_id = lo_row_1->get_ingestionjobid( ).
      lv_description = lo_row_1->get_description( ).
      lv_ingestionjobstatus = lo_row_1->get_status( ).
      lv_datetimestamp = lo_row_1->get_startedat( ).
      lv_datetimestamp = lo_row_1->get_updatedat( ).
      lo_ingestionjobstatistics = lo_row_1->get_statistics( ).
      IF lo_ingestionjobstatistics IS NOT INITIAL.
        lv_primitivelong = lo_ingestionjobstatistics->get_numberofdocumentsscanned( ).
        lv_primitivelong = lo_ingestionjobstatistics->get_numberofmetdocsscanned( ).
        lv_primitivelong = lo_ingestionjobstatistics->get_numberofnewdocsindexed( ).
        lv_primitivelong = lo_ingestionjobstatistics->get_numofmoddeddocsindexed( ).
        lv_primitivelong = lo_ingestionjobstatistics->get_numberofmetdocsmodified( ).
        lv_primitivelong = lo_ingestionjobstatistics->get_numberofdocumentsdeleted( ).
        lv_primitivelong = lo_ingestionjobstatistics->get_numberofdocumentsfailed( ).
      ENDIF.
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.