AWS SDK for C++  1.8.182
AWS SDK for C++
Public Member Functions | List of all members
Aws::IoT::Model::TopicRule Class Reference

#include <TopicRule.h>

Public Member Functions

 TopicRule ()
 
 TopicRule (Aws::Utils::Json::JsonView jsonValue)
 
TopicRuleoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetRuleName () const
 
bool RuleNameHasBeenSet () const
 
void SetRuleName (const Aws::String &value)
 
void SetRuleName (Aws::String &&value)
 
void SetRuleName (const char *value)
 
TopicRuleWithRuleName (const Aws::String &value)
 
TopicRuleWithRuleName (Aws::String &&value)
 
TopicRuleWithRuleName (const char *value)
 
const Aws::StringGetSql () const
 
bool SqlHasBeenSet () const
 
void SetSql (const Aws::String &value)
 
void SetSql (Aws::String &&value)
 
void SetSql (const char *value)
 
TopicRuleWithSql (const Aws::String &value)
 
TopicRuleWithSql (Aws::String &&value)
 
TopicRuleWithSql (const char *value)
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
TopicRuleWithDescription (const Aws::String &value)
 
TopicRuleWithDescription (Aws::String &&value)
 
TopicRuleWithDescription (const char *value)
 
const Aws::Utils::DateTimeGetCreatedAt () const
 
bool CreatedAtHasBeenSet () const
 
void SetCreatedAt (const Aws::Utils::DateTime &value)
 
void SetCreatedAt (Aws::Utils::DateTime &&value)
 
TopicRuleWithCreatedAt (const Aws::Utils::DateTime &value)
 
TopicRuleWithCreatedAt (Aws::Utils::DateTime &&value)
 
const Aws::Vector< Action > & GetActions () const
 
bool ActionsHasBeenSet () const
 
void SetActions (const Aws::Vector< Action > &value)
 
void SetActions (Aws::Vector< Action > &&value)
 
TopicRuleWithActions (const Aws::Vector< Action > &value)
 
TopicRuleWithActions (Aws::Vector< Action > &&value)
 
TopicRuleAddActions (const Action &value)
 
TopicRuleAddActions (Action &&value)
 
bool GetRuleDisabled () const
 
bool RuleDisabledHasBeenSet () const
 
void SetRuleDisabled (bool value)
 
TopicRuleWithRuleDisabled (bool value)
 
const Aws::StringGetAwsIotSqlVersion () const
 
bool AwsIotSqlVersionHasBeenSet () const
 
void SetAwsIotSqlVersion (const Aws::String &value)
 
void SetAwsIotSqlVersion (Aws::String &&value)
 
void SetAwsIotSqlVersion (const char *value)
 
TopicRuleWithAwsIotSqlVersion (const Aws::String &value)
 
TopicRuleWithAwsIotSqlVersion (Aws::String &&value)
 
TopicRuleWithAwsIotSqlVersion (const char *value)
 
const ActionGetErrorAction () const
 
bool ErrorActionHasBeenSet () const
 
void SetErrorAction (const Action &value)
 
void SetErrorAction (Action &&value)
 
TopicRuleWithErrorAction (const Action &value)
 
TopicRuleWithErrorAction (Action &&value)
 

Detailed Description

Describes a rule.

See Also:

AWS API Reference

Definition at line 34 of file TopicRule.h.

Constructor & Destructor Documentation

◆ TopicRule() [1/2]

Aws::IoT::Model::TopicRule::TopicRule ( )

◆ TopicRule() [2/2]

Aws::IoT::Model::TopicRule::TopicRule ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ ActionsHasBeenSet()

bool Aws::IoT::Model::TopicRule::ActionsHasBeenSet ( ) const
inline

The actions associated with the rule.

Definition at line 213 of file TopicRule.h.

◆ AddActions() [1/2]

TopicRule& Aws::IoT::Model::TopicRule::AddActions ( Action &&  value)
inline

The actions associated with the rule.

Definition at line 243 of file TopicRule.h.

◆ AddActions() [2/2]

TopicRule& Aws::IoT::Model::TopicRule::AddActions ( const Action value)
inline

