AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

TopicRulePayload

import "github.com/aws/aws-sdk-go/service/iot"

type TopicRulePayload struct { Actions []*Action `locationName:"actions" type:"list" required:"true"` AwsIotSqlVersion *string `locationName:"awsIotSqlVersion" type:"string"` Description *string `locationName:"description" type:"string"` ErrorAction *Action `locationName:"errorAction" type:"structure"` RuleDisabled *bool `locationName:"ruleDisabled" type:"boolean"` Sql *string `locationName:"sql" type:"string" required:"true"` }

Describes a rule.

Actions

Describes the actions associated with a rule.

AwsIotSqlVersion

Type: *string

The version of the SQL rules engine to use when evaluating the rule.

Description

Type: *string

The description of the rule.

ErrorAction

Describes the actions associated with a rule.

RuleDisabled

Type: *bool

Specifies whether the rule is disabled.

Sql

Type: *string

The SQL statement used to query the topic. For more information, see AWS IoT SQL Reference (https://docs.aws.amazon.com/iot/latest/developerguide/iot-rules.html#aws-iot-sql-reference) in the AWS IoT Developer Guide.

Sql is a required field

Method

GoString

func (s TopicRulePayload) GoString() string

GoString returns the string representation

SetActions

func (s *TopicRulePayload) SetActions(v []*Action) *TopicRulePayload

SetActions sets the Actions field's value.

SetAwsIotSqlVersion

func (s *TopicRulePayload) SetAwsIotSqlVersion(v string) *TopicRulePayload

SetAwsIotSqlVersion sets the AwsIotSqlVersion field's value.

SetDescription

func (s *TopicRulePayload) SetDescription(v string) *TopicRulePayload

SetDescription sets the Description field's value.

SetErrorAction

func (s *TopicRulePayload) SetErrorAction(v *Action) *TopicRulePayload

SetErrorAction sets the ErrorAction field's value.

SetRuleDisabled

func (s *TopicRulePayload) SetRuleDisabled(v bool) *TopicRulePayload

SetRuleDisabled sets the RuleDisabled field's value.

SetSql

func (s *TopicRulePayload) SetSql(v string) *TopicRulePayload

SetSql sets the Sql field's value.

String

func (s TopicRulePayload) String() string

String returns the string representation

Validate

func (s *TopicRulePayload) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: