AWS SDK for C++  1.9.130
AWS SDK for C++
Public Member Functions | List of all members
Aws::LexRuntimeV2::Model::StartConversationRequest Class Reference

#include <StartConversationRequest.h>

+ Inheritance diagram for Aws::LexRuntimeV2::Model::StartConversationRequest:

Public Member Functions

 StartConversationRequest ()
 
virtual const char * GetServiceRequestName () const override
 
virtual bool IsEventStreamRequest () const override
 
Aws::String SerializePayload () const override
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
Aws::Utils::Event::EventStreamDecoderGetEventStreamDecoder ()
 
const StartConversationHandlerGetEventStreamHandler () const
 
void SetEventStreamHandler (const StartConversationHandler &value)
 
StartConversationRequestWithEventStreamHandler (const StartConversationHandler &value)
 
const Aws::StringGetBotId () const
 
bool BotIdHasBeenSet () const
 
void SetBotId (const Aws::String &value)
 
void SetBotId (Aws::String &&value)
 
void SetBotId (const char *value)
 
StartConversationRequestWithBotId (const Aws::String &value)
 
StartConversationRequestWithBotId (Aws::String &&value)
 
StartConversationRequestWithBotId (const char *value)
 
const Aws::StringGetBotAliasId () const
 
bool BotAliasIdHasBeenSet () const
 
void SetBotAliasId (const Aws::String &value)
 
void SetBotAliasId (Aws::String &&value)
 
void SetBotAliasId (const char *value)
 
StartConversationRequestWithBotAliasId (const Aws::String &value)
 
StartConversationRequestWithBotAliasId (Aws::String &&value)
 
StartConversationRequestWithBotAliasId (const char *value)
 
const Aws::StringGetLocaleId () const
 
bool LocaleIdHasBeenSet () const
 
void SetLocaleId (const Aws::String &value)
 
void SetLocaleId (Aws::String &&value)
 
void SetLocaleId (const char *value)
 
StartConversationRequestWithLocaleId (const Aws::String &value)
 
StartConversationRequestWithLocaleId (Aws::String &&value)
 
StartConversationRequestWithLocaleId (const char *value)
 
const Aws::StringGetSessionId () const
 
bool SessionIdHasBeenSet () const
 
void SetSessionId (const Aws::String &value)
 
void SetSessionId (Aws::String &&value)
 
void SetSessionId (const char *value)
 
StartConversationRequestWithSessionId (const Aws::String &value)
 
StartConversationRequestWithSessionId (Aws::String &&value)
 
StartConversationRequestWithSessionId (const char *value)
 
const ConversationModeGetConversationMode () const
 
bool ConversationModeHasBeenSet () const
 
void SetConversationMode (const ConversationMode &value)
 
void SetConversationMode (ConversationMode &&value)
 
StartConversationRequestWithConversationMode (const ConversationMode &value)
 
StartConversationRequestWithConversationMode (ConversationMode &&value)
 
std::shared_ptr< StartConversationRequestEventStreamGetRequestEventStream () const
 
void SetRequestEventStream (const std::shared_ptr< StartConversationRequestEventStream > &value)
 
StartConversationRequestWithRequestEventStream (const std::shared_ptr< StartConversationRequestEventStream > &value)
 
- Public Member Functions inherited from Aws::LexRuntimeV2::LexRuntimeV2Request
virtual ~LexRuntimeV2Request ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
- 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 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::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 26 of file StartConversationRequest.h.

Constructor & Destructor Documentation

◆ StartConversationRequest()

Aws::LexRuntimeV2::Model::StartConversationRequest::StartConversationRequest ( )

Member Function Documentation

◆ BotAliasIdHasBeenSet()

bool Aws::LexRuntimeV2::Model::StartConversationRequest::BotAliasIdHasBeenSet ( ) const
inline

The alias identifier in use for the bot that processes the request.

Definition at line 114 of file StartConversationRequest.h.

◆ BotIdHasBeenSet()

bool Aws::LexRuntimeV2::Model::StartConversationRequest::BotIdHasBeenSet ( ) const
inline

The identifier of the bot to process the request.

Definition at line 73 of file StartConversationRequest.h.

◆ ConversationModeHasBeenSet()

bool Aws::LexRuntimeV2::Model::StartConversationRequest::ConversationModeHasBeenSet ( ) const
inline

The conversation type that you are using the Amazon Lex V2. If the conversation mode is AUDIO you can send both audio and DTMF information. If the mode is TEXT you can only send text.