The actions associated with the rule.

Definition at line 238 of file TopicRule.h.

◆ AwsIotSqlVersionHasBeenSet()

bool Aws::IoT::Model::TopicRule::AwsIotSqlVersionHasBeenSet ( ) const
inline

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

Definition at line 275 of file TopicRule.h.

◆ CreatedAtHasBeenSet()

bool Aws::IoT::Model::TopicRule::CreatedAtHasBeenSet ( ) const
inline

The date and time the rule was created.

Definition at line 182 of file TopicRule.h.

◆ DescriptionHasBeenSet()

bool Aws::IoT::Model::TopicRule::DescriptionHasBeenSet ( ) const
inline

The description of the rule.

Definition at line 141 of file TopicRule.h.

◆ ErrorActionHasBeenSet()

bool Aws::IoT::Model::TopicRule::ErrorActionHasBeenSet ( ) const
inline

The action to perform when an error occurs.

Definition at line 316 of file TopicRule.h.

◆ GetActions()

const Aws::Vector<Action>& Aws::IoT::Model::TopicRule::GetActions ( ) const
inline

The actions associated with the rule.

Definition at line 208 of file TopicRule.h.

◆ GetAwsIotSqlVersion()

const Aws::String& Aws::IoT::Model::TopicRule::GetAwsIotSqlVersion ( ) const
inline

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

Definition at line 270 of file TopicRule.h.

◆ GetCreatedAt()

const Aws::Utils::DateTime& Aws::IoT::Model::TopicRule::GetCreatedAt ( ) const
inline

The date and time the rule was created.

Definition at line 177 of file TopicRule.h.

◆ GetDescription()

const Aws::String& Aws::IoT::Model::TopicRule::GetDescription ( ) const
inline

The description of the rule.

Definition at line 136 of file TopicRule.h.

◆ GetErrorAction()

const Action& Aws::IoT::Model::TopicRule::GetErrorAction ( ) const
inline

The action to perform when an error occurs.

Definition at line 311 of file TopicRule.h.

◆ GetRuleDisabled()

bool Aws::IoT::Model::TopicRule::GetRuleDisabled ( ) const
inline

Specifies whether the rule is disabled.

Definition at line 249 of file TopicRule.h.

◆ GetRuleName()

const Aws::String& Aws::IoT::Model::TopicRule::GetRuleName ( ) const
inline

The name of the rule.

Definition at line 46 of file TopicRule.h.

◆ GetSql()

const Aws::String& Aws::IoT::Model::TopicRule::GetSql ( ) const
inline

The SQL statement used to query the topic. When using a SQL query with multiple lines, be sure to escape the newline characters.

Definition at line 88 of file TopicRule.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::IoT::Model::TopicRule::Jsonize ( ) const

◆ operator=()

TopicRule& Aws::IoT::Model::TopicRule::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ RuleDisabledHasBeenSet()

bool Aws::IoT::Model::TopicRule::RuleDisabledHasBeenSet ( ) const
inline

Specifies whether the rule is disabled.

Definition at line 254 of file TopicRule.h.

◆ RuleNameHasBeenSet()

bool Aws::IoT::Model::TopicRule::RuleNameHasBeenSet ( ) const
inline

The name of the rule.

Definition at line 51 of file TopicRule.h.

◆ SetActions() [1/2]

void Aws::IoT::Model::TopicRule::SetActions ( Aws::Vector< Action > &&  value)
inline

The actions associated with the rule.

Definition at line 223 of file TopicRule.h.

◆ SetActions() [2/2]

void Aws::IoT::Model::TopicRule::SetActions ( const Aws::Vector< Action > &  value)
inline

The actions associated with the rule.

Definition at line 218 of file TopicRule.h.

◆ SetAwsIotSqlVersion() [1/3]

void Aws::IoT::Model::TopicRule::SetAwsIotSqlVersion ( Aws::String &&  value)
inline

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

Definition at line 285 of file TopicRule.h.

◆ SetAwsIotSqlVersion() [2/3]

void Aws::IoT::Model::TopicRule::SetAwsIotSqlVersion ( const Aws::String value)
inline

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

