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

#include <IotAnalyticsAction.h>

Public Member Functions

 IotAnalyticsAction ()
 
 IotAnalyticsAction (Aws::Utils::Json::JsonView jsonValue)
 
IotAnalyticsActionoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetChannelArn () const
 
bool ChannelArnHasBeenSet () const
 
void SetChannelArn (const Aws::String &value)
 
void SetChannelArn (Aws::String &&value)
 
void SetChannelArn (const char *value)
 
IotAnalyticsActionWithChannelArn (const Aws::String &value)
 
IotAnalyticsActionWithChannelArn (Aws::String &&value)
 
IotAnalyticsActionWithChannelArn (const char *value)
 
const Aws::StringGetChannelName () const
 
bool ChannelNameHasBeenSet () const
 
void SetChannelName (const Aws::String &value)
 
void SetChannelName (Aws::String &&value)
 
void SetChannelName (const char *value)
 
IotAnalyticsActionWithChannelName (const Aws::String &value)
 
IotAnalyticsActionWithChannelName (Aws::String &&value)
 
IotAnalyticsActionWithChannelName (const char *value)
 
bool GetBatchMode () const
 
bool BatchModeHasBeenSet () const
 
void SetBatchMode (bool value)
 
IotAnalyticsActionWithBatchMode (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)
 
IotAnalyticsActionWithRoleArn (const Aws::String &value)
 
IotAnalyticsActionWithRoleArn (Aws::String &&value)
 
IotAnalyticsActionWithRoleArn (const char *value)
 

Detailed Description

Sends message data to an AWS IoT Analytics channel.

See Also:

AWS API Reference

Definition at line 32 of file IotAnalyticsAction.h.

Constructor & Destructor Documentation

◆ IotAnalyticsAction() [1/2]

Aws::IoT::Model::IotAnalyticsAction::IotAnalyticsAction ( )

◆ IotAnalyticsAction() [2/2]

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

Member Function Documentation

◆ BatchModeHasBeenSet()

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

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

When batchMode is true and the rule SQL statement evaluates to an Array, each Array element is delivered as a separate message when passed by BatchPutMessage to the AWS IoT Analytics channel. The resulting array can't have more than 100 messages.

Definition at line 151 of file IotAnalyticsAction.h.

◆ ChannelArnHasBeenSet()

bool Aws::IoT::Model::IotAnalyticsAction::ChannelArnHasBeenSet ( ) const
inline

(deprecated) The ARN of the IoT Analytics channel to which message data will be sent.

Definition at line 51 of file IotAnalyticsAction.h.

◆ ChannelNameHasBeenSet()

bool Aws::IoT::Model::IotAnalyticsAction::ChannelNameHasBeenSet ( ) const
inline

The name of the IoT Analytics channel to which message data will be sent.

Definition at line 98 of file IotAnalyticsAction.h.

◆ GetBatchMode()

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

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

When batchMode is true and the rule SQL statement evaluates to an Array, each Array element is delivered as a separate message when passed by BatchPutMessage to the AWS IoT Analytics channel. The resulting array can't have more than 100 messages.

Definition at line 140 of file IotAnalyticsAction.h.

◆ GetChannelArn()

const Aws::String& Aws::IoT::Model::IotAnalyticsAction::GetChannelArn ( ) const
inline

(deprecated) The ARN of the IoT Analytics channel to which message data will be sent.

Definition at line 45 of file IotAnalyticsAction.h.

◆ GetChannelName()

const Aws::String& Aws::IoT::Model::IotAnalyticsAction::GetChannelName ( ) const
inline

The name of the IoT Analytics channel to which message data will be sent.

Definition at line 93 of file IotAnalyticsAction.h.

◆ GetRoleArn()

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

The ARN of the role which has a policy that grants IoT Analytics permission to send message data via IoT Analytics (iotanalytics:BatchPutMessage).

Definition at line 180 of file IotAnalyticsAction.h.

◆ Jsonize()

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

◆ operator=()

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

◆ RoleArnHasBeenSet()

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

The ARN of the role which has a policy that grants IoT Analytics permission to send message data via IoT Analytics (iotanalytics:BatchPutMessage).

Definition at line 186 of file IotAnalyticsAction.h.

◆ SetBatchMode()

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

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

When batchMode is true and the rule SQL statement evaluates to an Array, each Array element is delivered as a separate message when passed by BatchPutMessage to the AWS IoT Analytics channel. The resulting array can't have more than 100 messages.

Definition at line 162 of file IotAnalyticsAction.h.

◆ SetChannelArn() [1/3]

void Aws::IoT::Model::IotAnalyticsAction::SetChannelArn ( Aws::String &&  value)
inline

(deprecated) The ARN of the IoT Analytics channel to which message data will be sent.

Definition at line 63 of file IotAnalyticsAction.h.

◆ SetChannelArn() [2/3]

