Skip to content

/AWS1/CL_IOTTOPICRULEPAYLOAD

Describes a rule.

CONSTRUCTOR

IMPORTING

Required arguments:

IV_SQL TYPE /AWS1/IOTSQL /AWS1/IOTSQL

The SQL statement used to query the topic. For more information, see IoT SQL Reference in the IoT Developer Guide.

IT_ACTIONS TYPE /AWS1/CL_IOTACTION=>TT_ACTIONLIST TT_ACTIONLIST

The actions associated with the rule.

Optional arguments:

IV_DESCRIPTION TYPE /AWS1/IOTDESCRIPTION /AWS1/IOTDESCRIPTION

The description of the rule.

IV_RULEDISABLED TYPE /AWS1/IOTISDISABLED /AWS1/IOTISDISABLED

Specifies whether the rule is disabled.

IV_AWSIOTSQLVERSION TYPE /AWS1/IOTAWSIOTSQLVERSION /AWS1/IOTAWSIOTSQLVERSION

The version of the SQL rules engine to use when evaluating the rule.

IO_ERRORACTION TYPE REF TO /AWS1/CL_IOTACTION /AWS1/CL_IOTACTION

The action to take when an error occurs.


Queryable Attributes

sql

The SQL statement used to query the topic. For more information, see IoT SQL Reference in the IoT Developer Guide.

Accessible with the following methods

Method Description
GET_SQL() Getter for SQL, with configurable default
ASK_SQL() Getter for SQL w/ exceptions if field has no value
HAS_SQL() Determine if SQL has a value

description

The description of the rule.

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

actions

The actions associated with the rule.

Accessible with the following methods

Method Description
GET_ACTIONS() Getter for ACTIONS, with configurable default
ASK_ACTIONS() Getter for ACTIONS w/ exceptions if field has no value
HAS_ACTIONS() Determine if ACTIONS has a value

ruleDisabled

Specifies whether the rule is disabled.

Accessible with the following methods

Method Description
GET_RULEDISABLED() Getter for RULEDISABLED, with configurable default
ASK_RULEDISABLED() Getter for RULEDISABLED w/ exceptions if field has no value
HAS_RULEDISABLED() Determine if RULEDISABLED has a value

awsIotSqlVersion

The version of the SQL rules engine to use when evaluating the rule.

Accessible with the following methods

Method Description
GET_AWSIOTSQLVERSION() Getter for AWSIOTSQLVERSION, with configurable default
ASK_AWSIOTSQLVERSION() Getter for AWSIOTSQLVERSION w/ exceptions if field has no va
HAS_AWSIOTSQLVERSION() Determine if AWSIOTSQLVERSION has a value

errorAction

The action to take when an error occurs.

Accessible with the following methods

Method Description
GET_ERRORACTION() Getter for ERRORACTION