Definition at line 280 of file TopicRule.h.

◆ SetAwsIotSqlVersion() [3/3]

void Aws::IoT::Model::TopicRule::SetAwsIotSqlVersion ( const char *  value)
inline

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

Definition at line 290 of file TopicRule.h.

◆ SetCreatedAt() [1/2]

void Aws::IoT::Model::TopicRule::SetCreatedAt ( Aws::Utils::DateTime &&  value)
inline

The date and time the rule was created.

Definition at line 192 of file TopicRule.h.

◆ SetCreatedAt() [2/2]

void Aws::IoT::Model::TopicRule::SetCreatedAt ( const Aws::Utils::DateTime value)
inline

The date and time the rule was created.

Definition at line 187 of file TopicRule.h.

◆ SetDescription() [1/3]

void Aws::IoT::Model::TopicRule::SetDescription ( Aws::String &&  value)
inline

The description of the rule.

Definition at line 151 of file TopicRule.h.

◆ SetDescription() [2/3]

void Aws::IoT::Model::TopicRule::SetDescription ( const Aws::String value)
inline

The description of the rule.

Definition at line 146 of file TopicRule.h.

◆ SetDescription() [3/3]

void Aws::IoT::Model::TopicRule::SetDescription ( const char *  value)
inline

The description of the rule.

Definition at line 156 of file TopicRule.h.

◆ SetErrorAction() [1/2]

void Aws::IoT::Model::TopicRule::SetErrorAction ( Action &&  value)
inline

The action to perform when an error occurs.

Definition at line 326 of file TopicRule.h.

◆ SetErrorAction() [2/2]

void Aws::IoT::Model::TopicRule::SetErrorAction ( const Action value)
inline

The action to perform when an error occurs.

Definition at line 321 of file TopicRule.h.

◆ SetRuleDisabled()

void Aws::IoT::Model::TopicRule::SetRuleDisabled ( bool  value)
inline

Specifies whether the rule is disabled.

Definition at line 259 of file TopicRule.h.

◆ SetRuleName() [1/3]

void Aws::IoT::Model::TopicRule::SetRuleName ( Aws::String &&  value)
inline

The name of the rule.

Definition at line 61 of file TopicRule.h.

◆ SetRuleName() [2/3]

void Aws::IoT::Model::TopicRule::SetRuleName ( const Aws::String value)
inline

The name of the rule.

Definition at line 56 of file TopicRule.h.

◆ SetRuleName() [3/3]

void Aws::IoT::Model::TopicRule::SetRuleName ( const char *  value)
inline

The name of the rule.

Definition at line 66 of file TopicRule.h.

◆ SetSql() [1/3]

void Aws::IoT::Model::TopicRule::SetSql ( Aws::String &&  value)
inline

The SQL statement used to query the topic. When using a SQL query with multiple lines, be sure to escape the newline characters.

Definition at line 106 of file TopicRule.h.

◆ SetSql() [2/3]

void Aws::IoT::Model::TopicRule::SetSql ( const Aws::String value)
inline

The SQL statement used to query the topic. When using a SQL query with multiple lines, be sure to escape the newline characters.

Definition at line 100 of file TopicRule.h.

◆ SetSql() [3/3]

void Aws::IoT::Model::TopicRule::SetSql ( const char *  value)
inline

The SQL statement used to query the topic. When using a SQL query with multiple lines, be sure to escape the newline characters.

Definition at line 112 of file TopicRule.h.

◆ SqlHasBeenSet()

bool Aws::IoT::Model::TopicRule::SqlHasBeenSet ( ) const
inline

The SQL statement used to query the topic. When using a SQL query with multiple lines, be sure to escape the newline characters.

Definition at line 94 of file TopicRule.h.

◆ WithActions() [1/2]

TopicRule& Aws::IoT::Model::TopicRule::WithActions ( Aws::Vector< Action > &&  value)
inline

The actions associated with the rule.

Definition at line 233 of file TopicRule.h.

◆ WithActions() [2/2]

TopicRule& Aws::IoT::Model::TopicRule::WithActions ( const Aws::Vector< Action > &  value)
inline

The actions associated with the rule.

