Skip to content

/AWS1/IF_MPB=>LISTLINKROUTINGRULES()

About ListLinkRoutingRules

Lists the routing rules for a link.

Method Signature

METHODS /AWS1/IF_MPB~LISTLINKROUTINGRULES
  IMPORTING
    !IV_GATEWAYID TYPE /AWS1/MPBGATEWAYID OPTIONAL
    !IV_LINKID TYPE /AWS1/MPBLINKID OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/MPBSTRING OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/MPBINTEGER OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_mpblstlnkroutngrlsrsp
  RAISING
    /AWS1/CX_MPBACCESSDENIEDEX
    /AWS1/CX_MPBINTERNALSERVEREX
    /AWS1/CX_MPBRESOURCENOTFOUNDEX
    /AWS1/CX_MPBTHROTTLINGEX
    /AWS1/CX_MPBVALIDATIONEX
    /AWS1/CX_MPBCLIENTEXC
    /AWS1/CX_MPBSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_gatewayid TYPE /AWS1/MPBGATEWAYID /AWS1/MPBGATEWAYID

The unique identifier of the gateway.

iv_linkid TYPE /AWS1/MPBLINKID /AWS1/MPBLINKID

The unique identifier of the link.

Optional arguments:

iv_nexttoken TYPE /AWS1/MPBSTRING /AWS1/MPBSTRING

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

iv_maxresults TYPE /AWS1/MPBINTEGER /AWS1/MPBINTEGER

The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results.

This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

RETURNING

oo_output TYPE REF TO /aws1/cl_mpblstlnkroutngrlsrsp /AWS1/CL_MPBLSTLNKROUTNGRLSRSP

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->listlinkroutingrules(
  iv_gatewayid = |string|
  iv_linkid = |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_rules( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_ruleid = lo_row_1->get_ruleid( ).
      lv_rulepriority = lo_row_1->get_priority( ).
      lo_rulecondition = lo_row_1->get_conditions( ).
      IF lo_rulecondition IS NOT INITIAL.
        lv_string = lo_rulecondition->get_hostheader( ).
        lv_string = lo_rulecondition->get_hostheaderwildcard( ).
        lv_string = lo_rulecondition->get_pathprefix( ).
        lv_string = lo_rulecondition->get_pathexact( ).
        lo_querystringkeyvaluepair = lo_rulecondition->get_querystringequals( ).
        IF lo_querystringkeyvaluepair IS NOT INITIAL.
          lv_string = lo_querystringkeyvaluepair->get_key( ).
          lv_string = lo_querystringkeyvaluepair->get_value( ).
        ENDIF.
        lv_string = lo_rulecondition->get_querystringexists( ).
      ENDIF.
      lv_rulestatus = lo_row_1->get_status( ).
      lv_timestamp = lo_row_1->get_createdat( ).
      lv_timestamp = lo_row_1->get_updatedat( ).
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_nexttoken( ).
ENDIF.

List all routing rules for a link

DATA(lo_result) = lo_client->listlinkroutingrules(
  iv_gatewayid = |rtb-gw-12345678|
  iv_linkid = |link-87654321|
  iv_maxresults = 10
).