Skip to content

/AWS1/CL_GUPBTCGETFRAMEMETRI01

The structure representing the BatchGetFrameMetricDataResponse.

CONSTRUCTOR

IMPORTING

Required arguments:

iv_starttime TYPE /AWS1/GUPTIMESTAMP /AWS1/GUPTIMESTAMP

The start time of the time period for the returned time series values. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

iv_endtime TYPE /AWS1/GUPTIMESTAMP /AWS1/GUPTIMESTAMP

The end time of the time period for the returned time series values. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

iv_resolution TYPE /AWS1/GUPAGGREGATIONPERIOD /AWS1/GUPAGGREGATIONPERIOD

Resolution or granularity of the profile data used to generate the time series. This is the value used to jump through time steps in a time series. There are 3 valid values.

  • P1D — 1 day

  • PT1H — 1 hour

  • PT5M — 5 minutes

it_endtimes TYPE /AWS1/CL_GUPTIMESTAMPSTRUCTURE=>TT_LISTOFTIMESTAMPS TT_LISTOFTIMESTAMPS

List of instances, or time steps, in the time series. For example, if the period is one day (PT24H)), and the resolution is five minutes (PT5M), then there are 288 endTimes in the list that are each five minutes appart.

it_unprocessedendtimes TYPE /AWS1/CL_GUPTIMESTAMPSTRUCTURE=>TT_UNPROCESSEDENDTIMEMAP TT_UNPROCESSEDENDTIMEMAP

List of instances which remained unprocessed. This will create a missing time step in the list of end times.

it_framemetricdata TYPE /AWS1/CL_GUPFRAMEMETRICDATUM=>TT_FRAMEMETRICDATA TT_FRAMEMETRICDATA

Details of the metrics to request a time series of values. The metric includes the name of the frame, the aggregation type to calculate the metric value for the frame, and the thread states to use to get the count for the metric value of the frame.


Queryable Attributes

startTime

The start time of the time period for the returned time series values. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

Accessible with the following methods

Method Description
GET_STARTTIME() Getter for STARTTIME, with configurable default
ASK_STARTTIME() Getter for STARTTIME w/ exceptions if field has no value
HAS_STARTTIME() Determine if STARTTIME has a value

endTime

The end time of the time period for the returned time series values. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

Accessible with the following methods

Method Description
GET_ENDTIME() Getter for ENDTIME, with configurable default
ASK_ENDTIME() Getter for ENDTIME w/ exceptions if field has no value
HAS_ENDTIME() Determine if ENDTIME has a value

resolution

Resolution or granularity of the profile data used to generate the time series. This is the value used to jump through time steps in a time series. There are 3 valid values.

  • P1D — 1 day

  • PT1H — 1 hour

  • PT5M — 5 minutes

Accessible with the following methods

Method Description
GET_RESOLUTION() Getter for RESOLUTION, with configurable default
ASK_RESOLUTION() Getter for RESOLUTION w/ exceptions if field has no value
HAS_RESOLUTION() Determine if RESOLUTION has a value

endTimes

List of instances, or time steps, in the time series. For example, if the period is one day (PT24H)), and the resolution is five minutes (PT5M), then there are 288 endTimes in the list that are each five minutes appart.

Accessible with the following methods

Method Description
GET_ENDTIMES() Getter for ENDTIMES, with configurable default
ASK_ENDTIMES() Getter for ENDTIMES w/ exceptions if field has no value
HAS_ENDTIMES() Determine if ENDTIMES has a value

unprocessedEndTimes

List of instances which remained unprocessed. This will create a missing time step in the list of end times.

Accessible with the following methods

Method Description
GET_UNPROCESSEDENDTIMES() Getter for UNPROCESSEDENDTIMES, with configurable default
ASK_UNPROCESSEDENDTIMES() Getter for UNPROCESSEDENDTIMES w/ exceptions if field has no
HAS_UNPROCESSEDENDTIMES() Determine if UNPROCESSEDENDTIMES has a value

frameMetricData

Details of the metrics to request a time series of values. The metric includes the name of the frame, the aggregation type to calculate the metric value for the frame, and the thread states to use to get the count for the metric value of the frame.

Accessible with the following methods

Method Description
GET_FRAMEMETRICDATA() Getter for FRAMEMETRICDATA, with configurable default
ASK_FRAMEMETRICDATA() Getter for FRAMEMETRICDATA w/ exceptions if field has no val
HAS_FRAMEMETRICDATA() Determine if FRAMEMETRICDATA has a value