/AWS1/CL_IOTDSCFLEETMETRICRSP¶
DescribeFleetMetricResponse
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_metricname TYPE /AWS1/IOTFLEETMETRICNAME /AWS1/IOTFLEETMETRICNAME¶
The name of the fleet metric to describe.
iv_querystring TYPE /AWS1/IOTQUERYSTRING /AWS1/IOTQUERYSTRING¶
The search query string.
io_aggregationtype TYPE REF TO /AWS1/CL_IOTAGGREGATIONTYPE /AWS1/CL_IOTAGGREGATIONTYPE¶
The type of the aggregation query.
iv_period TYPE /AWS1/IOTFLEETMETRICPERIOD /AWS1/IOTFLEETMETRICPERIOD¶
The time in seconds between fleet metric emissions. Range [60(1 min), 86400(1 day)] and must be multiple of 60.
iv_aggregationfield TYPE /AWS1/IOTAGGREGATIONFIELD /AWS1/IOTAGGREGATIONFIELD¶
The field to aggregate.
iv_description TYPE /AWS1/IOTFLEETMETRICDESC /AWS1/IOTFLEETMETRICDESC¶
The fleet metric description.
iv_queryversion TYPE /AWS1/IOTQUERYVERSION /AWS1/IOTQUERYVERSION¶
The query version.
iv_indexname TYPE /AWS1/IOTINDEXNAME /AWS1/IOTINDEXNAME¶
The name of the index to search.
iv_creationdate TYPE /AWS1/IOTCREATIONDATE /AWS1/IOTCREATIONDATE¶
The date when the fleet metric is created.
iv_lastmodifieddate TYPE /AWS1/IOTLASTMODIFIEDDATE /AWS1/IOTLASTMODIFIEDDATE¶
The date when the fleet metric is last modified.
iv_unit TYPE /AWS1/IOTFLEETMETRICUNIT /AWS1/IOTFLEETMETRICUNIT¶
Used to support unit transformation such as milliseconds to seconds. The unit must be supported by CW metric.
iv_version TYPE /AWS1/IOTVERSION /AWS1/IOTVERSION¶
The version of the fleet metric.
iv_metricarn TYPE /AWS1/IOTFLEETMETRICARN /AWS1/IOTFLEETMETRICARN¶
The ARN of the fleet metric to describe.
Queryable Attributes¶
metricName¶
The name of the fleet metric to describe.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_METRICNAME() |
Getter for METRICNAME, with configurable default |
ASK_METRICNAME() |
Getter for METRICNAME w/ exceptions if field has no value |
HAS_METRICNAME() |
Determine if METRICNAME has a value |
queryString¶
The search query string.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_QUERYSTRING() |
Getter for QUERYSTRING, with configurable default |
ASK_QUERYSTRING() |
Getter for QUERYSTRING w/ exceptions if field has no value |
HAS_QUERYSTRING() |
Determine if QUERYSTRING has a value |
aggregationType¶
The type of the aggregation query.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_AGGREGATIONTYPE() |
Getter for AGGREGATIONTYPE |
period¶
The time in seconds between fleet metric emissions. Range [60(1 min), 86400(1 day)] and must be multiple of 60.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PERIOD() |
Getter for PERIOD, with configurable default |
ASK_PERIOD() |
Getter for PERIOD w/ exceptions if field has no value |
HAS_PERIOD() |
Determine if PERIOD has a value |
aggregationField¶
The field to aggregate.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_AGGREGATIONFIELD() |
Getter for AGGREGATIONFIELD, with configurable default |
ASK_AGGREGATIONFIELD() |
Getter for AGGREGATIONFIELD w/ exceptions if field has no va |
HAS_AGGREGATIONFIELD() |
Determine if AGGREGATIONFIELD has a value |
description¶
The fleet metric description.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DESCRIPTION() |
Getter for DESCRIPTION, with configurable default |
ASK_DESCRIPTION() |
Getter for DESCRIPTION w/ exceptions if field has no value |
HAS_DESCRIPTION() |
Determine if DESCRIPTION has a value |
queryVersion¶
The query version.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_QUERYVERSION() |
Getter for QUERYVERSION, with configurable default |
ASK_QUERYVERSION() |
Getter for QUERYVERSION w/ exceptions if field has no value |
HAS_QUERYVERSION() |
Determine if QUERYVERSION has a value |
indexName¶
The name of the index to search.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_INDEXNAME() |
Getter for INDEXNAME, with configurable default |
ASK_INDEXNAME() |
Getter for INDEXNAME w/ exceptions if field has no value |
HAS_INDEXNAME() |
Determine if INDEXNAME has a value |
creationDate¶
The date when the fleet metric is created.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREATIONDATE() |
Getter for CREATIONDATE, with configurable default |
ASK_CREATIONDATE() |
Getter for CREATIONDATE w/ exceptions if field has no value |
HAS_CREATIONDATE() |
Determine if CREATIONDATE has a value |
lastModifiedDate¶
The date when the fleet metric is last modified.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LASTMODIFIEDDATE() |
Getter for LASTMODIFIEDDATE, with configurable default |
ASK_LASTMODIFIEDDATE() |
Getter for LASTMODIFIEDDATE w/ exceptions if field has no va |
HAS_LASTMODIFIEDDATE() |
Determine if LASTMODIFIEDDATE has a value |
unit¶
Used to support unit transformation such as milliseconds to seconds. The unit must be supported by CW metric.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_UNIT() |
Getter for UNIT, with configurable default |
ASK_UNIT() |
Getter for UNIT w/ exceptions if field has no value |
HAS_UNIT() |
Determine if UNIT has a value |
version¶
The version of the fleet metric.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_VERSION() |
Getter for VERSION |
metricArn¶
The ARN of the fleet metric to describe.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_METRICARN() |
Getter for METRICARN, with configurable default |
ASK_METRICARN() |
Getter for METRICARN w/ exceptions if field has no value |
HAS_METRICARN() |
Determine if METRICARN has a value |