AWS SDK for C++  1.8.182
AWS SDK for C++
Public Member Functions | List of all members
Aws::IoT::Model::IotEventsAction Class Reference

#include <IotEventsAction.h>

Public Member Functions

 IotEventsAction ()
 
 IotEventsAction (Aws::Utils::Json::JsonView jsonValue)
 
IotEventsActionoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetInputName () const
 
bool InputNameHasBeenSet () const
 
void SetInputName (const Aws::String &value)
 
void SetInputName (Aws::String &&value)
 
void SetInputName (const char *value)
 
IotEventsActionWithInputName (const Aws::String &value)
 
IotEventsActionWithInputName (Aws::String &&value)
 
IotEventsActionWithInputName (const char *value)
 
const Aws::StringGetMessageId () const
 
bool MessageIdHasBeenSet () const
 
void SetMessageId (const Aws::String &value)
 
void SetMessageId (Aws::String &&value)
 
void SetMessageId (const char *value)
 
IotEventsActionWithMessageId (const Aws::String &value)
 
IotEventsActionWithMessageId (Aws::String &&value)
 
IotEventsActionWithMessageId (const char *value)
 
bool GetBatchMode () const
 
bool BatchModeHasBeenSet () const
 
void SetBatchMode (bool value)
 
IotEventsActionWithBatchMode (bool value)
 
const Aws::StringGetRoleArn () const
 
bool RoleArnHasBeenSet () const
 
void SetRoleArn (const Aws::String &value)
 
void SetRoleArn (Aws::String &&value)
 
void SetRoleArn (const char *value)
 
IotEventsActionWithRoleArn (const Aws::String &value)
 
IotEventsActionWithRoleArn (Aws::String &&value)
 
IotEventsActionWithRoleArn (const char *value)
 

Detailed Description

Sends an input to an AWS IoT Events detector.

See Also:

AWS API Reference

Definition at line 31 of file IotEventsAction.h.

Constructor & Destructor Documentation

◆ IotEventsAction() [1/2]

Aws::IoT::Model::IotEventsAction::IotEventsAction ( )

◆ IotEventsAction() [2/2]

Aws::IoT::Model::IotEventsAction::IotEventsAction ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ BatchModeHasBeenSet()

bool Aws::IoT::Model::IotEventsAction::BatchModeHasBeenSet ( ) const
inline

Whether to process the event actions as a batch. The default value is false.

When batchMode is true, you can't specify a messageId.

When batchMode is true and the rule SQL statement evaluates to an Array, each Array element is treated as a separate message when it's sent to AWS IoT Events by calling BatchPutMessage . The resulting array can't have more than 10 messages.

Definition at line 186 of file IotEventsAction.h.

◆ GetBatchMode()

bool Aws::IoT::Model::IotEventsAction::GetBatchMode ( ) const
inline

Whether to process the event actions as a batch. The default value is false.

When batchMode is true, you can't specify a messageId.

When batchMode is true and the rule SQL statement evaluates to an Array, each Array element is treated as a separate message when it's sent to AWS IoT Events by calling BatchPutMessage . The resulting array can't have more than 10 messages.

Definition at line 173 of file IotEventsAction.h.

◆ GetInputName()

const Aws::String& Aws::IoT::Model::IotEventsAction::GetInputName ( ) const
inline

The name of the AWS IoT Events input.

Definition at line 43 of file IotEventsAction.h.

◆ GetMessageId()

const Aws::String& Aws::IoT::Model::IotEventsAction::GetMessageId ( ) const
inline

The ID of the message. The default messageId is a new UUID value.

When batchMode is true, you can't specify a messageId–a new UUID value will be assigned.

Assign a value to this property to ensure that only one input (message) with a given messageId will be processed by an AWS IoT Events detector.

Definition at line 89 of file IotEventsAction.h.

◆ GetRoleArn()

const Aws::String& Aws::IoT::Model::IotEventsAction::GetRoleArn ( ) const
inline

The ARN of the role that grants AWS IoT permission to send an input to an AWS IoT Events detector. ("Action":"iotevents:BatchPutMessage").

Definition at line 219 of file IotEventsAction.h.

◆ InputNameHasBeenSet()

