Skip to content

/AWS1/IF_TBD=>STARTSESSIONSSTATISTICSAGGR()

About StartSessionsStatisticsAggregation

Starts an asynchronous request for getting aggregated statistics about queues and farms. Get the statistics using the GetSessionsStatisticsAggregation operation. You can only have one running aggregation for your Deadline Cloud farm. Call the GetSessionsStatisticsAggregation operation and check the status field to see if an aggregation is running. Statistics are available for 1 hour after you call the StartSessionsStatisticsAggregation operation.

Method Signature

METHODS /AWS1/IF_TBD~STARTSESSIONSSTATISTICSAGGR
  IMPORTING
    !IV_FARMID TYPE /AWS1/TBDFARMID OPTIONAL
    !IO_RESOURCEIDS TYPE REF TO /AWS1/CL_TBDSESSSSTATSRESRCS OPTIONAL
    !IV_STARTTIME TYPE /AWS1/TBDTIMESTAMP OPTIONAL
    !IV_ENDTIME TYPE /AWS1/TBDTIMESTAMP OPTIONAL
    !IV_TIMEZONE TYPE /AWS1/TBDTIMEZONE OPTIONAL
    !IV_PERIOD TYPE /AWS1/TBDPERIOD OPTIONAL
    !IT_GROUPBY TYPE /AWS1/CL_TBDUSAGEGROUPBY_W=>TT_USAGEGROUPBY OPTIONAL
    !IT_STATISTICS TYPE /AWS1/CL_TBDUSAGESTATISTICS_W=>TT_USAGESTATISTICS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_tbdstrtsesssstatsag01
  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 that contains queues or fleets to return statistics for.

io_resourceids TYPE REF TO /AWS1/CL_TBDSESSSSTATSRESRCS /AWS1/CL_TBDSESSSSTATSRESRCS

A list of fleet IDs or queue IDs to gather statistics for.

iv_starttime TYPE /AWS1/TBDTIMESTAMP /AWS1/TBDTIMESTAMP

The Linux timestamp of the date and time that the statistics start.

iv_endtime TYPE /AWS1/TBDTIMESTAMP /AWS1/TBDTIMESTAMP

The Linux timestamp of the date and time that the statistics end.

it_groupby TYPE /AWS1/CL_TBDUSAGEGROUPBY_W=>TT_USAGEGROUPBY TT_USAGEGROUPBY

The field to use to group the statistics.

it_statistics TYPE /AWS1/CL_TBDUSAGESTATISTICS_W=>TT_USAGESTATISTICS TT_USAGESTATISTICS

One to four statistics to return.

Optional arguments:

iv_timezone TYPE /AWS1/TBDTIMEZONE /AWS1/TBDTIMEZONE

The timezone to use for the statistics. Use UTC notation such as "UTC+8."

iv_period TYPE /AWS1/TBDPERIOD /AWS1/TBDPERIOD

The period to aggregate the statistics.

RETURNING

oo_output TYPE REF TO /aws1/cl_tbdstrtsesssstatsag01 /AWS1/CL_TBDSTRTSESSSSTATSAG01

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->startsessionsstatisticsaggr(
  io_resourceids = new /aws1/cl_tbdsesssstatsresrcs(
    it_fleetids = VALUE /aws1/cl_tbdfleetids_w=>tt_fleetids(
      ( new /aws1/cl_tbdfleetids_w( |string| ) )
    )
    it_queueids = VALUE /aws1/cl_tbdqueueids_w=>tt_queueids(
      ( new /aws1/cl_tbdqueueids_w( |string| ) )
    )
  )
  it_groupby = VALUE /aws1/cl_tbdusagegroupby_w=>tt_usagegroupby(
    ( new /aws1/cl_tbdusagegroupby_w( |string| ) )
  )
  it_statistics = VALUE /aws1/cl_tbdusagestatistics_w=>tt_usagestatistics(
    ( new /aws1/cl_tbdusagestatistics_w( |string| ) )
  )
  iv_endtime = '20150101000000.0000000'
  iv_farmid = |string|
  iv_period = |string|
  iv_starttime = '20150101000000.0000000'
  iv_timezone = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_aggregationid = lo_result->get_aggregationid( ).
ENDIF.