/AWS1/CL_IOSGATEWAYSUMMARY

Contains a summary of a gateway.

CONSTRUCTOR

IMPORTING

Required arguments:

iv_gatewayid TYPE /AWS1/IOSID /AWS1/IOSID

The ID of the gateway device.

iv_gatewayname TYPE /AWS1/IOSGATEWAYNAME /AWS1/IOSGATEWAYNAME

The name of the gateway.

iv_creationdate TYPE /AWS1/IOSTIMESTAMP /AWS1/IOSTIMESTAMP

The date the gateway was created, in Unix epoch time.

iv_lastupdatedate TYPE /AWS1/IOSTIMESTAMP /AWS1/IOSTIMESTAMP

The date the gateway was last updated, in Unix epoch time.

Optional arguments:

io_gatewayplatform TYPE REF TO /AWS1/CL_IOSGATEWAYPLATFORM /AWS1/CL_IOSGATEWAYPLATFORM

The gateway's platform configuration. You can only specify one platform type in a gateway.

(Legacy only) For Greengrass V1 gateways, specify the greengrass parameter with a valid Greengrass group ARN.

For Greengrass V2 gateways, specify the greengrassV2 parameter with a valid core device thing name. If creating a V3 gateway (gatewayVersion=3), you must also specify the coreDeviceOperatingSystem.

For Siemens Industrial Edge gateways, specify the siemensIE parameter with a valid IoT Core thing name.

iv_gatewayversion TYPE /AWS1/IOSGATEWAYVERSION /AWS1/IOSGATEWAYVERSION

The version of the gateway. A value of 3 indicates an MQTT-enabled, V3 gateway, while 2 indicates a Classic streams, V2 gateway.

it_gatewaycapabilitysums TYPE /AWS1/CL_IOSGWCAPABILITYSUMM=>TT_GATEWAYCAPABILITYSUMMARIES TT_GATEWAYCAPABILITYSUMMARIES

A list of gateway capability summaries that each contain a namespace and status. Each gateway capability defines data sources for the gateway. To retrieve a capability configuration's definition, use DescribeGatewayCapabilityConfiguration.

---

Queryable Attributes

gatewayId

The ID of the gateway device.

Accessible with the following methods

Method	Description
GET_GATEWAYID()	Getter for GATEWAYID, with configurable default
ASK_GATEWAYID()	Getter for GATEWAYID w/ exceptions if field has no value
HAS_GATEWAYID()	Determine if GATEWAYID has a value

gatewayName

The name of the gateway.

Accessible with the following methods

Method	Description
GET_GATEWAYNAME()	Getter for GATEWAYNAME, with configurable default
ASK_GATEWAYNAME()	Getter for GATEWAYNAME w/ exceptions if field has no value
HAS_GATEWAYNAME()	Determine if GATEWAYNAME has a value

gatewayPlatform

The gateway's platform configuration. You can only specify one platform type in a gateway.

(Legacy only) For Greengrass V1 gateways, specify the greengrass parameter with a valid Greengrass group ARN.

For Greengrass V2 gateways, specify the greengrassV2 parameter with a valid core device thing name. If creating a V3 gateway (gatewayVersion=3), you must also specify the coreDeviceOperatingSystem.

For Siemens Industrial Edge gateways, specify the siemensIE parameter with a valid IoT Core thing name.

Accessible with the following methods

Method	Description
GET_GATEWAYPLATFORM()	Getter for GATEWAYPLATFORM

gatewayVersion

The version of the gateway. A value of 3 indicates an MQTT-enabled, V3 gateway, while 2 indicates a Classic streams, V2 gateway.

Accessible with the following methods

Method	Description
GET_GATEWAYVERSION()	Getter for GATEWAYVERSION, with configurable default
ASK_GATEWAYVERSION()	Getter for GATEWAYVERSION w/ exceptions if field has no valu
HAS_GATEWAYVERSION()	Determine if GATEWAYVERSION has a value

gatewayCapabilitySummaries

A list of gateway capability summaries that each contain a namespace and status. Each gateway capability defines data sources for the gateway. To retrieve a capability configuration's definition, use DescribeGatewayCapabilityConfiguration.

Accessible with the following methods

Method	Description
GET_GATEWAYCAPABILITYSUMS()	Getter for GATEWAYCAPABILITYSUMMARIES, with configurable def
ASK_GATEWAYCAPABILITYSUMS()	Getter for GATEWAYCAPABILITYSUMMARIES w/ exceptions if field
HAS_GATEWAYCAPABILITYSUMS()	Determine if GATEWAYCAPABILITYSUMMARIES has a value

creationDate

The date the gateway was created, in Unix epoch time.

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

lastUpdateDate

The date the gateway was last updated, in Unix epoch time.

Accessible with the following methods

Method	Description
GET_LASTUPDATEDATE()	Getter for LASTUPDATEDATE, with configurable default
ASK_LASTUPDATEDATE()	Getter for LASTUPDATEDATE w/ exceptions if field has no valu
HAS_LASTUPDATEDATE()	Determine if LASTUPDATEDATE has a value

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_GATEWAYSUMMARIES

TYPES TT_GATEWAYSUMMARIES TYPE STANDARD TABLE OF REF TO /AWS1/CL_IOSGATEWAYSUMMARY WITH DEFAULT KEY
.