GETRETRIEVER()`¶

About GetRetriever¶

Gets information about an existing retriever used by an Amazon Q Business application.

Method Signature¶

IMPORTING¶

Required arguments:¶

`iv_applicationid` `TYPE /AWS1/QQBAPPLICATIONID` `/AWS1/QQBAPPLICATIONID`¶

The identifier of the Amazon Q Business application using the retriever.

`iv_retrieverid` `TYPE /AWS1/QQBRETRIEVERID` `/AWS1/QQBRETRIEVERID`¶

The identifier of the retriever.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_qqbgetretrieverrsp` `/AWS1/CL_QQBGETRETRIEVERRSP`¶

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~getretriever(
  iv_applicationid = |string|
  iv_retrieverid = |string|
).

This is an example of reading all possible response values

lv_applicationid = lo_result->get_applicationid( ).
lv_retrieverid = lo_result->get_retrieverid( ).
lv_retrieverarn = lo_result->get_retrieverarn( ).
lv_retrievertype = lo_result->get_type( ).
lv_retrieverstatus = lo_result->get_status( ).
lv_retrievername = lo_result->get_displayname( ).
lv_indexid = lo_nativeindexconfiguratio->get_indexid( ).
LOOP AT lo_nativeindexconfiguratio->get_boostingoverride( ) into ls_row.
  lv_key = ls_row-key.
  lv_documentattributeboosti = lo_numberattributeboosting->get_boostinglevel( ).
  lv_numberattributeboosting_1 = lo_numberattributeboosting->get_boostingtype( ).
  lv_documentattributeboosti = lo_stringattributeboosting->get_boostinglevel( ).
  LOOP AT lo_stringattributeboosting->get_attributevalueboosting( ) into ls_row_1.
    lv_key_1 = ls_row_1-key.
    lv_stringattributevalueboo = lo_value_1->get_value( ).
  ENDLOOP.
  lv_documentattributeboosti = lo_dateattributeboostingco->get_boostinglevel( ).
  lv_boostingdurationinsecon = lo_dateattributeboostingco->get_boostingdurinseconds( ).
  lv_documentattributeboosti = lo_stringlistattributeboos->get_boostinglevel( ).
ENDLOOP.
lv_kendraindexid = lo_kendraindexconfiguratio->get_indexid( ).
lv_rolearn = lo_result->get_rolearn( ).
lv_timestamp = lo_result->get_createdat( ).
lv_timestamp = lo_result->get_updatedat( ).

/AWS1/CL_QQB=>GETRETRIEVER()¶