DEFINESUGGESTER()`¶

About DefineSuggester¶

Configures a suggester for a domain. A suggester enables you to display possible matches before users finish typing their queries. When you configure a suggester, you must specify the name of the text field you want to search for possible matches and a unique name for the suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.

Method Signature¶

METHODS /AWS1/IF_SRH~DEFINESUGGESTER
  IMPORTING
    !IV_DOMAINNAME TYPE /AWS1/SRHDOMAINNAME OPTIONAL
    !IO_SUGGESTER TYPE REF TO /AWS1/CL_SRHSUGGESTER OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_srhdefinesuggesterrsp
  RAISING
    /AWS1/CX_SRHBASEEXCEPTION
    /AWS1/CX_SRHINTERNALEXCEPTION
    /AWS1/CX_SRHINVALIDTYPEEX
    /AWS1/CX_SRHLIMITEXCEEDEDEX
    /AWS1/CX_SRHRESOURCENOTFOUNDEX
    /AWS1/CX_SRHVALIDATIONEX
    /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`¶

A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

`io_suggester` `TYPE REF TO /AWS1/CL_SRHSUGGESTER` `/AWS1/CL_SRHSUGGESTER`¶

Configuration information for a search suggester. Each suggester has a unique name and specifies the text field you want to use for suggestions. The following options can be configured for a suggester: FuzzyMatching, SortExpression.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_srhdefinesuggesterrsp` `/AWS1/CL_SRHDEFINESUGGESTERRSP`¶

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->definesuggester(
  io_suggester = new /aws1/cl_srhsuggester(
    io_documentsuggesteroptions = new /aws1/cl_srhdocsuggesteropts(
      iv_fuzzymatching = |string|
      iv_sortexpression = |string|
      iv_sourcefield = |string|
    )
    iv_suggestername = |string|
  )
  iv_domainname = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_suggesterstatus = lo_result->get_suggester( ).
  IF lo_suggesterstatus IS NOT INITIAL.
    lo_suggester = lo_suggesterstatus->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_suggesterstatus->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.
ENDIF.

/AWS1/IF_SRH=>DEFINESUGGESTER()¶