Class TopicRule

java.lang.Object
com.amazonaws.services.iot.model.TopicRule
All Implemented Interfaces:
Serializable, Cloneable

public class TopicRule extends Object implements Serializable, Cloneable

Describes a rule.

See Also:
  • Constructor Details

    • TopicRule

      public TopicRule()
  • Method Details

    • setRuleName

      public void setRuleName(String ruleName)

      The name of the rule.

      Parameters:
      ruleName - The name of the rule.
    • getRuleName

      public String getRuleName()

      The name of the rule.

      Returns:
      The name of the rule.
    • withRuleName

      public TopicRule withRuleName(String ruleName)

      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

      public void setSql(String sql)

      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

      public String 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

      public TopicRule withSql(String sql)

      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

      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 TopicRule 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.
    • setCreatedAt

      public void setCreatedAt(Date createdAt)

      The date and time the rule was created.

      Parameters:
      createdAt - The date and time the rule was created.
    • getCreatedAt

      public Date getCreatedAt()

      The date and time the rule was created.

      Returns:
      The date and time the rule was created.
    • withCreatedAt

      public TopicRule withCreatedAt(Date createdAt)

      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

      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 TopicRule 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) or withActions(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 TopicRule 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 TopicRule 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 TopicRule 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 class Object
      Returns:
      A string representation of this object.
      See Also:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • clone

      public TopicRule clone()
      Overrides:
      clone in class Object