software.amazon.awssdk.services.iot.model

Interface TopicRule.Builder

All Superinterfaces:

Buildable, CopyableBuilder<TopicRule.Builder,TopicRule>, SdkBuilder<TopicRule.Builder,TopicRule>, SdkPojo

Enclosing class:

TopicRule

public static interface TopicRule.Builder
extends SdkPojo, CopyableBuilder<TopicRule.Builder,TopicRule>

Method Summary

Modifier and Type	Method and Description
TopicRule.Builder	actions(Action... actions) The actions associated with the rule.
TopicRule.Builder	actions(Collection<Action> actions) The actions associated with the rule.
TopicRule.Builder	actions(Consumer<Action.Builder>... actions) The actions associated with the rule.
TopicRule.Builder	awsIotSqlVersion(String awsIotSqlVersion) The version of the SQL rules engine to use when evaluating the rule.
TopicRule.Builder	createdAt(Instant createdAt) The date and time the rule was created.
TopicRule.Builder	description(String description) The description of the rule.
TopicRule.Builder	errorAction(Action errorAction) The action to perform when an error occurs.
default TopicRule.Builder	errorAction(Consumer<Action.Builder> errorAction) The action to perform when an error occurs.
TopicRule.Builder	ruleDisabled(Boolean ruleDisabled) Specifies whether the rule is disabled.
TopicRule.Builder	ruleName(String ruleName) The name of the rule.
TopicRule.Builder	sql(String sql) The SQL statement used to query the topic.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

sdkFields

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

copy

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

applyMutation, build

Method Detail

ruleName

TopicRule.Builder ruleName(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.

sql

TopicRule.Builder sql(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.

description

TopicRule.Builder description(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.

createdAt

TopicRule.Builder createdAt(Instant 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.

actions

TopicRule.Builder actions(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.

actions

TopicRule.Builder actions(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.

actions

TopicRule.Builder actions(Consumer<Action.Builder>... actions)

The actions associated with the rule.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #actions(List).

Parameters:

actions - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#actions(List)

ruleDisabled

TopicRule.Builder ruleDisabled(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.

awsIotSqlVersion

TopicRule.Builder awsIotSqlVersion(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.

errorAction

TopicRule.Builder errorAction(Action errorAction)

The action to perform when an error occurs.

Parameters:

errorAction - The action to perform when an error occurs.

Returns:

Returns a reference to this object so that method calls can be chained together.

errorAction

default TopicRule.Builder errorAction(Consumer<Action.Builder> errorAction)

The action to perform when an error occurs.

This is a convenience that creates an instance of the Action.Builder avoiding the need to create one manually via Action.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to errorAction(Action).

Parameters:

errorAction - a consumer that will call methods on Action.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

errorAction(Action)