Skip to content

/AWS1/IF_DCO=>LISTVIRTUALINTERFACEROUTES()

About ListVirtualInterfaceRoutes

Lists the routes for the specified virtual interface.

Use the routeDirection filter to control which routes are returned:

  • accepted: routes received from the customer network over the virtual interface.

  • advertised: routes advertised to the customer network over the virtual interface.

Method Signature

METHODS /AWS1/IF_DCO~LISTVIRTUALINTERFACEROUTES
  IMPORTING
    !IV_VIRTUALINTERFACEID TYPE /AWS1/DCOVIRTUALINTERFACEID OPTIONAL
    !IO_FILTERS TYPE REF TO /AWS1/CL_DCOROUTEFILTERS OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/DCOMAXRESULTSETSIZE OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/DCOPAGINATIONTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_dcolistvirintfrtersp
  RAISING
    /AWS1/CX_DCODIRECTCNCTCLIENTEX
    /AWS1/CX_DCODIRECTCNCTSERVEREX
    /AWS1/CX_DCOCLIENTEXC
    /AWS1/CX_DCOSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Optional arguments:

iv_virtualinterfaceid TYPE /AWS1/DCOVIRTUALINTERFACEID /AWS1/DCOVIRTUALINTERFACEID

The ID of the virtual interface.

io_filters TYPE REF TO /AWS1/CL_DCOROUTEFILTERS /AWS1/CL_DCOROUTEFILTERS

The filters to apply to the routes returned.

iv_maxresults TYPE /AWS1/DCOMAXRESULTSETSIZE /AWS1/DCOMAXRESULTSETSIZE

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

If MaxResults is given a value larger than 100, only 100 results are returned.

iv_nexttoken TYPE /AWS1/DCOPAGINATIONTOKEN /AWS1/DCOPAGINATIONTOKEN

The token for the next page of results.

RETURNING

oo_output TYPE REF TO /aws1/cl_dcolistvirintfrtersp /AWS1/CL_DCOLISTVIRINTFRTERSP

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->listvirtualinterfaceroutes(
  io_filters = new /aws1/cl_dcoroutefilters(
    it_aspath = VALUE /aws1/cl_dcoaspathlist_w=>tt_aspathlist(
      ( new /aws1/cl_dcoaspathlist_w( 123 ) )
    )
    it_cidrs = VALUE /aws1/cl_dcortefltcidrstrlst_w=>tt_routefiltercidrstringlist(
      ( new /aws1/cl_dcortefltcidrstrlst_w( |string| ) )
    )
    it_communities = VALUE /aws1/cl_dcocommunitylist_w=>tt_communitylist(
      ( new /aws1/cl_dcocommunitylist_w( |string| ) )
    )
    iv_addressfamily = |string|
    iv_routedirection = |string|
  )
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_virtualinterfaceid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_virtualinterfaceid = lo_result->get_virtualinterfaceid( ).
  LOOP AT lo_result->get_routes( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_routecidr = lo_row_1->get_cidr( ).
      lv_routedirection = lo_row_1->get_routedirection( ).
      lv_addressfamily = lo_row_1->get_addressfamily( ).
      LOOP AT lo_row_1->get_aspath( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_aspathtype = lo_row_3->get_pathtype( ).
          LOOP AT lo_row_3->get_path( ) into lo_row_4.
            lo_row_5 = lo_row_4.
            IF lo_row_5 IS NOT INITIAL.
              lv_longasn = lo_row_5->get_value( ).
            ENDIF.
          ENDLOOP.
        ENDIF.
      ENDLOOP.
      LOOP AT lo_row_1->get_communities( ) into lo_row_6.
        lo_row_7 = lo_row_6.
        IF lo_row_7 IS NOT INITIAL.
          lv_communityentry = lo_row_7->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_awslogicaldeviceid = lo_row_1->get_awslogicaldeviceid( ).
      lv_routeinstalledat = lo_row_1->get_routeinstalledat( ).
    ENDIF.
  ENDLOOP.
  lv_paginationtoken = lo_result->get_nexttoken( ).
ENDIF.