Class TopicRulePayload
- java.lang.Object
-
- com.amazonaws.services.iot.model.TopicRulePayload
-
- All Implemented Interfaces:
Serializable
,Cloneable
public class TopicRulePayload extends Object implements Serializable, Cloneable
Describes a rule.
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description TopicRulePayload()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description TopicRulePayload
clone()
boolean
equals(Object obj)
List<Action>
getActions()
The actions associated with the rule.String
getAwsIotSqlVersion()
The version of the SQL rules engine to use when evaluating the rule.String
getDescription()
The description of the rule.Boolean
getRuleDisabled()
Specifies whether the rule is disabled.String
getSql()
The SQL statement used to query the topic.int
hashCode()
Boolean
isRuleDisabled()
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
setDescription(String description)
The description of the rule.void
setRuleDisabled(Boolean ruleDisabled)
Specifies whether the rule is disabled.void
setSql(String sql)
The SQL statement used to query the topic.String
toString()
Returns a string representation of this object; useful for testing and debugging.TopicRulePayload
withActions(Action... actions)
The actions associated with the rule.TopicRulePayload
withActions(Collection<Action> actions)
The actions associated with the rule.TopicRulePayload
withAwsIotSqlVersion(String awsIotSqlVersion)
The version of the SQL rules engine to use when evaluating the rule.TopicRulePayload
withDescription(String description)
The description of the rule.TopicRulePayload
withRuleDisabled(Boolean ruleDisabled)
Specifies whether the rule is disabled.TopicRulePayload
withSql(String sql)
The SQL statement used to query the topic.
-
-
-
Method Detail
-
setSql
public void setSql(String sql)
The SQL statement used to query the topic. For more information, see AWS IoT SQL Reference in the AWS IoT Developer Guide.
- Parameters:
sql
- The SQL statement used to query the topic. For more information, see AWS IoT SQL Reference in the AWS IoT Developer Guide.
-
getSql
public String getSql()
The SQL statement used to query the topic. For more information, see AWS IoT SQL Reference in the AWS IoT Developer Guide.
- Returns:
- The SQL statement used to query the topic. For more information, see AWS IoT SQL Reference in the AWS IoT Developer Guide.
-
withSql
public TopicRulePayload withSql(String sql)
The SQL statement used to query the topic. For more information, see AWS IoT SQL Reference in the AWS IoT Developer Guide.
- Parameters:
sql
- The SQL statement used to query the topic. For more information, see AWS IoT SQL Reference in the AWS IoT Developer Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDescription
public void setDescription(String description)
The description of the rule.
- Parameters:
description
- The description of the rule.
-
getDescription
public String getDescription()
The description of the rule.
- Returns:
- The description of the rule.
-
withDescription
public TopicRulePayload withDescription(String description)
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.
-
getActions
public List<Action> getActions()
The actions associated with the rule.
- Returns:
- The actions associated with the rule.
-
setActions
public void setActions(Collection<Action> actions)
The actions associated with the rule.
- Parameters:
actions
- The actions associated with the rule.
-
withActions
public TopicRulePayload withActions(Action... actions)
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
public TopicRulePayload withActions(Collection<Action> actions)
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
public void setRuleDisabled(Boolean ruleDisabled)
Specifies whether the rule is disabled.
- Parameters:
ruleDisabled
- Specifies whether the rule is disabled.
-
getRuleDisabled
public Boolean getRuleDisabled()
Specifies whether the rule is disabled.
- Returns:
- Specifies whether the rule is disabled.
-
withRuleDisabled
public TopicRulePayload withRuleDisabled(Boolean ruleDisabled)
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
public Boolean isRuleDisabled()
Specifies whether the rule is disabled.
- Returns:
- Specifies whether the rule is disabled.
-
setAwsIotSqlVersion
public void setAwsIotSqlVersion(String awsIotSqlVersion)
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
public String 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
public TopicRulePayload withAwsIotSqlVersion(String awsIotSqlVersion)
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
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public TopicRulePayload clone()
-
-