LISTCOMPONENTS()`¶

About ListComponents¶

List components with summary data. You can filter the result list by environment, service, or a single service instance.

For more information about components, see Proton components in the Proton User Guide.

Method Signature¶

METHODS /AWS1/IF_PRN~LISTCOMPONENTS
  IMPORTING
    !IV_NEXTTOKEN TYPE /AWS1/PRNNEXTTOKEN OPTIONAL
    !IV_ENVIRONMENTNAME TYPE /AWS1/PRNRESOURCENAME OPTIONAL
    !IV_SERVICENAME TYPE /AWS1/PRNRESOURCENAME OPTIONAL
    !IV_SERVICEINSTANCENAME TYPE /AWS1/PRNRESOURCENAME OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/PRNMAXPAGERESULTS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_prnlistcomponentsout
  RAISING
    /AWS1/CX_PRNACCESSDENIEDEX
    /AWS1/CX_PRNINTERNALSERVEREX
    /AWS1/CX_PRNTHROTTLINGEX
    /AWS1/CX_PRNVALIDATIONEX
    /AWS1/CX_PRNCLIENTEXC
    /AWS1/CX_PRNSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`iv_nexttoken` `TYPE /AWS1/PRNNEXTTOKEN` `/AWS1/PRNNEXTTOKEN`¶

A token that indicates the location of the next component in the array of components, after the list of components that was previously requested.

`iv_environmentname` `TYPE /AWS1/PRNRESOURCENAME` `/AWS1/PRNRESOURCENAME`¶

The name of an environment for result list filtering. Proton returns components associated with the environment or attached to service instances running in it.

`iv_servicename` `TYPE /AWS1/PRNRESOURCENAME` `/AWS1/PRNRESOURCENAME`¶

The name of a service for result list filtering. Proton returns components attached to service instances of the service.

`iv_serviceinstancename` `TYPE /AWS1/PRNRESOURCENAME` `/AWS1/PRNRESOURCENAME`¶

The name of a service instance for result list filtering. Proton returns the component attached to the service instance, if any.

`iv_maxresults` `TYPE /AWS1/PRNMAXPAGERESULTS` `/AWS1/PRNMAXPAGERESULTS`¶

The maximum number of components to list.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_prnlistcomponentsout` `/AWS1/CL_PRNLISTCOMPONENTSOUT`¶

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->listcomponents(
  iv_environmentname = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_serviceinstancename = |string|
  iv_servicename = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_nexttoken = lo_result->get_nexttoken( ).
  LOOP AT lo_result->get_components( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_resourcename = lo_row_1->get_name( ).
      lv_componentarn = lo_row_1->get_arn( ).
      lv_resourcename = lo_row_1->get_environmentname( ).
      lv_resourcename = lo_row_1->get_servicename( ).
      lv_resourcename = lo_row_1->get_serviceinstancename( ).
      lv_timestamp = lo_row_1->get_createdat( ).
      lv_timestamp = lo_row_1->get_lastmodifiedat( ).
      lv_timestamp = lo_row_1->get_lastdeploymentattempte00( ).
      lv_timestamp = lo_row_1->get_lastdeploymentsuccat( ).
      lv_deploymentstatus = lo_row_1->get_deploymentstatus( ).
      lv_statusmessage = lo_row_1->get_deploymentstatusmessage( ).
      lv_deploymentid = lo_row_1->get_lastattempteddeploymen00( ).
      lv_deploymentid = lo_row_1->get_lastsuccdeploymentid( ).
    ENDIF.
  ENDLOOP.
ENDIF.

/AWS1/IF_PRN=>LISTCOMPONENTS()¶