DESCRIBETUNNEL()`¶

About DescribeTunnel¶

Gets information about a tunnel identified by the unique tunnel id.

Requires permission to access the DescribeTunnel action.

Method Signature¶

METHODS /AWS1/IF_IOU~DESCRIBETUNNEL
  IMPORTING
    !IV_TUNNELID TYPE /AWS1/IOUTUNNELID OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ioudescrtunnelrsp
  RAISING
    /AWS1/CX_IOURESOURCENOTFOUNDEX
    /AWS1/CX_IOUCLIENTEXC
    /AWS1/CX_IOUSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_tunnelid` `TYPE /AWS1/IOUTUNNELID` `/AWS1/IOUTUNNELID`¶

The tunnel to describe.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_ioudescrtunnelrsp` `/AWS1/CL_IOUDESCRTUNNELRSP`¶

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->describetunnel( |string| ).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_tunnel = lo_result->get_tunnel( ).
  IF lo_tunnel IS NOT INITIAL.
    lv_tunnelid = lo_tunnel->get_tunnelid( ).
    lv_tunnelarn = lo_tunnel->get_tunnelarn( ).
    lv_tunnelstatus = lo_tunnel->get_status( ).
    lo_connectionstate = lo_tunnel->get_sourceconnectionstate( ).
    IF lo_connectionstate IS NOT INITIAL.
      lv_connectionstatus = lo_connectionstate->get_status( ).
      lv_datetype = lo_connectionstate->get_lastupdatedat( ).
    ENDIF.
    lo_connectionstate = lo_tunnel->get_dstconnectionstate( ).
    IF lo_connectionstate IS NOT INITIAL.
      lv_connectionstatus = lo_connectionstate->get_status( ).
      lv_datetype = lo_connectionstate->get_lastupdatedat( ).
    ENDIF.
    lv_description = lo_tunnel->get_description( ).
    lo_destinationconfig = lo_tunnel->get_destinationconfig( ).
    IF lo_destinationconfig IS NOT INITIAL.
      lv_thingname = lo_destinationconfig->get_thingname( ).
      LOOP AT lo_destinationconfig->get_services( ) into lo_row.
        lo_row_1 = lo_row.
        IF lo_row_1 IS NOT INITIAL.
          lv_service = lo_row_1->get_value( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
    lo_timeoutconfig = lo_tunnel->get_timeoutconfig( ).
    IF lo_timeoutconfig IS NOT INITIAL.
      lv_timeoutinmin = lo_timeoutconfig->get_maxlifetimetmoutminutes( ).
    ENDIF.
    LOOP AT lo_tunnel->get_tags( ) into lo_row_2.
      lo_row_3 = lo_row_2.
      IF lo_row_3 IS NOT INITIAL.
        lv_tagkey = lo_row_3->get_key( ).
        lv_tagvalue = lo_row_3->get_value( ).
      ENDIF.
    ENDLOOP.
    lv_datetype = lo_tunnel->get_createdat( ).
    lv_datetype = lo_tunnel->get_lastupdatedat( ).
  ENDIF.
ENDIF.

/AWS1/IF_IOU=>DESCRIBETUNNEL()¶