Definition at line 241 of file StartConversationRequest.h.

◆ GetBody()

std::shared_ptr<Aws::IOStream> Aws::LexRuntimeV2::Model::StartConversationRequest::GetBody ( ) const
overridevirtual

Loads serialized payload into string buf and returns the stream

Reimplemented from Aws::AmazonSerializableWebServiceRequest.

◆ GetBotAliasId()

const Aws::String& Aws::LexRuntimeV2::Model::StartConversationRequest::GetBotAliasId ( ) const
inline

The alias identifier in use for the bot that processes the request.

Definition at line 109 of file StartConversationRequest.h.

◆ GetBotId()

const Aws::String& Aws::LexRuntimeV2::Model::StartConversationRequest::GetBotId ( ) const
inline

The identifier of the bot to process the request.

Definition at line 68 of file StartConversationRequest.h.

◆ GetConversationMode()

const ConversationMode& Aws::LexRuntimeV2::Model::StartConversationRequest::GetConversationMode ( ) const
inline

The conversation type that you are using the Amazon Lex V2. If the conversation mode is AUDIO you can send both audio and DTMF information. If the mode is TEXT you can only send text.

Definition at line 234 of file StartConversationRequest.h.

◆ GetEventStreamDecoder()

Aws::Utils::Event::EventStreamDecoder& Aws::LexRuntimeV2::Model::StartConversationRequest::GetEventStreamDecoder ( )
inline

Underlying Event Stream Decoder.

Definition at line 47 of file StartConversationRequest.h.

◆ GetEventStreamHandler()

const StartConversationHandler& Aws::LexRuntimeV2::Model::StartConversationRequest::GetEventStreamHandler ( ) const
inline

Underlying Event Stream Handler which is used to define callback functions.

Definition at line 52 of file StartConversationRequest.h.

◆ GetLocaleId()

const Aws::String& Aws::LexRuntimeV2::Model::StartConversationRequest::GetLocaleId ( ) const
inline

The locale where the session is in use.

Definition at line 150 of file StartConversationRequest.h.

◆ GetRequestEventStream()

std::shared_ptr<StartConversationRequestEventStream> Aws::LexRuntimeV2::Model::StartConversationRequest::GetRequestEventStream ( ) const
inline

Represents the stream of events to Amazon Lex V2 from your application. The events are encoded as HTTP/2 data frames.

Definition at line 276 of file StartConversationRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::LexRuntimeV2::Model::StartConversationRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetServiceRequestName()

virtual const char* Aws::LexRuntimeV2::Model::StartConversationRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 35 of file StartConversationRequest.h.

◆ GetSessionId()

const Aws::String& Aws::LexRuntimeV2::Model::StartConversationRequest::GetSessionId ( ) const
inline

The identifier of the user session that is having the conversation.

Definition at line 191 of file StartConversationRequest.h.

◆ IsEventStreamRequest()

virtual bool Aws::LexRuntimeV2::Model::StartConversationRequest::IsEventStreamRequest ( ) const
inlineoverridevirtual

Defaults to false, if this is set to true in derived class, it's an event stream request, which means the payload is consisted by multiple structured events.

Reimplemented from Aws::AmazonWebServiceRequest.

Definition at line 37 of file StartConversationRequest.h.

◆ LocaleIdHasBeenSet()

bool Aws::LexRuntimeV2::Model::StartConversationRequest::LocaleIdHasBeenSet ( ) const
inline

The locale where the session is in use.

Definition at line 155 of file StartConversationRequest.h.

◆ SerializePayload()

Aws::String Aws::LexRuntimeV2::Model::StartConversationRequest::SerializePayload ( ) const
inlineoverridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

Definition at line 40 of file StartConversationRequest.h.

◆ SessionIdHasBeenSet()

bool Aws::LexRuntimeV2::Model::StartConversationRequest::SessionIdHasBeenSet ( ) const
inline

The identifier of the user session that is having the conversation.

Definition at line 196 of file StartConversationRequest.h.

◆ SetBotAliasId() [1/3]

void Aws::LexRuntimeV2::Model::StartConversationRequest::SetBotAliasId ( Aws::String &&  value)
inline

The alias identifier in use for the bot that processes the request.

Definition at line 124 of file StartConversationRequest.h.

◆ SetBotAliasId() [2/3]

void Aws::LexRuntimeV2::Model::StartConversationRequest::SetBotAliasId ( const Aws::String value)
inline

