DESCRIBESUGGESTERS()`¶

About DescribeSuggesters¶

Gets the suggesters configured for a domain. A suggester enables you to display possible matches before users finish typing their queries. Can be limited to specific suggesters by name. By default, shows all suggesters and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.

Method Signature¶

METHODS /AWS1/IF_SRH~DESCRIBESUGGESTERS
  IMPORTING
    !IV_DOMAINNAME TYPE /AWS1/SRHDOMAINNAME OPTIONAL
    !IT_SUGGESTERNAMES TYPE /AWS1/CL_SRHSTANDARDNAMELIST_W=>TT_STANDARDNAMELIST OPTIONAL
    !IV_DEPLOYED TYPE /AWS1/SRHBOOLEAN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_srhdescrsuggestersrsp
  RAISING
    /AWS1/CX_SRHBASEEXCEPTION
    /AWS1/CX_SRHINTERNALEXCEPTION
    /AWS1/CX_SRHRESOURCENOTFOUNDEX
    /AWS1/CX_SRHCLIENTEXC
    /AWS1/CX_SRHSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_domainname` `TYPE /AWS1/SRHDOMAINNAME` `/AWS1/SRHDOMAINNAME`¶

The name of the domain you want to describe.

Optional arguments:¶

`it_suggesternames` `TYPE /AWS1/CL_SRHSTANDARDNAMELIST_W=>TT_STANDARDNAMELIST` `TT_STANDARDNAMELIST`¶

The suggesters you want to describe.

`iv_deployed` `TYPE /AWS1/SRHBOOLEAN` `/AWS1/SRHBOOLEAN`¶

Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_srhdescrsuggestersrsp` `/AWS1/CL_SRHDESCRSUGGESTERSRSP`¶

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->describesuggesters(
  it_suggesternames = VALUE /aws1/cl_srhstandardnamelist_w=>tt_standardnamelist(
    ( new /aws1/cl_srhstandardnamelist_w( |string| ) )
  )
  iv_deployed = ABAP_TRUE
  iv_domainname = |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_suggesters( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lo_suggester = lo_row_1->get_options( ).
      IF lo_suggester IS NOT INITIAL.
        lv_standardname = lo_suggester->get_suggestername( ).
        lo_documentsuggesteroption = lo_suggester->get_documentsuggesteroptions( ).
        IF lo_documentsuggesteroption IS NOT INITIAL.
          lv_fieldname = lo_documentsuggesteroption->get_sourcefield( ).
          lv_suggesterfuzzymatching = lo_documentsuggesteroption->get_fuzzymatching( ).
          lv_string = lo_documentsuggesteroption->get_sortexpression( ).
        ENDIF.
      ENDIF.
      lo_optionstatus = lo_row_1->get_status( ).
      IF lo_optionstatus IS NOT INITIAL.
        lv_updatetimestamp = lo_optionstatus->get_creationdate( ).
        lv_updatetimestamp = lo_optionstatus->get_updatedate( ).
        lv_uintvalue = lo_optionstatus->get_updateversion( ).
        lv_optionstate = lo_optionstatus->get_state( ).
        lv_boolean = lo_optionstatus->get_pendingdeletion( ).
      ENDIF.
    ENDIF.
  ENDLOOP.
ENDIF.

/AWS1/IF_SRH=>DESCRIBESUGGESTERS()¶