/AWS1/CL_IOSDSCGWCAPABILITYC01¶
DescribeGatewayCapabilityConfigurationResponse
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_gatewayid TYPE /AWS1/IOSID /AWS1/IOSID¶
The ID of the gateway that defines the capability configuration.
iv_capabilitynamespace TYPE /AWS1/IOSCAPABILITYNAMESPACE /AWS1/IOSCAPABILITYNAMESPACE¶
The namespace of the gateway capability.
iv_capabilityconfiguration TYPE /AWS1/IOSCAPABILITYCONF /AWS1/IOSCAPABILITYCONF¶
The JSON document that defines the gateway capability's configuration. For more information, see Configuring data sources (CLI) in the IoT SiteWise User Guide.
iv_capabilitysyncstatus TYPE /AWS1/IOSCAPABILITYSYNCSTATUS /AWS1/IOSCAPABILITYSYNCSTATUS¶
The synchronization status of the gateway capability configuration. The sync status can be one of the following:
IN_SYNC- The gateway is running with the latest configuration.
OUT_OF_SYNC- The gateway hasn't received the latest configuration.
SYNC_FAILED- The gateway rejected the latest configuration.
UNKNOWN- The gateway hasn't reported its sync status.
NOT_APPLICABLE- The gateway doesn't support this capability. This is most common when integrating partner data sources, because the data integration is handled externally by the partner.
Queryable Attributes¶
gatewayId¶
The ID of the gateway that defines the capability configuration.
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 |
capabilityNamespace¶
The namespace of the gateway capability.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CAPABILITYNAMESPACE() |
Getter for CAPABILITYNAMESPACE, with configurable default |
ASK_CAPABILITYNAMESPACE() |
Getter for CAPABILITYNAMESPACE w/ exceptions if field has no |
HAS_CAPABILITYNAMESPACE() |
Determine if CAPABILITYNAMESPACE has a value |
capabilityConfiguration¶
The JSON document that defines the gateway capability's configuration. For more information, see Configuring data sources (CLI) in the IoT SiteWise User Guide.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CAPABILITYCONFIGURATION() |
Getter for CAPABILITYCONFIGURATION, with configurable defaul |
ASK_CAPABILITYCONFIGURATION() |
Getter for CAPABILITYCONFIGURATION w/ exceptions if field ha |
HAS_CAPABILITYCONFIGURATION() |
Determine if CAPABILITYCONFIGURATION has a value |
capabilitySyncStatus¶
The synchronization status of the gateway capability configuration. The sync status can be one of the following:
IN_SYNC- The gateway is running with the latest configuration.
OUT_OF_SYNC- The gateway hasn't received the latest configuration.
SYNC_FAILED- The gateway rejected the latest configuration.
UNKNOWN- The gateway hasn't reported its sync status.
NOT_APPLICABLE- The gateway doesn't support this capability. This is most common when integrating partner data sources, because the data integration is handled externally by the partner.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CAPABILITYSYNCSTATUS() |
Getter for CAPABILITYSYNCSTATUS, with configurable default |
ASK_CAPABILITYSYNCSTATUS() |
Getter for CAPABILITYSYNCSTATUS w/ exceptions if field has n |
HAS_CAPABILITYSYNCSTATUS() |
Determine if CAPABILITYSYNCSTATUS has a value |