Skip to content

/AWS1/CL_QQB=>LISTPLUGINS()

About ListPlugins

Lists configured Amazon Q Business plugins.

Method Signature

IMPORTING

Required arguments:

iv_applicationid TYPE /AWS1/QQBAPPLICATIONID /AWS1/QQBAPPLICATIONID

The identifier of the application the plugin is attached to.

Optional arguments:

iv_nexttoken TYPE /AWS1/QQBNEXTTOKEN /AWS1/QQBNEXTTOKEN

If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of plugins.

iv_maxresults TYPE /AWS1/QQBMAXRSSINTEGERFORLST08 /AWS1/QQBMAXRSSINTEGERFORLST08

The maximum number of documents to return.

RETURNING

oo_output TYPE REF TO /aws1/cl_qqblistpluginsrsp /AWS1/CL_QQBLISTPLUGINSRSP

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~listplugins(
  iv_applicationid = |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.
  lv_nexttoken = lo_result->get_nexttoken( ).
  LOOP AT lo_result->get_plugins( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_pluginid = lo_row_1->get_pluginid( ).
      lv_pluginname = lo_row_1->get_displayname( ).
      lv_plugintype = lo_row_1->get_type( ).
      lv_url = lo_row_1->get_serverurl( ).
      lv_pluginstate = lo_row_1->get_state( ).
      lv_pluginbuildstatus = lo_row_1->get_buildstatus( ).
      lv_timestamp = lo_row_1->get_createdat( ).
      lv_timestamp = lo_row_1->get_updatedat( ).
    ENDIF.
  ENDLOOP.
ENDIF.