Class TopicRule
- All Implemented Interfaces:
Serializable
,Cloneable
Describes a rule.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
The actions associated with the rule.The version of the SQL rules engine to use when evaluating the rule.The date and time the rule was created.The description of the rule.Specifies whether the rule is disabled.The name of the rule.getSql()
The SQL statement used to query the topic.int
hashCode()
Specifies whether the rule is disabled.void
setActions
(Collection<Action> actions) The actions associated with the rule.void
setAwsIotSqlVersion
(String awsIotSqlVersion) The version of the SQL rules engine to use when evaluating the rule.void
setCreatedAt
(Date createdAt) The date and time the rule was created.void
setDescription
(String description) The description of the rule.void
setRuleDisabled
(Boolean ruleDisabled) Specifies whether the rule is disabled.void
setRuleName
(String ruleName) The name of the rule.void
The SQL statement used to query the topic.toString()
Returns a string representation of this object; useful for testing and debugging.withActions
(Action... actions) The actions associated with the rule.withActions
(Collection<Action> actions) The actions associated with the rule.withAwsIotSqlVersion
(String awsIotSqlVersion) The version of the SQL rules engine to use when evaluating the rule.withCreatedAt
(Date createdAt) The date and time the rule was created.withDescription
(String description) The description of the rule.withRuleDisabled
(Boolean ruleDisabled) Specifies whether the rule is disabled.withRuleName
(String ruleName) The name of the rule.The SQL statement used to query the topic.
-
Constructor Details
-
TopicRule
public TopicRule()
-
-
Method Details
-
setRuleName
The name of the rule.
- Parameters:
ruleName
- The name of the rule.
-
getRuleName
The name of the rule.
- Returns:
- The name of the rule.
-
withRuleName
The name of the rule.
- Parameters:
ruleName
- The name of the rule.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setSql
The SQL statement used to query the topic. When using a SQL query with multiple lines, be sure to escape the newline characters.
- Parameters:
sql
- The SQL statement used to query the topic. When using a SQL query with multiple lines, be sure to escape the newline characters.
-
getSql
The SQL statement used to query the topic. When using a SQL query with multiple lines, be sure to escape the newline characters.
- Returns:
- The SQL statement used to query the topic. When using a SQL query with multiple lines, be sure to escape the newline characters.
-
withSql
The SQL statement used to query the topic. When using a SQL query with multiple lines, be sure to escape the newline characters.
- Parameters:
sql
- The SQL statement used to query the topic. When using a SQL query with multiple lines, be sure to escape the newline characters.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDescription
The description of the rule.
- Parameters:
description
- The description of the rule.
-
getDescription
The description of the rule.
- Returns:
- The description of the rule.
-
withDescription
The description of the rule.
- Parameters:
description
- The description of the rule.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setCreatedAt
The date and time the rule was created.
- Parameters:
createdAt
- The date and time the rule was created.
-
getCreatedAt
The date and time the rule was created.
- Returns:
- The date and time the rule was created.
-
withCreatedAt
The date and time the rule was created.
- Parameters:
createdAt
- The date and time the rule was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getActions
The actions associated with the rule.
- Returns:
- The actions associated with the rule.
-
setActions
The actions associated with the rule.
- Parameters:
actions
- The actions associated with the rule.
-
withActions
The actions associated with the rule.
NOTE: This method appends the values to the existing list (if any). Use
setActions(java.util.Collection)
orwithActions(java.util.Collection)
if you want to override the existing values.- Parameters:
actions
- The actions associated with the rule.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withActions
The actions associated with the rule.
- Parameters:
actions
- The actions associated with the rule.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setRuleDisabled
Specifies whether the rule is disabled.
- Parameters:
ruleDisabled
- Specifies whether the rule is disabled.
-
getRuleDisabled
Specifies whether the rule is disabled.
- Returns:
- Specifies whether the rule is disabled.
-
withRuleDisabled
Specifies whether the rule is disabled.
- Parameters:
ruleDisabled
- Specifies whether the rule is disabled.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isRuleDisabled
Specifies whether the rule is disabled.
- Returns:
- Specifies whether the rule is disabled.
-
setAwsIotSqlVersion
The version of the SQL rules engine to use when evaluating the rule.
- Parameters:
awsIotSqlVersion
- The version of the SQL rules engine to use when evaluating the rule.
-
getAwsIotSqlVersion
The version of the SQL rules engine to use when evaluating the rule.
- Returns:
- The version of the SQL rules engine to use when evaluating the rule.
-
withAwsIotSqlVersion
The version of the SQL rules engine to use when evaluating the rule.
- Parameters:
awsIotSqlVersion
- The version of the SQL rules engine to use when evaluating the rule.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-