Skip to content

/AWS1/IF_GUP=>LISTPROFILETIMES()

About ListProfileTimes

Lists the start times of the available aggregated profiles of a profiling group for an aggregation period within the specified time range.

Method Signature

METHODS /AWS1/IF_GUP~LISTPROFILETIMES
  IMPORTING
    !IV_PROFILINGGROUPNAME TYPE /AWS1/GUPPROFILINGGROUPNAME OPTIONAL
    !IV_STARTTIME TYPE /AWS1/GUPTIMESTAMP OPTIONAL
    !IV_ENDTIME TYPE /AWS1/GUPTIMESTAMP OPTIONAL
    !IV_PERIOD TYPE /AWS1/GUPAGGREGATIONPERIOD OPTIONAL
    !IV_ORDERBY TYPE /AWS1/GUPORDERBY OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/GUPMAXRESULTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/GUPPAGINATIONTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_guplistpfltimesrsp
  RAISING
    /AWS1/CX_GUPINTERNALSERVEREX
    /AWS1/CX_GUPRESOURCENOTFOUNDEX
    /AWS1/CX_GUPTHROTTLINGEX
    /AWS1/CX_GUPVALIDATIONEX
    /AWS1/CX_GUPCLIENTEXC
    /AWS1/CX_GUPSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_profilinggroupname TYPE /AWS1/GUPPROFILINGGROUPNAME /AWS1/GUPPROFILINGGROUPNAME

The name of the profiling group.

iv_starttime TYPE /AWS1/GUPTIMESTAMP /AWS1/GUPTIMESTAMP

The start time of the time range from which to list the profiles.

iv_endtime TYPE /AWS1/GUPTIMESTAMP /AWS1/GUPTIMESTAMP

The end time of the time range from which to list the profiles.

iv_period TYPE /AWS1/GUPAGGREGATIONPERIOD /AWS1/GUPAGGREGATIONPERIOD

The aggregation period. This specifies the period during which an aggregation profile collects posted agent profiles for a profiling group. There are 3 valid values.

  • P1D — 1 day

  • PT1H — 1 hour

  • PT5M — 5 minutes

Optional arguments:

iv_orderby TYPE /AWS1/GUPORDERBY /AWS1/GUPORDERBY

The order (ascending or descending by start time of the profile) to use when listing profiles. Defaults to TIMESTAMP_DESCENDING.

iv_maxresults TYPE /AWS1/GUPMAXRESULTS /AWS1/GUPMAXRESULTS

The maximum number of profile time results returned by ListProfileTimes in paginated output. When this parameter is used, ListProfileTimes only returns maxResults results in a single page with a nextToken response element. The remaining results of the initial request can be seen by sending another ListProfileTimes request with the returned nextToken value.

iv_nexttoken TYPE /AWS1/GUPPAGINATIONTOKEN /AWS1/GUPPAGINATIONTOKEN

The nextToken value returned from a previous paginated ListProfileTimes request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

RETURNING

oo_output TYPE REF TO /aws1/cl_guplistpfltimesrsp /AWS1/CL_GUPLISTPFLTIMESRSP

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->listprofiletimes(
  iv_endtime = '20150101000000.0000000'
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_orderby = |string|
  iv_period = |string|
  iv_profilinggroupname = |string|
  iv_starttime = '20150101000000.0000000'
).

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_profiletimes( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_timestamp = lo_row_1->get_start( ).
    ENDIF.
  ENDLOOP.
  lv_paginationtoken = lo_result->get_nexttoken( ).
ENDIF.