The alias identifier in use for the bot that processes the request.

Definition at line 119 of file StartConversationRequest.h.

◆ SetBotAliasId() [3/3]

void Aws::LexRuntimeV2::Model::StartConversationRequest::SetBotAliasId ( const char *  value)
inline

The alias identifier in use for the bot that processes the request.

Definition at line 129 of file StartConversationRequest.h.

◆ SetBotId() [1/3]

void Aws::LexRuntimeV2::Model::StartConversationRequest::SetBotId ( Aws::String &&  value)
inline

The identifier of the bot to process the request.

Definition at line 83 of file StartConversationRequest.h.

◆ SetBotId() [2/3]

void Aws::LexRuntimeV2::Model::StartConversationRequest::SetBotId ( const Aws::String value)
inline

The identifier of the bot to process the request.

Definition at line 78 of file StartConversationRequest.h.

◆ SetBotId() [3/3]

void Aws::LexRuntimeV2::Model::StartConversationRequest::SetBotId ( const char *  value)
inline

The identifier of the bot to process the request.

Definition at line 88 of file StartConversationRequest.h.

◆ SetConversationMode() [1/2]

void Aws::LexRuntimeV2::Model::StartConversationRequest::SetConversationMode ( const ConversationMode value)
inline

The conversation type that you are using the Amazon Lex V2. If the conversation mode is AUDIO you can send both audio and DTMF information. If the mode is TEXT you can only send text.

Definition at line 248 of file StartConversationRequest.h.

◆ SetConversationMode() [2/2]

void Aws::LexRuntimeV2::Model::StartConversationRequest::SetConversationMode ( ConversationMode &&  value)
inline

The conversation type that you are using the Amazon Lex V2. If the conversation mode is AUDIO you can send both audio and DTMF information. If the mode is TEXT you can only send text.

Definition at line 255 of file StartConversationRequest.h.

◆ SetEventStreamHandler()

void Aws::LexRuntimeV2::Model::StartConversationRequest::SetEventStreamHandler ( const StartConversationHandler value)
inline

Underlying Event Stream Handler which is used to define callback functions.

Definition at line 57 of file StartConversationRequest.h.

◆ SetLocaleId() [1/3]

void Aws::LexRuntimeV2::Model::StartConversationRequest::SetLocaleId ( Aws::String &&  value)
inline

The locale where the session is in use.

Definition at line 165 of file StartConversationRequest.h.

◆ SetLocaleId() [2/3]

void Aws::LexRuntimeV2::Model::StartConversationRequest::SetLocaleId ( const Aws::String value)
inline

The locale where the session is in use.

Definition at line 160 of file StartConversationRequest.h.

◆ SetLocaleId() [3/3]

void Aws::LexRuntimeV2::Model::StartConversationRequest::SetLocaleId ( const char *  value)
inline

The locale where the session is in use.

Definition at line 170 of file StartConversationRequest.h.

◆ SetRequestEventStream()

void Aws::LexRuntimeV2::Model::StartConversationRequest::SetRequestEventStream ( const std::shared_ptr< StartConversationRequestEventStream > &  value)
inline

Represents the stream of events to Amazon Lex V2 from your application. The events are encoded as HTTP/2 data frames.

Definition at line 282 of file StartConversationRequest.h.

◆ SetSessionId() [1/3]

void Aws::LexRuntimeV2::Model::StartConversationRequest::SetSessionId ( Aws::String &&  value)
inline

The identifier of the user session that is having the conversation.

Definition at line 206 of file StartConversationRequest.h.

◆ SetSessionId() [2/3]

void Aws::LexRuntimeV2::Model::StartConversationRequest::SetSessionId ( const Aws::String value)
inline

The identifier of the user session that is having the conversation.

Definition at line 201 of file StartConversationRequest.h.

◆ SetSessionId() [3/3]

void Aws::LexRuntimeV2::Model::StartConversationRequest::SetSessionId ( const char *  value)
inline

The identifier of the user session that is having the conversation.

Definition at line 211 of file StartConversationRequest.h.

◆ WithBotAliasId() [1/3]

StartConversationRequest& Aws::LexRuntimeV2::Model::StartConversationRequest::WithBotAliasId ( Aws::String &&  value)
inline

The alias identifier in use for the bot that processes the request.

Definition at line 139 of file StartConversationRequest.h.

◆ WithBotAliasId() [2/3]