Definition at line 228 of file TopicRule.h.

◆ WithAwsIotSqlVersion() [1/3]

TopicRule& Aws::IoT::Model::TopicRule::WithAwsIotSqlVersion ( Aws::String &&  value)
inline

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

Definition at line 300 of file TopicRule.h.

◆ WithAwsIotSqlVersion() [2/3]

TopicRule& Aws::IoT::Model::TopicRule::WithAwsIotSqlVersion ( const Aws::String value)
inline

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

Definition at line 295 of file TopicRule.h.

◆ WithAwsIotSqlVersion() [3/3]

TopicRule& Aws::IoT::Model::TopicRule::WithAwsIotSqlVersion ( const char *  value)
inline

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

Definition at line 305 of file TopicRule.h.

◆ WithCreatedAt() [1/2]

TopicRule& Aws::IoT::Model::TopicRule::WithCreatedAt ( Aws::Utils::DateTime &&  value)
inline

The date and time the rule was created.

Definition at line 202 of file TopicRule.h.

◆ WithCreatedAt() [2/2]

TopicRule& Aws::IoT::Model::TopicRule::WithCreatedAt ( const Aws::Utils::DateTime value)
inline

The date and time the rule was created.

Definition at line 197 of file TopicRule.h.

◆ WithDescription() [1/3]

TopicRule& Aws::IoT::Model::TopicRule::WithDescription ( Aws::String &&  value)
inline

The description of the rule.

Definition at line 166 of file TopicRule.h.

◆ WithDescription() [2/3]

TopicRule& Aws::IoT::Model::TopicRule::WithDescription ( const Aws::String value)
inline

The description of the rule.

Definition at line 161 of file TopicRule.h.

◆ WithDescription() [3/3]

TopicRule& Aws::IoT::Model::TopicRule::WithDescription ( const char *  value)
inline

The description of the rule.

Definition at line 171 of file TopicRule.h.

◆ WithErrorAction() [1/2]

TopicRule& Aws::IoT::Model::TopicRule::WithErrorAction ( Action &&  value)
inline

The action to perform when an error occurs.

Definition at line 336 of file TopicRule.h.

◆ WithErrorAction() [2/2]

TopicRule& Aws::IoT::Model::TopicRule::WithErrorAction ( const Action value)
inline

The action to perform when an error occurs.

Definition at line 331 of file TopicRule.h.

◆ WithRuleDisabled()

TopicRule& Aws::IoT::Model::TopicRule::WithRuleDisabled ( bool  value)
inline

Specifies whether the rule is disabled.

Definition at line 264 of file TopicRule.h.

◆ WithRuleName() [1/3]

TopicRule& Aws::IoT::Model::TopicRule::WithRuleName ( Aws::String &&  value)
inline

The name of the rule.

Definition at line 76 of file TopicRule.h.

◆ WithRuleName() [2/3]

TopicRule& Aws::IoT::Model::TopicRule::WithRuleName ( const Aws::String value)
inline

The name of the rule.

Definition at line 71 of file TopicRule.h.

◆ WithRuleName() [3/3]

TopicRule& Aws::IoT::Model::TopicRule::WithRuleName ( const char *  value)
inline

The name of the rule.

Definition at line 81 of file TopicRule.h.

◆ WithSql() [1/3]

TopicRule& Aws::IoT::Model::TopicRule::WithSql ( Aws::String &&  value)
inline

The SQL statement used to query the topic. When using a SQL query with multiple lines, be sure to escape the newline characters.

Definition at line 124 of file TopicRule.h.

◆ WithSql() [2/3]

TopicRule& Aws::IoT::Model::TopicRule::WithSql ( const Aws::String value)
inline

The SQL statement used to query the topic. When using a SQL query with multiple lines, be sure to escape the newline characters.

Definition at line 118 of file TopicRule.h.

◆ WithSql() [3/3]

TopicRule& Aws::IoT::Model::TopicRule::WithSql ( const char *  value)
inline

The SQL statement used to query the topic. When using a SQL query with multiple lines, be sure to escape the newline characters.

Definition at line 130 of file TopicRule.h.


The documentation for this class was generated from the following file: