GETSESSIONSSTATISTICSAGGR()`¶

About GetSessionsStatisticsAggregation¶

Gets a set of statistics for queues or farms. Before you can call the GetSessionStatisticsAggregation operation, you must first call the StartSessionsStatisticsAggregation operation. Statistics are available for 1 hour after you call the StartSessionsStatisticsAggregation operation.

Method Signature¶

METHODS /AWS1/IF_TBD~GETSESSIONSSTATISTICSAGGR
  IMPORTING
    !IV_FARMID TYPE /AWS1/TBDFARMID OPTIONAL
    !IV_AGGREGATIONID TYPE /AWS1/TBDAGGREGATIONID OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/TBDMAXRESULTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/TBDSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_tbdgetsesssstatsagg01
  RAISING
    /AWS1/CX_TBDACCESSDENIEDEX
    /AWS1/CX_TBDINTERNALSERVERER00
    /AWS1/CX_TBDRESOURCENOTFOUNDEX
    /AWS1/CX_TBDTHROTTLINGEX
    /AWS1/CX_TBDVALIDATIONEX
    /AWS1/CX_TBDCLIENTEXC
    /AWS1/CX_TBDSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_farmid` `TYPE /AWS1/TBDFARMID` `/AWS1/TBDFARMID`¶

The identifier of the farm to include in the statistics. This should be the same as the farm ID used in the call to the StartSessionsStatisticsAggregation operation.

`iv_aggregationid` `TYPE /AWS1/TBDAGGREGATIONID` `/AWS1/TBDAGGREGATIONID`¶

The identifier returned by the StartSessionsStatisticsAggregation operation that identifies the aggregated statistics.

Optional arguments:¶

`iv_maxresults` `TYPE /AWS1/TBDMAXRESULTS` `/AWS1/TBDMAXRESULTS`¶

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

`iv_nexttoken` `TYPE /AWS1/TBDSTRING` `/AWS1/TBDSTRING`¶

The token for the next set of results, or null to start from the beginning.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_tbdgetsesssstatsagg01` `/AWS1/CL_TBDGETSESSSSTATSAGG01`¶

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->getsessionsstatisticsaggr(
  iv_aggregationid = |string|
  iv_farmid = |string|
  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_statistics( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_queueid = lo_row_1->get_queueid( ).
      lv_fleetid = lo_row_1->get_fleetid( ).
      lv_jobid = lo_row_1->get_jobid( ).
      lv_jobname = lo_row_1->get_jobname( ).
      lv_userid = lo_row_1->get_userid( ).
      lv_usagetype = lo_row_1->get_usagetype( ).
      lv_licenseproduct = lo_row_1->get_licenseproduct( ).
      lv_instancetype = lo_row_1->get_instancetype( ).
      lv_integer = lo_row_1->get_count( ).
      lo_stats = lo_row_1->get_costinusd( ).
      IF lo_stats IS NOT INITIAL.
        lv_double = lo_stats->get_min( ).
        lv_double = lo_stats->get_max( ).
        lv_double = lo_stats->get_avg( ).
        lv_double = lo_stats->get_sum( ).
      ENDIF.
      lo_stats = lo_row_1->get_runtimeinseconds( ).
      IF lo_stats IS NOT INITIAL.
        lv_double = lo_stats->get_min( ).
        lv_double = lo_stats->get_max( ).
        lv_double = lo_stats->get_avg( ).
        lv_double = lo_stats->get_sum( ).
      ENDIF.
      lv_timestamp = lo_row_1->get_aggregationstarttime( ).
      lv_timestamp = lo_row_1->get_aggregationendtime( ).
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_nexttoken( ).
  lv_sessionsstatisticsaggre = lo_result->get_status( ).
  lv_string = lo_result->get_statusmessage( ).
ENDIF.

/AWS1/IF_TBD=>GETSESSIONSSTATISTICSAGGR()¶