AWS SDK for C++  1.8.94
AWS SDK for C++
Public Member Functions | List of all members
Aws::IoTAnalytics::Model::BatchPutMessageRequest Class Reference

#include <BatchPutMessageRequest.h>

+ Inheritance diagram for Aws::IoTAnalytics::Model::BatchPutMessageRequest:

Public Member Functions

 BatchPutMessageRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetChannelName () const
 
bool ChannelNameHasBeenSet () const
 
void SetChannelName (const Aws::String &value)
 
void SetChannelName (Aws::String &&value)
 
void SetChannelName (const char *value)
 
BatchPutMessageRequestWithChannelName (const Aws::String &value)
 
BatchPutMessageRequestWithChannelName (Aws::String &&value)
 
BatchPutMessageRequestWithChannelName (const char *value)
 
const Aws::Vector< Message > & GetMessages () const
 
bool MessagesHasBeenSet () const
 
void SetMessages (const Aws::Vector< Message > &value)
 
void SetMessages (Aws::Vector< Message > &&value)
 
BatchPutMessageRequestWithMessages (const Aws::Vector< Message > &value)
 
BatchPutMessageRequestWithMessages (Aws::Vector< Message > &&value)
 
BatchPutMessageRequestAddMessages (const Message &value)
 
BatchPutMessageRequestAddMessages (Message &&value)
 
- Public Member Functions inherited from Aws::IoTAnalytics::IoTAnalyticsRequest
virtual ~IoTAnalyticsRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::IoTAnalytics::IoTAnalyticsRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 
- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 23 of file BatchPutMessageRequest.h.

Constructor & Destructor Documentation

◆ BatchPutMessageRequest()

Aws::IoTAnalytics::Model::BatchPutMessageRequest::BatchPutMessageRequest ( )

Member Function Documentation

◆ AddMessages() [1/2]

BatchPutMessageRequest& Aws::IoTAnalytics::Model::BatchPutMessageRequest::AddMessages ( const Message value)
inline

The list of messages to be sent. Each message has the format: { "messageId": "string", "payload": "string"}.

The field names of message payloads (data) that you send to AWS IoT Analytics:

  • Must contain only alphanumeric characters and undescores (_). No other special characters are allowed.

  • Must begin with an alphabetic character or single underscore (_).

  • Cannot contain hyphens (-).

  • In regular expression terms: "^[A-Za-z_]([A-Za-z0-9]*|[A-Za-z0-9][A-Za-z0-9_]*)$".

  • Cannot be more than 255 characters.

  • Are case insensitive. (Fields named foo and FOO in the same payload are considered duplicates.)

For example, {"temp_01": 29} or {"_temp_01": 29} are valid, but {"temp-01": 29}, {"01_temp": 29} or {"__temp_01": 29} are invalid in message payloads.

Definition at line 195 of file BatchPutMessageRequest.h.

◆ AddMessages() [2/2]

BatchPutMessageRequest& Aws::IoTAnalytics::Model::BatchPutMessageRequest::AddMessages ( Message &&  value)
inline

The list of messages to be sent. Each message has the format: { "messageId": "string", "payload": "string"}.

The field names of message payloads (data) that you send to AWS IoT Analytics:

  • Must contain only alphanumeric characters and undescores (_). No other special characters are allowed.

  • Must begin with an alphabetic character or single underscore (_).

  • Cannot contain hyphens (-).

  • In regular expression terms: "^[A-Za-z_]([A-Za-z0-9]*|[A-Za-z0-9][A-Za-z0-9_]*)$".

  • Cannot be more than 255 characters.

  • Are case insensitive. (Fields named foo and FOO in the same payload are considered duplicates.)

For example, {"temp_01": 29} or {"_temp_01": 29} are valid, but {"temp-01": 29}, {"01_temp": 29} or {"__temp_01": 29} are invalid in message payloads.

Definition at line 212 of file BatchPutMessageRequest.h.

◆ ChannelNameHasBeenSet()

bool Aws::IoTAnalytics::Model::BatchPutMessageRequest::ChannelNameHasBeenSet ( ) const
inline

The name of the channel where the messages are sent.

Definition at line 45 of file BatchPutMessageRequest.h.

◆ GetChannelName()

