TopicRule (AWS SDK for Android

java.lang.Object
- com.amazonaws.services.iot.model.TopicRule

All Implemented Interfaces:

java.io.Serializable
```
public class TopicRule
extends java.lang.Object
implements java.io.Serializable
```
Describes a rule.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

TopicRule()

Constructors
Constructor and Description
`TopicRule()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.util.List<Action>`	`getActions()` The actions associated with the rule.
`java.lang.String`	`getAwsIotSqlVersion()` The version of the SQL rules engine to use when evaluating the rule.
`java.util.Date`	`getCreatedAt()` The date and time the rule was created.
`java.lang.String`	`getDescription()` The description of the rule.
`Action`	`getErrorAction()` The action to perform when an error occurs.
`java.lang.Boolean`	`getRuleDisabled()` Specifies whether the rule is disabled.
`java.lang.String`	`getRuleName()` The name of the rule.
`java.lang.String`	`getSql()` The SQL statement used to query the topic.
`int`	`hashCode()`
`java.lang.Boolean`	`isRuleDisabled()` Specifies whether the rule is disabled.
`void`	`setActions(java.util.Collection<Action> actions)` The actions associated with the rule.
`void`	`setAwsIotSqlVersion(java.lang.String awsIotSqlVersion)` The version of the SQL rules engine to use when evaluating the rule.
`void`	`setCreatedAt(java.util.Date createdAt)` The date and time the rule was created.
`void`	`setDescription(java.lang.String description)` The description of the rule.
`void`	`setErrorAction(Action errorAction)` The action to perform when an error occurs.
`void`	`setRuleDisabled(java.lang.Boolean ruleDisabled)` Specifies whether the rule is disabled.
`void`	`setRuleName(java.lang.String ruleName)` The name of the rule.
`void`	`setSql(java.lang.String sql)` The SQL statement used to query the topic.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`TopicRule`	`withActions(Action... actions)` The actions associated with the rule.
`TopicRule`	`withActions(java.util.Collection<Action> actions)` The actions associated with the rule.
`TopicRule`	`withAwsIotSqlVersion(java.lang.String awsIotSqlVersion)` The version of the SQL rules engine to use when evaluating the rule.
`TopicRule`	`withCreatedAt(java.util.Date createdAt)` The date and time the rule was created.
`TopicRule`	`withDescription(java.lang.String description)` The description of the rule.
`TopicRule`	`withErrorAction(Action errorAction)` The action to perform when an error occurs.
`TopicRule`	`withRuleDisabled(java.lang.Boolean ruleDisabled)` Specifies whether the rule is disabled.
`TopicRule`	`withRuleName(java.lang.String ruleName)` The name of the rule.
`TopicRule`	`withSql(java.lang.String sql)` The SQL statement used to query the topic.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - TopicRule
```
public TopicRule()
```
- Method Detail
  - getRuleName
```
public java.lang.String getRuleName()
```
    The name of the rule.
    
    Constraints:
    Length: 1 - 128
    Pattern: ^[a-zA-Z0-9_]+$
    
    Returns:
    
    The name of the rule.
  - setRuleName
```
public void setRuleName(java.lang.String ruleName)
```
    The name of the rule.
    
    Constraints:
    Length: 1 - 128
    Pattern: ^[a-zA-Z0-9_]+$
    
    Parameters:
    
    ruleName -
    The name of the rule.
  - withRuleName
```
public TopicRule withRuleName(java.lang.String ruleName)
```
    The name of the rule.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 128
    Pattern: ^[a-zA-Z0-9_]+$
    
    Parameters:
    
    ruleName -
    The name of the rule.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getSql
```
public java.lang.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.
  - setSql
```
public void setSql(java.lang.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.
  - withSql
```
public TopicRule withSql(java.lang.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.
    
    Returns a reference to this object so that method calls can be chained together.
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - getDescription
```
public java.lang.String getDescription()
```
    The description of the rule.
    
    Returns:
    
    The description of the rule.
  - setDescription
```
public void setDescription(java.lang.String description)
```
    The description of the rule.
    
    Parameters:
    
    description -
    The description of the rule.
  - withDescription
```
public TopicRule withDescription(java.lang.String description)
```
    The description of the rule.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    description -
    The description of the rule.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getCreatedAt
```
public java.util.Date getCreatedAt()
```
    The date and time the rule was created.
    
    Returns:
    
    The date and time the rule was created.
  - setCreatedAt
```
public void setCreatedAt(java.util.Date createdAt)
```
    The date and time the rule was created.
    
    Parameters:
    
    createdAt -
    The date and time the rule was created.
  - withCreatedAt
```
public TopicRule withCreatedAt(java.util.Date createdAt)
```
    The date and time the rule was created.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    createdAt -
    The date and time the rule was created.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getActions
```
public java.util.List<Action> getActions()
```
    The actions associated with the rule.
    
    Returns:
    
    The actions associated with the rule.
  - setActions
```
public void setActions(java.util.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.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    actions -
    The actions associated with the rule.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withActions
```
public TopicRule withActions(java.util.Collection<Action> actions)
```
    The actions associated with the rule.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    actions -
    The actions associated with the rule.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - isRuleDisabled
```
public java.lang.Boolean isRuleDisabled()
```
    Specifies whether the rule is disabled.
    
    Returns:
    
    Specifies whether the rule is disabled.
  - getRuleDisabled
```
public java.lang.Boolean getRuleDisabled()
```
    Specifies whether the rule is disabled.
    
    Returns:
    
    Specifies whether the rule is disabled.
  - setRuleDisabled
```
public void setRuleDisabled(java.lang.Boolean ruleDisabled)
```
    Specifies whether the rule is disabled.
    
    Parameters:
    
    ruleDisabled -
    Specifies whether the rule is disabled.
  - withRuleDisabled
```
public TopicRule withRuleDisabled(java.lang.Boolean ruleDisabled)
```
    Specifies whether the rule is disabled.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    ruleDisabled -
    Specifies whether the rule is disabled.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getAwsIotSqlVersion
```
public java.lang.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.
  - setAwsIotSqlVersion
```
public void setAwsIotSqlVersion(java.lang.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.
  - withAwsIotSqlVersion
```
public TopicRule withAwsIotSqlVersion(java.lang.String awsIotSqlVersion)
```
    The version of the SQL rules engine to use when evaluating the rule.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    awsIotSqlVersion -
    The version of the SQL rules engine to use when evaluating the rule.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getErrorAction
```
public Action getErrorAction()
```
    The action to perform when an error occurs.
    
    Returns:
    
    The action to perform when an error occurs.
  - setErrorAction
```
public void setErrorAction(Action errorAction)
```
    The action to perform when an error occurs.
    
    Parameters:
    
    errorAction -
    The action to perform when an error occurs.
  - withErrorAction
```
public TopicRule withErrorAction(Action errorAction)
```
    The action to perform when an error occurs.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    errorAction -
    The action to perform when an error occurs.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class TopicRule

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TopicRule

Method Detail

getRuleName

setRuleName

withRuleName

getSql

setSql

withSql

getDescription

setDescription

withDescription

getCreatedAt

setCreatedAt

withCreatedAt

getActions

setActions

withActions

withActions

isRuleDisabled

getRuleDisabled

setRuleDisabled

withRuleDisabled

getAwsIotSqlVersion

setAwsIotSqlVersion

withAwsIotSqlVersion

getErrorAction

setErrorAction

withErrorAction

toString

hashCode

equals