TopicRule (AWS SDK for Java

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

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class TopicRule
extends Object
implements Serializable, Cloneable, StructuredPojo

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
`TopicRule`	`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.
`Date`	`getCreatedAt()` The date and time the rule was created.
`String`	`getDescription()` The description of the rule.
`Boolean`	`getRuleDisabled()` Specifies whether the rule is disabled.
`String`	`getRuleName()` The name of the rule.
`String`	`getSql()` The SQL statement used to query the topic.
`int`	`hashCode()`
`Boolean`	`isRuleDisabled()` Specifies whether the rule is disabled.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`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`	`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.
`TopicRule`	`withActions(Action... actions)` The actions associated with the rule.
`TopicRule`	`withActions(Collection<Action> actions)` The actions associated with the rule.
`TopicRule`	`withAwsIotSqlVersion(String awsIotSqlVersion)` The version of the SQL rules engine to use when evaluating the rule.
`TopicRule`	`withCreatedAt(Date createdAt)` The date and time the rule was created.
`TopicRule`	`withDescription(String description)` The description of the rule.
`TopicRule`	`withRuleDisabled(Boolean ruleDisabled)` Specifies whether the rule is disabled.
`TopicRule`	`withRuleName(String ruleName)` The name of the rule.
`TopicRule`	`withSql(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
  - 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:
    
    Object.toString()
  - 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
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class TopicRule

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TopicRule

Method Detail

setRuleName

getRuleName

withRuleName

setSql

getSql

withSql

setDescription

getDescription

withDescription

setCreatedAt

getCreatedAt

withCreatedAt

getActions

setActions

withActions

withActions

setRuleDisabled

getRuleDisabled

withRuleDisabled

isRuleDisabled

setAwsIotSqlVersion

getAwsIotSqlVersion

withAwsIotSqlVersion

toString

equals

hashCode

clone

marshall