const Aws::String& Aws::IoTAnalytics::Model::BatchPutMessageRequest::GetChannelName ( ) const
inline

The name of the channel where the messages are sent.

Definition at line 40 of file BatchPutMessageRequest.h.

◆ GetMessages()

const Aws::Vector<Message>& Aws::IoTAnalytics::Model::BatchPutMessageRequest::GetMessages ( ) const
inline

The list of messages to be sent. Each message has the format: { "messageId": "string", "payload": "string"}.

The field names of message payloads (data) that you send to AWS IoT Analytics:

  • Must contain only alphanumeric characters and undescores (_). No other special characters are allowed.

  • Must begin with an alphabetic character or single underscore (_).

  • Cannot contain hyphens (-).

  • In regular expression terms: "^[A-Za-z_]([A-Za-z0-9]*|[A-Za-z0-9][A-Za-z0-9_]*)$".

  • Cannot be more than 255 characters.

  • Are case insensitive. (Fields named foo and FOO in the same payload are considered duplicates.)

For example, {"temp_01": 29} or {"_temp_01": 29} are valid, but {"temp-01": 29}, {"01_temp": 29} or {"__temp_01": 29} are invalid in message payloads.

Definition at line 93 of file BatchPutMessageRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::IoTAnalytics::Model::BatchPutMessageRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 32 of file BatchPutMessageRequest.h.

◆ MessagesHasBeenSet()

bool Aws::IoTAnalytics::Model::BatchPutMessageRequest::MessagesHasBeenSet ( ) const
inline

The list of messages to be sent. Each message has the format: { "messageId": "string", "payload": "string"}.

The field names of message payloads (data) that you send to AWS IoT Analytics:

  • Must contain only alphanumeric characters and undescores (_). No other special characters are allowed.

  • Must begin with an alphabetic character or single underscore (_).

  • Cannot contain hyphens (-).

  • In regular expression terms: "^[A-Za-z_]([A-Za-z0-9]*|[A-Za-z0-9][A-Za-z0-9_]*)$".

  • Cannot be more than 255 characters.

  • Are case insensitive. (Fields named foo and FOO in the same payload are considered duplicates.)

For example, {"temp_01": 29} or {"_temp_01": 29} are valid, but {"temp-01": 29}, {"01_temp": 29} or {"__temp_01": 29} are invalid in message payloads.

Definition at line 110 of file BatchPutMessageRequest.h.

◆ SerializePayload()

Aws::String Aws::IoTAnalytics::Model::BatchPutMessageRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetChannelName() [1/3]

void Aws::IoTAnalytics::Model::BatchPutMessageRequest::SetChannelName ( const Aws::String value)
inline

The name of the channel where the messages are sent.

Definition at line 50 of file BatchPutMessageRequest.h.

◆ SetChannelName() [2/3]

void Aws::IoTAnalytics::Model::BatchPutMessageRequest::SetChannelName ( Aws::String &&  value)
inline

The name of the channel where the messages are sent.

Definition at line 55 of file BatchPutMessageRequest.h.

◆ SetChannelName() [3/3]

void Aws::IoTAnalytics::Model::BatchPutMessageRequest::SetChannelName ( const char *  value)
inline

The name of the channel where the messages are sent.

Definition at line 60 of file BatchPutMessageRequest.h.

◆ SetMessages() [1/2]

void Aws::IoTAnalytics::Model::BatchPutMessageRequest::SetMessages ( const Aws::Vector< Message > &  value)
inline

The list of messages to be sent. Each message has the format: { "messageId": "string", "payload": "string"}.

The field names of message payloads (data) that you send to AWS IoT Analytics:

  • Must contain only alphanumeric characters and undescores (_). No other special characters are allowed.

  • Must begin with an alphabetic character or single underscore (_).

  • Cannot contain hyphens (-).

  • In regular expression terms: "^[A-Za-z_]([A-Za-z0-9]*|[A-Za-z0-9][A-Za-z0-9_]*)$".

  • Cannot be more than 255 characters.

  • Are case insensitive. (Fields named foo and FOO in the same payload are considered duplicates.)

For example, {"temp_01": 29} or {"_temp_01": 29} are valid, but {"temp-01": 29}, {"01_temp": 29} or {"__temp_01": 29} are invalid in message payloads.