StartConversationRequest& Aws::LexRuntimeV2::Model::StartConversationRequest::WithBotAliasId ( const Aws::String value)
inline

The alias identifier in use for the bot that processes the request.

Definition at line 134 of file StartConversationRequest.h.

◆ WithBotAliasId() [3/3]

StartConversationRequest& Aws::LexRuntimeV2::Model::StartConversationRequest::WithBotAliasId ( const char *  value)
inline

The alias identifier in use for the bot that processes the request.

Definition at line 144 of file StartConversationRequest.h.

◆ WithBotId() [1/3]

StartConversationRequest& Aws::LexRuntimeV2::Model::StartConversationRequest::WithBotId ( Aws::String &&  value)
inline

The identifier of the bot to process the request.

Definition at line 98 of file StartConversationRequest.h.

◆ WithBotId() [2/3]

StartConversationRequest& Aws::LexRuntimeV2::Model::StartConversationRequest::WithBotId ( const Aws::String value)
inline

The identifier of the bot to process the request.

Definition at line 93 of file StartConversationRequest.h.

◆ WithBotId() [3/3]

StartConversationRequest& Aws::LexRuntimeV2::Model::StartConversationRequest::WithBotId ( const char *  value)
inline

The identifier of the bot to process the request.

Definition at line 103 of file StartConversationRequest.h.

◆ WithConversationMode() [1/2]

StartConversationRequest& Aws::LexRuntimeV2::Model::StartConversationRequest::WithConversationMode ( const ConversationMode value)
inline

The conversation type that you are using the Amazon Lex V2. If the conversation mode is AUDIO you can send both audio and DTMF information. If the mode is TEXT you can only send text.

Definition at line 262 of file StartConversationRequest.h.

◆ WithConversationMode() [2/2]

StartConversationRequest& Aws::LexRuntimeV2::Model::StartConversationRequest::WithConversationMode ( ConversationMode &&  value)
inline

The conversation type that you are using the Amazon Lex V2. If the conversation mode is AUDIO you can send both audio and DTMF information. If the mode is TEXT you can only send text.

Definition at line 269 of file StartConversationRequest.h.

◆ WithEventStreamHandler()

StartConversationRequest& Aws::LexRuntimeV2::Model::StartConversationRequest::WithEventStreamHandler ( const StartConversationHandler value)
inline

Underlying Event Stream Handler which is used to define callback functions.

Definition at line 62 of file StartConversationRequest.h.

◆ WithLocaleId() [1/3]

StartConversationRequest& Aws::LexRuntimeV2::Model::StartConversationRequest::WithLocaleId ( Aws::String &&  value)
inline

The locale where the session is in use.

Definition at line 180 of file StartConversationRequest.h.

◆ WithLocaleId() [2/3]

StartConversationRequest& Aws::LexRuntimeV2::Model::StartConversationRequest::WithLocaleId ( const Aws::String value)
inline

The locale where the session is in use.

Definition at line 175 of file StartConversationRequest.h.

◆ WithLocaleId() [3/3]

StartConversationRequest& Aws::LexRuntimeV2::Model::StartConversationRequest::WithLocaleId ( const char *  value)
inline

The locale where the session is in use.

Definition at line 185 of file StartConversationRequest.h.

◆ WithRequestEventStream()

StartConversationRequest& Aws::LexRuntimeV2::Model::StartConversationRequest::WithRequestEventStream ( const std::shared_ptr< StartConversationRequestEventStream > &  value)
inline

Represents the stream of events to Amazon Lex V2 from your application. The events are encoded as HTTP/2 data frames.

Definition at line 288 of file StartConversationRequest.h.

◆ WithSessionId() [1/3]

StartConversationRequest& Aws::LexRuntimeV2::Model::StartConversationRequest::WithSessionId ( Aws::String &&  value)
inline

The identifier of the user session that is having the conversation.

Definition at line 221 of file StartConversationRequest.h.

◆ WithSessionId() [2/3]

StartConversationRequest& Aws::LexRuntimeV2::Model::StartConversationRequest::WithSessionId ( const Aws::String value)
inline

The identifier of the user session that is having the conversation.

Definition at line 216 of file StartConversationRequest.h.

◆ WithSessionId() [3/3]

StartConversationRequest& Aws::LexRuntimeV2::Model::StartConversationRequest::WithSessionId ( const char *  value)
inline

The identifier of the user session that is having the conversation.

Definition at line 226 of file StartConversationRequest.h.


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