Skip to content

/AWS1/IF_SGM=>LISTHUBS()

About ListHubs

List all existing hubs.

Method Signature

METHODS /AWS1/IF_SGM~LISTHUBS
  IMPORTING
    !IV_NAMECONTAINS TYPE /AWS1/SGMNAMECONTAINS OPTIONAL
    !IV_CREATIONTIMEBEFORE TYPE /AWS1/SGMTIMESTAMP OPTIONAL
    !IV_CREATIONTIMEAFTER TYPE /AWS1/SGMTIMESTAMP OPTIONAL
    !IV_LASTMODIFIEDTIMEBEFORE TYPE /AWS1/SGMTIMESTAMP OPTIONAL
    !IV_LASTMODIFIEDTIMEAFTER TYPE /AWS1/SGMTIMESTAMP OPTIONAL
    !IV_SORTBY TYPE /AWS1/SGMHUBSORTBY OPTIONAL
    !IV_SORTORDER TYPE /AWS1/SGMSORTORDER OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/SGMMAXRESULTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/SGMNEXTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_sgmlisthubsresponse
  RAISING
    /AWS1/CX_SGMCLIENTEXC
    /AWS1/CX_SGMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Optional arguments:

iv_namecontains TYPE /AWS1/SGMNAMECONTAINS /AWS1/SGMNAMECONTAINS

Only list hubs with names that contain the specified string.

iv_creationtimebefore TYPE /AWS1/SGMTIMESTAMP /AWS1/SGMTIMESTAMP

Only list hubs that were created before the time specified.

iv_creationtimeafter TYPE /AWS1/SGMTIMESTAMP /AWS1/SGMTIMESTAMP

Only list hubs that were created after the time specified.

iv_lastmodifiedtimebefore TYPE /AWS1/SGMTIMESTAMP /AWS1/SGMTIMESTAMP

Only list hubs that were last modified before the time specified.

iv_lastmodifiedtimeafter TYPE /AWS1/SGMTIMESTAMP /AWS1/SGMTIMESTAMP

Only list hubs that were last modified after the time specified.

iv_sortby TYPE /AWS1/SGMHUBSORTBY /AWS1/SGMHUBSORTBY

Sort hubs by either name or creation time.

iv_sortorder TYPE /AWS1/SGMSORTORDER /AWS1/SGMSORTORDER

Sort hubs by ascending or descending order.

iv_maxresults TYPE /AWS1/SGMMAXRESULTS /AWS1/SGMMAXRESULTS

The maximum number of hubs to list.

iv_nexttoken TYPE /AWS1/SGMNEXTTOKEN /AWS1/SGMNEXTTOKEN

If the response to a previous ListHubs request was truncated, the response includes a NextToken. To retrieve the next set of hubs, use the token in the next request.

RETURNING

oo_output TYPE REF TO /aws1/cl_sgmlisthubsresponse /AWS1/CL_SGMLISTHUBSRESPONSE

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->listhubs(
  iv_creationtimeafter = '20150101000000.0000000'
  iv_creationtimebefore = '20150101000000.0000000'
  iv_lastmodifiedtimeafter = '20150101000000.0000000'
  iv_lastmodifiedtimebefore = '20150101000000.0000000'
  iv_maxresults = 123
  iv_namecontains = |string|
  iv_nexttoken = |string|
  iv_sortby = |string|
  iv_sortorder = |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_hubsummaries( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_hubname = lo_row_1->get_hubname( ).
      lv_hubarn = lo_row_1->get_hubarn( ).
      lv_hubdisplayname = lo_row_1->get_hubdisplayname( ).
      lv_hubdescription = lo_row_1->get_hubdescription( ).
      LOOP AT lo_row_1->get_hubsearchkeywords( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_hubsearchkeyword = lo_row_3->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_hubstatus = lo_row_1->get_hubstatus( ).
      lv_timestamp = lo_row_1->get_creationtime( ).
      lv_timestamp = lo_row_1->get_lastmodifiedtime( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.