/AWS1/IF_SGM=>LISTTRIALCOMPONENTS()

About ListTrialComponents

Lists the trial components in your account. You can sort the list by trial component name or creation time. You can filter the list to show only components that were created in a specific time range. You can also filter on one of the following:

• ExperimentName

• SourceArn

• TrialName

Method Signature

METHODS /AWS1/IF_SGM~LISTTRIALCOMPONENTS
  IMPORTING
    !IV_EXPERIMENTNAME TYPE /AWS1/SGMEXPERIMENTENTITYNAME OPTIONAL
    !IV_TRIALNAME TYPE /AWS1/SGMEXPERIMENTENTITYNAME OPTIONAL
    !IV_SOURCEARN TYPE /AWS1/SGMSTRING256 OPTIONAL
    !IV_CREATEDAFTER TYPE /AWS1/SGMTIMESTAMP OPTIONAL
    !IV_CREATEDBEFORE TYPE /AWS1/SGMTIMESTAMP OPTIONAL
    !IV_SORTBY TYPE /AWS1/SGMSORTTRIALCOMPONENTSBY 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_sgmlsttrialcomponen01
  RAISING
    /AWS1/CX_SGMRESOURCENOTFOUND
    /AWS1/CX_SGMCLIENTEXC
    /AWS1/CX_SGMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Optional arguments:

iv_experimentname TYPE /AWS1/SGMEXPERIMENTENTITYNAME /AWS1/SGMEXPERIMENTENTITYNAME

A filter that returns only components that are part of the specified experiment. If you specify ExperimentName, you can't filter by SourceArn or TrialName.

iv_trialname TYPE /AWS1/SGMEXPERIMENTENTITYNAME /AWS1/SGMEXPERIMENTENTITYNAME

A filter that returns only components that are part of the specified trial. If you specify TrialName, you can't filter by ExperimentName or SourceArn.

iv_sourcearn TYPE /AWS1/SGMSTRING256 /AWS1/SGMSTRING256

A filter that returns only components that have the specified source Amazon Resource Name (ARN). If you specify SourceArn, you can't filter by ExperimentName or TrialName.

iv_createdafter TYPE /AWS1/SGMTIMESTAMP /AWS1/SGMTIMESTAMP

A filter that returns only components created after the specified time.

iv_createdbefore TYPE /AWS1/SGMTIMESTAMP /AWS1/SGMTIMESTAMP

A filter that returns only components created before the specified time.

iv_sortby TYPE /AWS1/SGMSORTTRIALCOMPONENTSBY /AWS1/SGMSORTTRIALCOMPONENTSBY

The property used to sort results. The default value is CreationTime.

iv_sortorder TYPE /AWS1/SGMSORTORDER /AWS1/SGMSORTORDER

The sort order. The default value is Descending.

iv_maxresults TYPE /AWS1/SGMMAXRESULTS /AWS1/SGMMAXRESULTS

The maximum number of components to return in the response. The default value is 10.

iv_nexttoken TYPE /AWS1/SGMNEXTTOKEN /AWS1/SGMNEXTTOKEN

If the previous call to ListTrialComponents didn't return the full set of components, the call returns a token for getting the next set of components.

RETURNING

oo_output TYPE REF TO /aws1/cl_sgmlsttrialcomponen01 /AWS1/CL_SGMLSTTRIALCOMPONEN01

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->listtrialcomponents(
  iv_createdafter = '20150101000000.0000000'
  iv_createdbefore = '20150101000000.0000000'
  iv_experimentname = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_sortby = |string|
  iv_sortorder = |string|
  iv_sourcearn = |string|
  iv_trialname = |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_trialcomponentsummaries( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_experimententityname = lo_row_1->get_trialcomponentname( ).
      lv_trialcomponentarn = lo_row_1->get_trialcomponentarn( ).
      lv_experimententityname = lo_row_1->get_displayname( ).
      lo_trialcomponentsource = lo_row_1->get_trialcomponentsource( ).
      IF lo_trialcomponentsource IS NOT INITIAL.
        lv_trialcomponentsourcearn = lo_trialcomponentsource->get_sourcearn( ).
        lv_sourcetype = lo_trialcomponentsource->get_sourcetype( ).
      ENDIF.
      lo_trialcomponentstatus = lo_row_1->get_status( ).
      IF lo_trialcomponentstatus IS NOT INITIAL.
        lv_trialcomponentprimaryst = lo_trialcomponentstatus->get_primarystatus( ).
        lv_trialcomponentstatusmes = lo_trialcomponentstatus->get_message( ).
      ENDIF.
      lv_timestamp = lo_row_1->get_starttime( ).
      lv_timestamp = lo_row_1->get_endtime( ).
      lv_timestamp = lo_row_1->get_creationtime( ).
      lo_usercontext = lo_row_1->get_createdby( ).
      IF lo_usercontext IS NOT INITIAL.
        lv_string = lo_usercontext->get_userprofilearn( ).
        lv_string = lo_usercontext->get_userprofilename( ).
        lv_string = lo_usercontext->get_domainid( ).
        lo_iamidentity = lo_usercontext->get_iamidentity( ).
        IF lo_iamidentity IS NOT INITIAL.
          lv_string = lo_iamidentity->get_arn( ).
          lv_string = lo_iamidentity->get_principalid( ).
          lv_string = lo_iamidentity->get_sourceidentity( ).
        ENDIF.
      ENDIF.
      lv_timestamp = lo_row_1->get_lastmodifiedtime( ).
      lo_usercontext = lo_row_1->get_lastmodifiedby( ).
      IF lo_usercontext IS NOT INITIAL.
        lv_string = lo_usercontext->get_userprofilearn( ).
        lv_string = lo_usercontext->get_userprofilename( ).
        lv_string = lo_usercontext->get_domainid( ).
        lo_iamidentity = lo_usercontext->get_iamidentity( ).
        IF lo_iamidentity IS NOT INITIAL.
          lv_string = lo_iamidentity->get_arn( ).
          lv_string = lo_iamidentity->get_principalid( ).
          lv_string = lo_iamidentity->get_sourceidentity( ).
        ENDIF.
      ENDIF.
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.