software.amazon.awssdk.services.iot.model

Interface TopicRulePayload.Builder

All Superinterfaces:

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

Enclosing class:

TopicRulePayload

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

Method Summary

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

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

equalsBySdkFields, 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

sql

TopicRulePayload.Builder sql(String sql)

The SQL statement used to query the topic. For more information, see IoT SQL Reference in the IoT Developer Guide.

Parameters:

sql - The SQL statement used to query the topic. For more information, see IoT SQL Reference in the IoT Developer Guide.

Returns:

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

description

TopicRulePayload.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.

actions

TopicRulePayload.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

TopicRulePayload.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

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

The actions associated with the rule.

This is a convenience method 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 #actions(List).

Parameters:

actions - 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:

#actions(java.util.Collection)

ruleDisabled

TopicRulePayload.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

TopicRulePayload.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

TopicRulePayload.Builder errorAction(Action errorAction)

The action to take when an error occurs.

Parameters:

errorAction - The action to take when an error occurs.

Returns:

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

errorAction

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

The action to take when an error occurs.

This is a convenience method 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)