Skip to content

/AWS1/IF_MPB=>LISTRESPONDERGATEWAYS()

About ListResponderGateways

Lists reponder gateways.

Method Signature

METHODS /AWS1/IF_MPB~LISTRESPONDERGATEWAYS
  IMPORTING
    !IV_MAXRESULTS TYPE /AWS1/MPBINTEGER OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/MPBSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_mpblistrespgwsrsp
  RAISING
    /AWS1/CX_MPBINTERNALSERVEREX
    /AWS1/CX_MPBVALIDATIONEX
    /AWS1/CX_MPBCLIENTEXC
    /AWS1/CX_MPBSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Optional arguments:

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.

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.

RETURNING

oo_output TYPE REF TO /aws1/cl_mpblistrespgwsrsp /AWS1/CL_MPBLISTRESPGWSRSP

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->listrespondergateways(
  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_gatewayids( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_gatewayid = lo_row_1->get_value( ).
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_nexttoken( ).
ENDIF.

List responder gateways with default pagination

Lists responder gateways using default pagination settings

DATA(lo_result) = lo_client->listrespondergateways( iv_maxresults = 10 ) .

List responder gateways with pagination token

Lists responder gateways using a pagination token to get the next page

DATA(lo_result) = lo_client->listrespondergateways(
  iv_maxresults = 3
  iv_nexttoken = |eyJsYXN0RXZhbHVhdGVkS2V5Ijp7ImlkIjp7IlMiOiJydGJhcHAtcmVzcC01NDMyMSJ9fX0=|
).