DESCRIBEENDPOINTSETTINGS()`¶

About DescribeEndpointSettings¶

Returns information about the possible endpoint settings available when you create an endpoint for a specific database engine.

Method Signature¶

METHODS /AWS1/IF_DMG~DESCRIBEENDPOINTSETTINGS
  IMPORTING
    !IV_ENGINENAME TYPE /AWS1/DMGSTRING OPTIONAL
    !IV_MAXRECORDS TYPE /AWS1/DMGINTEGEROPTIONAL OPTIONAL
    !IV_MARKER TYPE /AWS1/DMGSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_dmgdescrendptstgsrsp
  RAISING
    /AWS1/CX_DMGCLIENTEXC
    /AWS1/CX_DMGSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_enginename` `TYPE /AWS1/DMGSTRING` `/AWS1/DMGSTRING`¶

The database engine used for your source or target endpoint.

Optional arguments:¶

`iv_maxrecords` `TYPE /AWS1/DMGINTEGEROPTIONAL` `/AWS1/DMGINTEGEROPTIONAL`¶

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

`iv_marker` `TYPE /AWS1/DMGSTRING` `/AWS1/DMGSTRING`¶

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_dmgdescrendptstgsrsp` `/AWS1/CL_DMGDESCRENDPTSTGSRSP`¶

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->describeendpointsettings(
  iv_enginename = |string|
  iv_marker = |string|
  iv_maxrecords = 123
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_string = lo_result->get_marker( ).
  LOOP AT lo_result->get_endpointsettings( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_name( ).
      lv_endpointsettingtypevalu = lo_row_1->get_type( ).
      LOOP AT lo_row_1->get_enumvalues( ) 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.
      lv_booleanoptional = lo_row_1->get_sensitive( ).
      lv_string = lo_row_1->get_units( ).
      lv_string = lo_row_1->get_applicability( ).
      lv_integeroptional = lo_row_1->get_intvaluemin( ).
      lv_integeroptional = lo_row_1->get_intvaluemax( ).
      lv_string = lo_row_1->get_defaultvalue( ).
    ENDIF.
  ENDLOOP.
ENDIF.

/AWS1/IF_DMG=>DESCRIBEENDPOINTSETTINGS()¶