bool Aws::IoT::Model::IotEventsAction::InputNameHasBeenSet ( ) const
inline

The name of the AWS IoT Events input.

Definition at line 48 of file IotEventsAction.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::IoT::Model::IotEventsAction::Jsonize ( ) const

◆ MessageIdHasBeenSet()

bool Aws::IoT::Model::IotEventsAction::MessageIdHasBeenSet ( ) const
inline

The ID of the message. The default messageId is a new UUID value.

When batchMode is true, you can't specify a messageId–a new UUID value will be assigned.

Assign a value to this property to ensure that only one input (message) with a given messageId will be processed by an AWS IoT Events detector.

Definition at line 99 of file IotEventsAction.h.

◆ operator=()

IotEventsAction& Aws::IoT::Model::IotEventsAction::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ RoleArnHasBeenSet()

bool Aws::IoT::Model::IotEventsAction::RoleArnHasBeenSet ( ) const
inline

The ARN of the role that grants AWS IoT permission to send an input to an AWS IoT Events detector. ("Action":"iotevents:BatchPutMessage").

Definition at line 225 of file IotEventsAction.h.

◆ SetBatchMode()

void Aws::IoT::Model::IotEventsAction::SetBatchMode ( bool  value)
inline

Whether to process the event actions as a batch. The default value is false.

When batchMode is true, you can't specify a messageId.

When batchMode is true and the rule SQL statement evaluates to an Array, each Array element is treated as a separate message when it's sent to AWS IoT Events by calling BatchPutMessage . The resulting array can't have more than 10 messages.

Definition at line 199 of file IotEventsAction.h.

◆ SetInputName() [1/3]

void Aws::IoT::Model::IotEventsAction::SetInputName ( Aws::String &&  value)
inline

The name of the AWS IoT Events input.

Definition at line 58 of file IotEventsAction.h.

◆ SetInputName() [2/3]

void Aws::IoT::Model::IotEventsAction::SetInputName ( const Aws::String value)
inline

The name of the AWS IoT Events input.

Definition at line 53 of file IotEventsAction.h.

◆ SetInputName() [3/3]

void Aws::IoT::Model::IotEventsAction::SetInputName ( const char *  value)
inline

The name of the AWS IoT Events input.

Definition at line 63 of file IotEventsAction.h.

◆ SetMessageId() [1/3]

void Aws::IoT::Model::IotEventsAction::SetMessageId ( Aws::String &&  value)
inline

The ID of the message. The default messageId is a new UUID value.

When batchMode is true, you can't specify a messageId–a new UUID value will be assigned.

Assign a value to this property to ensure that only one input (message) with a given messageId will be processed by an AWS IoT Events detector.

Definition at line 119 of file IotEventsAction.h.

◆ SetMessageId() [2/3]

void Aws::IoT::Model::IotEventsAction::SetMessageId ( const Aws::String value)
inline

The ID of the message. The default messageId is a new UUID value.

When batchMode is true, you can't specify a messageId–a new UUID value will be assigned.

Assign a value to this property to ensure that only one input (message) with a given messageId will be processed by an AWS IoT Events detector.

Definition at line 109 of file IotEventsAction.h.

◆ SetMessageId() [3/3]

void Aws::IoT::Model::IotEventsAction::SetMessageId ( const char *  value)
inline

The ID of the message. The default messageId is a new UUID value.

When batchMode is true, you can't specify a messageId–a new UUID value will be assigned.

Assign a value to this property to ensure that only one input (message) with a given messageId will be processed by an AWS IoT Events detector.

Definition at line 129 of file IotEventsAction.h.

◆ SetRoleArn() [1/3]

void Aws::IoT::Model::IotEventsAction::SetRoleArn ( Aws::String &&  value)
inline

The ARN of the role that grants AWS IoT permission to send an input to an AWS IoT Events detector. ("Action":"iotevents:BatchPutMessage").

Definition at line 237 of file IotEventsAction.h.

◆ SetRoleArn() [2/3]

void Aws::IoT::Model::IotEventsAction::SetRoleArn ( const Aws::String value)
inline