void Aws::IoT::Model::IotAnalyticsAction::SetChannelArn ( const Aws::String value)
inline

(deprecated) The ARN of the IoT Analytics channel to which message data will be sent.

Definition at line 57 of file IotAnalyticsAction.h.

◆ SetChannelArn() [3/3]

void Aws::IoT::Model::IotAnalyticsAction::SetChannelArn ( const char *  value)
inline

(deprecated) The ARN of the IoT Analytics channel to which message data will be sent.

Definition at line 69 of file IotAnalyticsAction.h.

◆ SetChannelName() [1/3]

void Aws::IoT::Model::IotAnalyticsAction::SetChannelName ( Aws::String &&  value)
inline

The name of the IoT Analytics channel to which message data will be sent.

Definition at line 108 of file IotAnalyticsAction.h.

◆ SetChannelName() [2/3]

void Aws::IoT::Model::IotAnalyticsAction::SetChannelName ( const Aws::String value)
inline

The name of the IoT Analytics channel to which message data will be sent.

Definition at line 103 of file IotAnalyticsAction.h.

◆ SetChannelName() [3/3]

void Aws::IoT::Model::IotAnalyticsAction::SetChannelName ( const char *  value)
inline

The name of the IoT Analytics channel to which message data will be sent.

Definition at line 113 of file IotAnalyticsAction.h.

◆ SetRoleArn() [1/3]

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

The ARN of the role which has a policy that grants IoT Analytics permission to send message data via IoT Analytics (iotanalytics:BatchPutMessage).

Definition at line 198 of file IotAnalyticsAction.h.

◆ SetRoleArn() [2/3]

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

The ARN of the role which has a policy that grants IoT Analytics permission to send message data via IoT Analytics (iotanalytics:BatchPutMessage).

Definition at line 192 of file IotAnalyticsAction.h.

◆ SetRoleArn() [3/3]

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

The ARN of the role which has a policy that grants IoT Analytics permission to send message data via IoT Analytics (iotanalytics:BatchPutMessage).

Definition at line 204 of file IotAnalyticsAction.h.

◆ WithBatchMode()

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

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

When batchMode is true and the rule SQL statement evaluates to an Array, each Array element is delivered as a separate message when passed by BatchPutMessage to the AWS IoT Analytics channel. The resulting array can't have more than 100 messages.

Definition at line 173 of file IotAnalyticsAction.h.

◆ WithChannelArn() [1/3]

IotAnalyticsAction& Aws::IoT::Model::IotAnalyticsAction::WithChannelArn ( Aws::String &&  value)
inline

(deprecated) The ARN of the IoT Analytics channel to which message data will be sent.

Definition at line 81 of file IotAnalyticsAction.h.

◆ WithChannelArn() [2/3]

IotAnalyticsAction& Aws::IoT::Model::IotAnalyticsAction::WithChannelArn ( const Aws::String value)
inline

(deprecated) The ARN of the IoT Analytics channel to which message data will be sent.

Definition at line 75 of file IotAnalyticsAction.h.

◆ WithChannelArn() [3/3]

IotAnalyticsAction& Aws::IoT::Model::IotAnalyticsAction::WithChannelArn ( const char *  value)
inline

(deprecated) The ARN of the IoT Analytics channel to which message data will be sent.

Definition at line 87 of file IotAnalyticsAction.h.

◆ WithChannelName() [1/3]

IotAnalyticsAction& Aws::IoT::Model::IotAnalyticsAction::WithChannelName ( Aws::String &&  value)
inline

The name of the IoT Analytics channel to which message data will be sent.

Definition at line 123 of file IotAnalyticsAction.h.

◆ WithChannelName() [2/3]

IotAnalyticsAction& Aws::IoT::Model::IotAnalyticsAction::WithChannelName ( const Aws::String value)
inline

The name of the IoT Analytics channel to which message data will be sent.

Definition at line 118 of file IotAnalyticsAction.h.

◆ WithChannelName() [3/3]

IotAnalyticsAction& Aws::IoT::Model::IotAnalyticsAction::WithChannelName ( const char *  value)
inline

The name of the IoT Analytics channel to which message data will be sent.

Definition at line 128 of file IotAnalyticsAction.h.

◆ WithRoleArn() [1/3]

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

The ARN of the role which has a policy that grants IoT Analytics permission to send message data via IoT Analytics (iotanalytics:BatchPutMessage).

Definition at line 216 of file IotAnalyticsAction.h.

◆ WithRoleArn() [2/3]

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

The ARN of the role which has a policy that grants IoT Analytics permission to send message data via IoT Analytics (iotanalytics:BatchPutMessage).

Definition at line 210 of file IotAnalyticsAction.h.

◆ WithRoleArn() [3/3]

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

The ARN of the role which has a policy that grants IoT Analytics permission to send message data via IoT Analytics (iotanalytics:BatchPutMessage).

Definition at line 222 of file IotAnalyticsAction.h.


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