software.amazon.awssdk.services.iot.model

Class TopicRule

java.lang.Object

software.amazon.awssdk.services.iot.model.TopicRule

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<TopicRule.Builder,TopicRule>

@Generated(value="software.amazon.awssdk:codegen")
public final class TopicRule
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<TopicRule.Builder,TopicRule>

Describes a rule.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TopicRule.Builder

Method Summary

Modifier and Type	Method and Description
List<Action>	actions() The actions associated with the rule.
String	awsIotSqlVersion() The version of the SQL rules engine to use when evaluating the rule.
static TopicRule.Builder	builder()
Instant	createdAt() The date and time the rule was created.
String	description() The description of the rule.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Action	errorAction() The action to perform when an error occurs.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasActions() For responses, this returns true if the service returned a value for the Actions property.
int	hashCode()
Boolean	ruleDisabled() Specifies whether the rule is disabled.
String	ruleName() The name of the rule.
List<SdkField<?>>	sdkFields()
static Class<? extends TopicRule.Builder>	serializableBuilderClass()
String	sql() The SQL statement used to query the topic.
TopicRule.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

ruleName

public final String ruleName()

The name of the rule.

Returns:

The name of the rule.

sql

public final 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:

The SQL statement used to query the topic. When using a SQL query with multiple lines, be sure to escape the newline characters.

description

public final String description()

The description of the rule.

Returns:

The description of the rule.

createdAt

public final Instant createdAt()

The date and time the rule was created.

Returns:

The date and time the rule was created.

hasActions

public final boolean hasActions()

For responses, this returns true if the service returned a value for the Actions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

actions

public final List<Action> actions()

The actions associated with the rule.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasActions() method.

Returns:

The actions associated with the rule.

ruleDisabled

public final Boolean ruleDisabled()

Specifies whether the rule is disabled.

Returns:

Specifies whether the rule is disabled.

awsIotSqlVersion

public final String awsIotSqlVersion()

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.

errorAction

public final Action errorAction()

The action to perform when an error occurs.

Returns:

The action to perform when an error occurs.

toBuilder

public TopicRule.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TopicRule.Builder,TopicRule>

builder

public static TopicRule.Builder builder()

serializableBuilderClass

public static Class<? extends TopicRule.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo