Skip to content

/AWS1/IF_BDO=>LISTGATEWAYRATELIMITS()

About ListGatewayRateLimits

Lists all rate limits for a gateway. Results are paginated. Use the nextToken parameter to retrieve additional results.

Method Signature

METHODS /AWS1/IF_BDO~LISTGATEWAYRATELIMITS
  IMPORTING
    !IV_GATEWAYIDENTIFIER TYPE /AWS1/BDOGATEWAYIDENTIFIER OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/BDOGATEWAYRLIMMAXRESULTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/BDOGATEWAYRLIMNEXTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_bdolistgwrlimsrsp
  RAISING
    /AWS1/CX_BDOACCESSDENIEDEX
    /AWS1/CX_BDOINTERNALSERVEREX
    /AWS1/CX_BDORESOURCENOTFOUNDEX
    /AWS1/CX_BDOTHROTTLINGEX
    /AWS1/CX_BDOVALIDATIONEX
    /AWS1/CX_BDOCLIENTEXC
    /AWS1/CX_BDOSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_gatewayidentifier TYPE /AWS1/BDOGATEWAYIDENTIFIER /AWS1/BDOGATEWAYIDENTIFIER

The unique identifier of the gateway.

Optional arguments:

iv_maxresults TYPE /AWS1/BDOGATEWAYRLIMMAXRESULTS /AWS1/BDOGATEWAYRLIMMAXRESULTS

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

iv_nexttoken TYPE /AWS1/BDOGATEWAYRLIMNEXTTOKEN /AWS1/BDOGATEWAYRLIMNEXTTOKEN

The token to use to retrieve the next page of results. Use the value returned in a previous ListGatewayRateLimits response.

RETURNING

oo_output TYPE REF TO /aws1/cl_bdolistgwrlimsrsp /AWS1/CL_BDOLISTGWRLIMSRSP

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->listgatewayratelimits(
  iv_gatewayidentifier = |string|
  iv_maxresults = 123
  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_ratelimits( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_gatewayratelimitid = lo_row_1->get_ratelimitid( ).
      lv_gatewayidentifier = lo_row_1->get_gatewayidentifier( ).
      lv_gatewayratelimitdescrip = lo_row_1->get_description( ).
      LOOP AT lo_row_1->get_dimensionkeys( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_dimensionkey = lo_row_3->get_value( ).
        ENDIF.
      ENDLOOP.
      LOOP AT lo_row_1->get_entries( ) into lo_row_4.
        lo_row_5 = lo_row_4.
        IF lo_row_5 IS NOT INITIAL.
          LOOP AT lo_row_5->get_dimensions( ) into ls_row_6.
            lv_key = ls_row_6-key.
            lo_value = ls_row_6-value.
            IF lo_value IS NOT INITIAL.
              lv_dimensionvalue = lo_value->get_value( ).
            ENDIF.
          ENDLOOP.
          LOOP AT lo_row_5->get_requests( ) into lo_row_7.
            lo_row_8 = lo_row_7.
            IF lo_row_8 IS NOT INITIAL.
              lv_double = lo_row_8->get_rate( ).
              lv_period = lo_row_8->get_period( ).
            ENDIF.
          ENDLOOP.
          LOOP AT lo_row_5->get_tokens( ) into lo_row_7.
            lo_row_8 = lo_row_7.
            IF lo_row_8 IS NOT INITIAL.
              lv_double = lo_row_8->get_rate( ).
              lv_period = lo_row_8->get_period( ).
            ENDIF.
          ENDLOOP.
          LOOP AT lo_row_5->get_connections( ) into lo_row_7.
            lo_row_8 = lo_row_7.
            IF lo_row_8 IS NOT INITIAL.
              lv_double = lo_row_8->get_rate( ).
              lv_period = lo_row_8->get_period( ).
            ENDIF.
          ENDLOOP.
        ENDIF.
      ENDLOOP.
      lv_gatewayratelimitstatus = lo_row_1->get_status( ).
      lv_datetimestamp = lo_row_1->get_createdat( ).
      lv_datetimestamp = lo_row_1->get_updatedat( ).
    ENDIF.
  ENDLOOP.
  lv_gatewayratelimitnexttok = lo_result->get_nexttoken( ).
ENDIF.