/AWS1/IF_IOT=>SEARCHINDEX()

About SearchIndex

The query search index.

Requires permission to access the SearchIndex action.

Method Signature

METHODS /AWS1/IF_IOT~SEARCHINDEX
  IMPORTING
    !IV_INDEXNAME TYPE /AWS1/IOTINDEXNAME OPTIONAL
    !IV_QUERYSTRING TYPE /AWS1/IOTQUERYSTRING OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/IOTNEXTTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/IOTSEARCHQUERYMAXRESULTS OPTIONAL
    !IV_QUERYVERSION TYPE /AWS1/IOTQUERYVERSION OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_iotsearchindexrsp
  RAISING
    /AWS1/CX_IOTINDEXNOTREADYEX
    /AWS1/CX_IOTINTERNALFAILUREEX
    /AWS1/CX_IOTINVALIDQUERYEX
    /AWS1/CX_IOTINVALIDREQUESTEX
    /AWS1/CX_IOTRESOURCENOTFOUNDEX
    /AWS1/CX_IOTSERVICEUNAVAILEX
    /AWS1/CX_IOTTHROTTLINGEX
    /AWS1/CX_IOTUNAUTHORIZEDEX
    /AWS1/CX_IOTCLIENTEXC
    /AWS1/CX_IOTSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_querystring TYPE /AWS1/IOTQUERYSTRING /AWS1/IOTQUERYSTRING

The search query string. For more information about the search query syntax, see Query syntax.

Optional arguments:

iv_indexname TYPE /AWS1/IOTINDEXNAME /AWS1/IOTINDEXNAME

The search index name.

iv_nexttoken TYPE /AWS1/IOTNEXTTOKEN /AWS1/IOTNEXTTOKEN

The token used to get the next set of results, or null if there are no additional results.

iv_maxresults TYPE /AWS1/IOTSEARCHQUERYMAXRESULTS /AWS1/IOTSEARCHQUERYMAXRESULTS

The maximum number of results to return per page at one time. This maximum number cannot exceed 100. The response might contain fewer results but will never contain more. You can use nextToken to retrieve the next set of results until nextToken returns NULL.

iv_queryversion TYPE /AWS1/IOTQUERYVERSION /AWS1/IOTQUERYVERSION

The query version.

RETURNING

oo_output TYPE REF TO /aws1/cl_iotsearchindexrsp /AWS1/CL_IOTSEARCHINDEXRSP

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->searchindex(
  iv_indexname = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_querystring = |string|
  iv_queryversion = |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_things( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_thingname = lo_row_1->get_thingname( ).
      lv_thingid = lo_row_1->get_thingid( ).
      lv_thingtypename = lo_row_1->get_thingtypename( ).
      LOOP AT lo_row_1->get_thinggroupnames( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_thinggroupname = lo_row_3->get_value( ).
        ENDIF.
      ENDLOOP.
      LOOP AT lo_row_1->get_attributes( ) into ls_row_4.
        lv_key = ls_row_4-key.
        lo_value = ls_row_4-value.
        IF lo_value IS NOT INITIAL.
          lv_attributevalue = lo_value->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_jsondocument = lo_row_1->get_shadow( ).
      lv_jsondocument = lo_row_1->get_devicedefender( ).
      lo_thingconnectivity = lo_row_1->get_connectivity( ).
      IF lo_thingconnectivity IS NOT INITIAL.
        lv_boolean = lo_thingconnectivity->get_connected( ).
        lv_connectivitytimestamp = lo_thingconnectivity->get_timestamp( ).
        lv_disconnectreason = lo_thingconnectivity->get_disconnectreason( ).
      ENDIF.
    ENDIF.
  ENDLOOP.
  LOOP AT lo_result->get_thinggroups( ) into lo_row_5.
    lo_row_6 = lo_row_5.
    IF lo_row_6 IS NOT INITIAL.
      lv_thinggroupname = lo_row_6->get_thinggroupname( ).
      lv_thinggroupid = lo_row_6->get_thinggroupid( ).
      lv_thinggroupdescription = lo_row_6->get_thinggroupdescription( ).
      LOOP AT lo_row_6->get_attributes( ) into ls_row_4.
        lv_key = ls_row_4-key.
        lo_value = ls_row_4-value.
        IF lo_value IS NOT INITIAL.
          lv_attributevalue = lo_value->get_value( ).
        ENDIF.
      ENDLOOP.
      LOOP AT lo_row_6->get_parentgroupnames( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_thinggroupname = lo_row_3->get_value( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
  ENDLOOP.
ENDIF.