/AWS1/CL_IOACHANNEL¶
A collection of data from an MQTT topic. Channels archive the raw, unprocessed messages before publishing the data to a pipeline.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_name TYPE /AWS1/IOACHANNELNAME /AWS1/IOACHANNELNAME¶
The name of the channel.
io_storage TYPE REF TO /AWS1/CL_IOACHANNELSTORAGE /AWS1/CL_IOACHANNELSTORAGE¶
Where channel data is stored. You can choose one of
serviceManagedS3orcustomerManagedS3storage. If not specified, the default isserviceManagedS3. You can't change this storage option after the channel is created.
iv_arn TYPE /AWS1/IOACHANNELARN /AWS1/IOACHANNELARN¶
The ARN of the channel.
iv_status TYPE /AWS1/IOACHANNELSTATUS /AWS1/IOACHANNELSTATUS¶
The status of the channel.
io_retentionperiod TYPE REF TO /AWS1/CL_IOARETENTIONPERIOD /AWS1/CL_IOARETENTIONPERIOD¶
How long, in days, message data is kept for the channel.
iv_creationtime TYPE /AWS1/IOATIMESTAMP /AWS1/IOATIMESTAMP¶
When the channel was created.
iv_lastupdatetime TYPE /AWS1/IOATIMESTAMP /AWS1/IOATIMESTAMP¶
When the channel was last updated.
iv_lastmessagearrivaltime TYPE /AWS1/IOATIMESTAMP /AWS1/IOATIMESTAMP¶
The last time when a new message arrived in the channel.
IoT Analytics updates this value at most once per minute for one channel. Hence, the
lastMessageArrivalTimevalue is an approximation.This feature only applies to messages that arrived in the data store after October 23, 2020.
Queryable Attributes¶
name¶
The name of the channel.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NAME() |
Getter for NAME, with configurable default |
ASK_NAME() |
Getter for NAME w/ exceptions if field has no value |
HAS_NAME() |
Determine if NAME has a value |
storage¶
Where channel data is stored. You can choose one of
serviceManagedS3orcustomerManagedS3storage. If not specified, the default isserviceManagedS3. You can't change this storage option after the channel is created.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STORAGE() |
Getter for STORAGE |
arn¶
The ARN of the channel.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ARN() |
Getter for ARN, with configurable default |
ASK_ARN() |
Getter for ARN w/ exceptions if field has no value |
HAS_ARN() |
Determine if ARN has a value |
status¶
The status of the channel.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATUS() |
Getter for STATUS, with configurable default |
ASK_STATUS() |
Getter for STATUS w/ exceptions if field has no value |
HAS_STATUS() |
Determine if STATUS has a value |
retentionPeriod¶
How long, in days, message data is kept for the channel.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RETENTIONPERIOD() |
Getter for RETENTIONPERIOD |
creationTime¶
When the channel was created.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREATIONTIME() |
Getter for CREATIONTIME, with configurable default |
ASK_CREATIONTIME() |
Getter for CREATIONTIME w/ exceptions if field has no value |
HAS_CREATIONTIME() |
Determine if CREATIONTIME has a value |
lastUpdateTime¶
When the channel was last updated.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LASTUPDATETIME() |
Getter for LASTUPDATETIME, with configurable default |
ASK_LASTUPDATETIME() |
Getter for LASTUPDATETIME w/ exceptions if field has no valu |
HAS_LASTUPDATETIME() |
Determine if LASTUPDATETIME has a value |
lastMessageArrivalTime¶
The last time when a new message arrived in the channel.
IoT Analytics updates this value at most once per minute for one channel. Hence, the
lastMessageArrivalTimevalue is an approximation.This feature only applies to messages that arrived in the data store after October 23, 2020.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LASTMESSAGEARRIVALTIME() |
Getter for LASTMESSAGEARRIVALTIME, with configurable default |
ASK_LASTMESSAGEARRIVALTIME() |
Getter for LASTMESSAGEARRIVALTIME w/ exceptions if field has |
HAS_LASTMESSAGEARRIVALTIME() |
Determine if LASTMESSAGEARRIVALTIME has a value |