GETINDEX()`¶

About GetIndex¶

Retrieves information about an OpenSearch index including its schema and semantic enrichment configuration. Use this operation to view the current index structure and semantic search settings.

Method Signature¶

METHODS /AWS1/IF_OSR~GETINDEX
  IMPORTING
    !IV_DOMAINNAME TYPE /AWS1/OSRDOMAINNAME OPTIONAL
    !IV_INDEXNAME TYPE /AWS1/OSRINDEXNAME OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_osrgetindexresponse
  RAISING
    /AWS1/CX_OSRACCESSDENIEDEX
    /AWS1/CX_OSRDEPENDENCYFAILUR00
    /AWS1/CX_OSRDISABLEDOPEX
    /AWS1/CX_OSRINTERNALEXCEPTION
    /AWS1/CX_OSRRESOURCENOTFOUNDEX
    /AWS1/CX_OSRTHROTTLINGEX
    /AWS1/CX_OSRVALIDATIONEX
    /AWS1/CX_OSRCLIENTEXC
    /AWS1/CX_OSRSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_domainname` `TYPE /AWS1/OSRDOMAINNAME` `/AWS1/OSRDOMAINNAME`¶

DomainName

`iv_indexname` `TYPE /AWS1/OSRINDEXNAME` `/AWS1/OSRINDEXNAME`¶

The name of the index to retrieve information about.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_osrgetindexresponse` `/AWS1/CL_OSRGETINDEXRESPONSE`¶

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->getindex(
  iv_domainname = |string|
  iv_indexname = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_value = lo_result->get_indexschema( ).
  IF lo_value IS NOT INITIAL.
  ENDIF.
ENDIF.

/AWS1/IF_OSR=>GETINDEX()¶