DESCRIBEENTITY()`¶

About DescribeEntity¶

Provides details regarding the entity used with the connection type, with a description of the data model for each field in the selected entity.

The response includes all the fields which make up the entity.

Method Signature¶

IMPORTING¶

Required arguments:¶

`iv_connectionname` `TYPE /AWS1/GLUNAMESTRING` `/AWS1/GLUNAMESTRING`¶

The name of the connection that contains the connection type credentials.

`iv_entityname` `TYPE /AWS1/GLUENTITYNAME` `/AWS1/GLUENTITYNAME`¶

The name of the entity that you want to describe from the connection type.

Optional arguments:¶

`iv_catalogid` `TYPE /AWS1/GLUCATALOGIDSTRING` `/AWS1/GLUCATALOGIDSTRING`¶

The catalog ID of the catalog that contains the connection. This can be null, By default, the Amazon Web Services Account ID is the catalog ID.

`iv_nexttoken` `TYPE /AWS1/GLUNEXTTOKEN` `/AWS1/GLUNEXTTOKEN`¶

A continuation token, included if this is a continuation call.

`iv_datastoreapiversion` `TYPE /AWS1/GLUAPIVERSION` `/AWS1/GLUAPIVERSION`¶

The version of the API used for the data store.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_gludescrentityrsp` `/AWS1/CL_GLUDESCRENTITYRSP`¶

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_glu~describeentity(
  iv_catalogid = |string|
  iv_connectionname = |string|
  iv_datastoreapiversion = |string|
  iv_entityname = |string|
  iv_nexttoken = |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_fields( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_entityfieldname = lo_row_1->get_fieldname( ).
      lv_fieldlabel = lo_row_1->get_label( ).
      lv_fielddescription = lo_row_1->get_description( ).
      lv_fielddatatype = lo_row_1->get_fieldtype( ).
      lv_bool = lo_row_1->get_isprimarykey( ).
      lv_bool = lo_row_1->get_isnullable( ).
      lv_bool = lo_row_1->get_isretrievable( ).
      lv_bool = lo_row_1->get_isfilterable( ).
      lv_bool = lo_row_1->get_ispartitionable( ).
      lv_bool = lo_row_1->get_iscreateable( ).
      lv_bool = lo_row_1->get_isupdateable( ).
      lv_bool = lo_row_1->get_isupsertable( ).
      lv_bool = lo_row_1->get_isdefaultoncreate( ).
      LOOP AT lo_row_1->get_supportedvalues( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_string = lo_row_3->get_value( ).
        ENDIF.
      ENDLOOP.
      LOOP AT lo_row_1->get_supportedfilteroperators( ) into lo_row_4.
        lo_row_5 = lo_row_4.
        IF lo_row_5 IS NOT INITIAL.
          lv_fieldfilteroperator = lo_row_5->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_string = lo_row_1->get_parentfield( ).
      lv_string = lo_row_1->get_nativedatatype( ).
      LOOP AT lo_row_1->get_customproperties( ) into ls_row_6.
        lv_key = ls_row_6-key.
        lo_value = ls_row_6-value.
        IF lo_value IS NOT INITIAL.
          lv_string = lo_value->get_value( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/CL_GLU=>DESCRIBEENTITY()¶