Definition at line 127 of file BatchPutMessageRequest.h.

◆ SetMessages() [2/2]

void Aws::IoTAnalytics::Model::BatchPutMessageRequest::SetMessages ( Aws::Vector< Message > &&  value)
inline

The list of messages to be sent. Each message has the format: { "messageId": "string", "payload": "string"}.

The field names of message payloads (data) that you send to AWS IoT Analytics:

  • Must contain only alphanumeric characters and undescores (_). No other special characters are allowed.

  • Must begin with an alphabetic character or single underscore (_).

  • Cannot contain hyphens (-).

  • In regular expression terms: "^[A-Za-z_]([A-Za-z0-9]*|[A-Za-z0-9][A-Za-z0-9_]*)$".

  • Cannot be more than 255 characters.

  • Are case insensitive. (Fields named foo and FOO in the same payload are considered duplicates.)

For example, {"temp_01": 29} or {"_temp_01": 29} are valid, but {"temp-01": 29}, {"01_temp": 29} or {"__temp_01": 29} are invalid in message payloads.

Definition at line 144 of file BatchPutMessageRequest.h.

◆ WithChannelName() [1/3]

BatchPutMessageRequest& Aws::IoTAnalytics::Model::BatchPutMessageRequest::WithChannelName ( const Aws::String value)
inline

The name of the channel where the messages are sent.

Definition at line 65 of file BatchPutMessageRequest.h.

◆ WithChannelName() [2/3]

BatchPutMessageRequest& Aws::IoTAnalytics::Model::BatchPutMessageRequest::WithChannelName ( Aws::String &&  value)
inline

The name of the channel where the messages are sent.

Definition at line 70 of file BatchPutMessageRequest.h.

◆ WithChannelName() [3/3]

BatchPutMessageRequest& Aws::IoTAnalytics::Model::BatchPutMessageRequest::WithChannelName ( const char *  value)
inline

The name of the channel where the messages are sent.

Definition at line 75 of file BatchPutMessageRequest.h.

◆ WithMessages() [1/2]

BatchPutMessageRequest& Aws::IoTAnalytics::Model::BatchPutMessageRequest::WithMessages ( const Aws::Vector< Message > &  value)
inline

The list of messages to be sent. Each message has the format: { "messageId": "string", "payload": "string"}.

The field names of message payloads (data) that you send to AWS IoT Analytics:

  • Must contain only alphanumeric characters and undescores (_). No other special characters are allowed.

  • Must begin with an alphabetic character or single underscore (_).

  • Cannot contain hyphens (-).

  • In regular expression terms: "^[A-Za-z_]([A-Za-z0-9]*|[A-Za-z0-9][A-Za-z0-9_]*)$".

  • Cannot be more than 255 characters.

  • Are case insensitive. (Fields named foo and FOO in the same payload are considered duplicates.)

For example, {"temp_01": 29} or {"_temp_01": 29} are valid, but {"temp-01": 29}, {"01_temp": 29} or {"__temp_01": 29} are invalid in message payloads.

Definition at line 161 of file BatchPutMessageRequest.h.

◆ WithMessages() [2/2]

BatchPutMessageRequest& Aws::IoTAnalytics::Model::BatchPutMessageRequest::WithMessages ( Aws::Vector< Message > &&  value)
inline

The list of messages to be sent. Each message has the format: { "messageId": "string", "payload": "string"}.

The field names of message payloads (data) that you send to AWS IoT Analytics:

  • Must contain only alphanumeric characters and undescores (_). No other special characters are allowed.

  • Must begin with an alphabetic character or single underscore (_).

  • Cannot contain hyphens (-).

  • In regular expression terms: "^[A-Za-z_]([A-Za-z0-9]*|[A-Za-z0-9][A-Za-z0-9_]*)$".

  • Cannot be more than 255 characters.

  • Are case insensitive. (Fields named foo and FOO in the same payload are considered duplicates.)

For example, {"temp_01": 29} or {"_temp_01": 29} are valid, but {"temp-01": 29}, {"01_temp": 29} or {"__temp_01": 29} are invalid in message payloads.

Definition at line 178 of file BatchPutMessageRequest.h.


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