The ARN of the role that grants AWS IoT permission to send an input to an AWS IoT Events detector. ("Action":"iotevents:BatchPutMessage").

Definition at line 231 of file IotEventsAction.h.

◆ SetRoleArn() [3/3]

void Aws::IoT::Model::IotEventsAction::SetRoleArn ( const char *  value)
inline

The ARN of the role that grants AWS IoT permission to send an input to an AWS IoT Events detector. ("Action":"iotevents:BatchPutMessage").

Definition at line 243 of file IotEventsAction.h.

◆ WithBatchMode()

IotEventsAction& Aws::IoT::Model::IotEventsAction::WithBatchMode ( bool  value)
inline

Whether to process the event actions as a batch. The default value is false.

When batchMode is true, you can't specify a messageId.

When batchMode is true and the rule SQL statement evaluates to an Array, each Array element is treated as a separate message when it's sent to AWS IoT Events by calling BatchPutMessage . The resulting array can't have more than 10 messages.

Definition at line 212 of file IotEventsAction.h.

◆ WithInputName() [1/3]

IotEventsAction& Aws::IoT::Model::IotEventsAction::WithInputName ( Aws::String &&  value)
inline

The name of the AWS IoT Events input.

Definition at line 73 of file IotEventsAction.h.

◆ WithInputName() [2/3]

IotEventsAction& Aws::IoT::Model::IotEventsAction::WithInputName ( const Aws::String value)
inline

The name of the AWS IoT Events input.

Definition at line 68 of file IotEventsAction.h.

◆ WithInputName() [3/3]

IotEventsAction& Aws::IoT::Model::IotEventsAction::WithInputName ( const char *  value)
inline

The name of the AWS IoT Events input.

Definition at line 78 of file IotEventsAction.h.

◆ WithMessageId() [1/3]

IotEventsAction& Aws::IoT::Model::IotEventsAction::WithMessageId ( Aws::String &&  value)
inline

The ID of the message. The default messageId is a new UUID value.

When batchMode is true, you can't specify a messageId–a new UUID value will be assigned.

Assign a value to this property to ensure that only one input (message) with a given messageId will be processed by an AWS IoT Events detector.

Definition at line 149 of file IotEventsAction.h.

◆ WithMessageId() [2/3]

IotEventsAction& Aws::IoT::Model::IotEventsAction::WithMessageId ( const Aws::String value)
inline

The ID of the message. The default messageId is a new UUID value.

When batchMode is true, you can't specify a messageId–a new UUID value will be assigned.

Assign a value to this property to ensure that only one input (message) with a given messageId will be processed by an AWS IoT Events detector.

Definition at line 139 of file IotEventsAction.h.

◆ WithMessageId() [3/3]

IotEventsAction& Aws::IoT::Model::IotEventsAction::WithMessageId ( const char *  value)
inline

The ID of the message. The default messageId is a new UUID value.

When batchMode is true, you can't specify a messageId–a new UUID value will be assigned.

Assign a value to this property to ensure that only one input (message) with a given messageId will be processed by an AWS IoT Events detector.

Definition at line 159 of file IotEventsAction.h.

◆ WithRoleArn() [1/3]

IotEventsAction& Aws::IoT::Model::IotEventsAction::WithRoleArn ( Aws::String &&  value)
inline

The ARN of the role that grants AWS IoT permission to send an input to an AWS IoT Events detector. ("Action":"iotevents:BatchPutMessage").

Definition at line 255 of file IotEventsAction.h.

◆ WithRoleArn() [2/3]

IotEventsAction& Aws::IoT::Model::IotEventsAction::WithRoleArn ( const Aws::String value)
inline

The ARN of the role that grants AWS IoT permission to send an input to an AWS IoT Events detector. ("Action":"iotevents:BatchPutMessage").

Definition at line 249 of file IotEventsAction.h.

◆ WithRoleArn() [3/3]

IotEventsAction& Aws::IoT::Model::IotEventsAction::WithRoleArn ( const char *  value)
inline

The ARN of the role that grants AWS IoT permission to send an input to an AWS IoT Events detector. ("Action":"iotevents:BatchPutMessage").

Definition at line 261 of file IotEventsAction.h.


The documentation for this class was generated from the following file: