/AWS1/CL_QQB=>GETINDEX()

About GetIndex

Gets information about an existing Amazon Q Business index.

Method Signature

IMPORTING

Required arguments:

iv_applicationid TYPE /AWS1/QQBAPPLICATIONID /AWS1/QQBAPPLICATIONID

The identifier of the Amazon Q Business application connected to the index.

iv_indexid TYPE /AWS1/QQBINDEXID /AWS1/QQBINDEXID

The identifier of the Amazon Q Business index you want information on.

RETURNING

oo_output TYPE REF TO /aws1/cl_qqbgetindexresponse /AWS1/CL_QQBGETINDEXRESPONSE

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->/aws1/if_qqb~getindex(
  iv_applicationid = |string|
  iv_indexid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_applicationid = lo_result->get_applicationid( ).
  lv_indexid = lo_result->get_indexid( ).
  lv_indexname = lo_result->get_displayname( ).
  lv_indexarn = lo_result->get_indexarn( ).
  lv_indexstatus = lo_result->get_status( ).
  lv_indextype = lo_result->get_type( ).
  lv_description = lo_result->get_description( ).
  lv_timestamp = lo_result->get_createdat( ).
  lv_timestamp = lo_result->get_updatedat( ).
  lo_indexcapacityconfigurat = lo_result->get_capacityconfiguration( ).
  IF lo_indexcapacityconfigurat IS NOT INITIAL.
    lv_indexcapacityinteger = lo_indexcapacityconfigurat->get_units( ).
  ENDIF.
  LOOP AT lo_result->get_documentattributeconfs( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_documentmetadataconfigu = lo_row_1->get_name( ).
      lv_attributetype = lo_row_1->get_type( ).
      lv_status = lo_row_1->get_search( ).
    ENDIF.
  ENDLOOP.
  lo_errordetail = lo_result->get_error( ).
  IF lo_errordetail IS NOT INITIAL.
    lv_errormessage = lo_errordetail->get_errormessage( ).
    lv_errorcode = lo_errordetail->get_errorcode( ).
  ENDIF.
  lo_indexstatistics = lo_result->get_indexstatistics( ).
  IF lo_indexstatistics IS NOT INITIAL.
    lo_textdocumentstatistics = lo_indexstatistics->get_textdocumentstatistics( ).
    IF lo_textdocumentstatistics IS NOT INITIAL.
      lv_indexedtextbytes = lo_textdocumentstatistics->get_indexedtextbytes( ).
      lv_indexedtextdocument = lo_textdocumentstatistics->get_indexedtextdocumentcount( ).
    ENDIF.
  ENDIF.
ENDIF.