AWS SDK for C++  1.9.160
AWS SDK for C++
StartConversationRequest.h
Go to the documentation of this file.
1 
6 #pragma once
11 #include <memory>
15 #include <utility>
16 
17 namespace Aws
18 {
19 namespace LexRuntimeV2
20 {
21 namespace Model
22 {
23 
27  {
28  public:
30 
31  // Service request name is the Operation name which will send this request out,
32  // each operation should has unique request name, so that we can get operation's name from this request.
33  // Note: this is not true for response, multiple operations may have the same response name,
34  // so we can not get operation's name from response.
35  inline virtual const char* GetServiceRequestName() const override { return "StartConversation"; }
36 
37  inline virtual bool IsEventStreamRequest() const override { return true; }
38  // SerializePayload will not be invoked.
39  // This request is sent by encoding its data in event-streams which is sent as IOStream via GetBody()
40  Aws::String SerializePayload() const override { return {}; }
41  std::shared_ptr<Aws::IOStream> GetBody() const override;
43 
48 
52  inline const StartConversationHandler& GetEventStreamHandler() const { return m_handler; }
53 
57  inline void SetEventStreamHandler(const StartConversationHandler& value) { m_handler = value; m_decoder.ResetEventStreamHandler(&m_handler); }
58 
62  inline StartConversationRequest& WithEventStreamHandler(const StartConversationHandler& value) { SetEventStreamHandler(value); return *this; }
63 
64 
68  inline const Aws::String& GetBotId() const{ return m_botId; }
69 
73  inline bool BotIdHasBeenSet() const { return m_botIdHasBeenSet; }
74 
78  inline void SetBotId(const Aws::String& value) { m_botIdHasBeenSet = true; m_botId = value; }
79 
83  inline void SetBotId(Aws::String&& value) { m_botIdHasBeenSet = true; m_botId = std::move(value); }
84 
88  inline void SetBotId(const char* value) { m_botIdHasBeenSet = true; m_botId.assign(value); }
89 
93  inline StartConversationRequest& WithBotId(const Aws::String& value) { SetBotId(value); return *this;}
94 
98  inline StartConversationRequest& WithBotId(Aws::String&& value) { SetBotId(std::move(value)); return *this;}
99 
103  inline StartConversationRequest& WithBotId(const char* value) { SetBotId(value); return *this;}
104 
105 
109  inline const Aws::String& GetBotAliasId() const{ return m_botAliasId; }
110 
114  inline bool BotAliasIdHasBeenSet() const { return m_botAliasIdHasBeenSet; }
115 
119  inline void SetBotAliasId(const Aws::String& value) { m_botAliasIdHasBeenSet = true; m_botAliasId = value; }
120 
124  inline void SetBotAliasId(Aws::String&& value) { m_botAliasIdHasBeenSet = true; m_botAliasId = std::move(value); }
125 
129  inline void SetBotAliasId(const char* value) { m_botAliasIdHasBeenSet = true; m_botAliasId.assign(value); }
130 
134  inline StartConversationRequest& WithBotAliasId(const Aws::String& value) { SetBotAliasId(value); return *this;}
135 
139  inline StartConversationRequest& WithBotAliasId(Aws::String&& value) { SetBotAliasId(std::move(value)); return *this;}
140 
144  inline StartConversationRequest& WithBotAliasId(const char* value) { SetBotAliasId(value); return *this;}
145 
146 
150  inline const Aws::String& GetLocaleId() const{ return m_localeId; }
151 
155  inline bool LocaleIdHasBeenSet() const { return m_localeIdHasBeenSet; }
156 
160  inline void SetLocaleId(const Aws::String& value) { m_localeIdHasBeenSet = true; m_localeId = value; }
161 
165  inline void SetLocaleId(Aws::String&& value) { m_localeIdHasBeenSet = true; m_localeId = std::move(value); }
166 
170  inline void SetLocaleId(const char* value) { m_localeIdHasBeenSet = true; m_localeId.assign(value); }
171 
175  inline StartConversationRequest& WithLocaleId(const Aws::String& value) { SetLocaleId(value); return *this;}
176 
180  inline StartConversationRequest& WithLocaleId(Aws::String&& value) { SetLocaleId(std::move(value)); return *this;}
181 
185  inline StartConversationRequest& WithLocaleId(const char* value) { SetLocaleId(value); return *this;}
186 
187 
191  inline const Aws::String& GetSessionId() const{ return m_sessionId; }
192 
196  inline bool SessionIdHasBeenSet() const { return m_sessionIdHasBeenSet; }
197 
201  inline void SetSessionId(const Aws::String& value) { m_sessionIdHasBeenSet = true; m_sessionId = value; }
202 
206  inline void SetSessionId(Aws::String&& value) { m_sessionIdHasBeenSet = true; m_sessionId = std::move(value); }
207 
211  inline void SetSessionId(const char* value) { m_sessionIdHasBeenSet = true; m_sessionId.assign(value); }
212 
216  inline StartConversationRequest& WithSessionId(const Aws::String& value) { SetSessionId(value); return *this;}
217 
221  inline StartConversationRequest& WithSessionId(Aws::String&& value) { SetSessionId(std::move(value)); return *this;}
222 
226  inline StartConversationRequest& WithSessionId(const char* value) { SetSessionId(value); return *this;}
227 
228 
234  inline const ConversationMode& GetConversationMode() const{ return m_conversationMode; }
235 
241  inline bool ConversationModeHasBeenSet() const { return m_conversationModeHasBeenSet; }
242 
248  inline void SetConversationMode(const ConversationMode& value) { m_conversationModeHasBeenSet = true; m_conversationMode = value; }
249 
255  inline void SetConversationMode(ConversationMode&& value) { m_conversationModeHasBeenSet = true; m_conversationMode = std::move(value); }
256 
262  inline StartConversationRequest& WithConversationMode(const ConversationMode& value) { SetConversationMode(value); return *this;}
263 
269  inline StartConversationRequest& WithConversationMode(ConversationMode&& value) { SetConversationMode(std::move(value)); return *this;}
270 
271 
276  std::shared_ptr<StartConversationRequestEventStream> GetRequestEventStream() const { return m_requestEventStream; }
277 
282  void SetRequestEventStream(const std::shared_ptr<StartConversationRequestEventStream>& value) { m_requestEventStream = value; }
283 
288  StartConversationRequest& WithRequestEventStream(const std::shared_ptr<StartConversationRequestEventStream>& value) { SetRequestEventStream(value); return *this;}
289 
290  private:
291 
292  Aws::String m_botId;
293  bool m_botIdHasBeenSet;
294 
295  Aws::String m_botAliasId;
296  bool m_botAliasIdHasBeenSet;
297 
298  Aws::String m_localeId;
299  bool m_localeIdHasBeenSet;
300 
301  Aws::String m_sessionId;
302  bool m_sessionIdHasBeenSet;
303 
304  ConversationMode m_conversationMode;
305  bool m_conversationModeHasBeenSet;
306 
307  std::shared_ptr<StartConversationRequestEventStream> m_requestEventStream;
309  StartConversationHandler m_handler;
310 
311  };
312 
313 } // namespace Model
314 } // namespace LexRuntimeV2
315 } // namespace Aws
Aws::LexRuntimeV2::Model::StartConversationRequest::SetLocaleId
void SetLocaleId(const Aws::String &value)
Definition: StartConversationRequest.h:160
Aws::LexRuntimeV2::Model::StartConversationRequest::WithConversationMode
StartConversationRequest & WithConversationMode(ConversationMode &&value)
Definition: StartConversationRequest.h:269
Aws::LexRuntimeV2::Model::StartConversationRequest::SetLocaleId
void SetLocaleId(const char *value)
Definition: StartConversationRequest.h:170
Aws::Http::HeaderValueCollection
Aws::Map< Aws::String, Aws::String > HeaderValueCollection
Definition: HttpTypes.h:53
Aws::LexRuntimeV2::Model::StartConversationRequest::WithSessionId
StartConversationRequest & WithSessionId(Aws::String &&value)
Definition: StartConversationRequest.h:221
Aws::LexRuntimeV2::Model::StartConversationRequest::IsEventStreamRequest
virtual bool IsEventStreamRequest() const override
Definition: StartConversationRequest.h:37
Aws::LexRuntimeV2::Model::StartConversationRequest::SetBotId
void SetBotId(const char *value)
Definition: StartConversationRequest.h:88
Aws::LexRuntimeV2::Model::StartConversationRequest::SetSessionId
void SetSessionId(const char *value)
Definition: StartConversationRequest.h:211
ConversationMode.h
Aws::LexRuntimeV2::Model::StartConversationRequest::GetBotAliasId
const Aws::String & GetBotAliasId() const
Definition: StartConversationRequest.h:109
Aws::LexRuntimeV2::Model::StartConversationRequest::SetBotId
void SetBotId(const Aws::String &value)
Definition: StartConversationRequest.h:78
Aws::LexRuntimeV2::Model::StartConversationRequest::SetLocaleId
void SetLocaleId(Aws::String &&value)
Definition: StartConversationRequest.h:165
Aws::LexRuntimeV2::Model::StartConversationRequest::WithBotAliasId
StartConversationRequest & WithBotAliasId(Aws::String &&value)
Definition: StartConversationRequest.h:139
Aws::LexRuntimeV2::Model::StartConversationRequest::GetBotId
const Aws::String & GetBotId() const
Definition: StartConversationRequest.h:68
Aws::LexRuntimeV2::Model::StartConversationRequest::SetSessionId
void SetSessionId(const Aws::String &value)
Definition: StartConversationRequest.h:201
Aws::LexRuntimeV2::Model::StartConversationRequest::SetRequestEventStream
void SetRequestEventStream(const std::shared_ptr< StartConversationRequestEventStream > &value)
Definition: StartConversationRequest.h:282
Aws::LexRuntimeV2::Model::StartConversationRequest::SetEventStreamHandler
void SetEventStreamHandler(const StartConversationHandler &value)
Definition: StartConversationRequest.h:57
EventStreamDecoder.h
Aws::LexRuntimeV2::Model::StartConversationRequest::BotIdHasBeenSet
bool BotIdHasBeenSet() const
Definition: StartConversationRequest.h:73
Aws::LexRuntimeV2::Model::StartConversationRequest::WithConversationMode
StartConversationRequest & WithConversationMode(const ConversationMode &value)
Definition: StartConversationRequest.h:262
Aws::LexRuntimeV2::Model::StartConversationRequest::LocaleIdHasBeenSet
bool LocaleIdHasBeenSet() const
Definition: StartConversationRequest.h:155
StartConversationHandler.h
LexRuntimeV2Request.h
Aws::LexRuntimeV2::Model::StartConversationRequest::SetSessionId
void SetSessionId(Aws::String &&value)
Definition: StartConversationRequest.h:206
Aws::LexRuntimeV2::Model::StartConversationRequest::WithSessionId
StartConversationRequest & WithSessionId(const Aws::String &value)
Definition: StartConversationRequest.h:216
Aws::LexRuntimeV2::Model::StartConversationRequest::SetBotId
void SetBotId(Aws::String &&value)
Definition: StartConversationRequest.h:83
Aws::LexRuntimeV2::Model::StartConversationRequest::WithBotId
StartConversationRequest & WithBotId(const Aws::String &value)
Definition: StartConversationRequest.h:93
LexRuntimeV2_EXPORTS.h
Aws::LexRuntimeV2::Model::StartConversationRequest::SerializePayload
Aws::String SerializePayload() const override
Definition: StartConversationRequest.h:40
Aws::LexRuntimeV2::Model::StartConversationRequest::GetLocaleId
const Aws::String & GetLocaleId() const
Definition: StartConversationRequest.h:150
Aws::LexRuntimeV2::Model::StartConversationRequest::WithLocaleId
StartConversationRequest & WithLocaleId(const char *value)
Definition: StartConversationRequest.h:185
AWSString.h
Aws::LexRuntimeV2::LexRuntimeV2Request
Definition: LexRuntimeV2Request.h:18
Aws::LexRuntimeV2::Model::StartConversationRequest::WithBotAliasId
StartConversationRequest & WithBotAliasId(const Aws::String &value)
Definition: StartConversationRequest.h:134
Aws::LexRuntimeV2::Model::ConversationMode
ConversationMode
Definition: ConversationMode.h:17
Aws::LexRuntimeV2::Model::StartConversationRequest::GetRequestEventStream
std::shared_ptr< StartConversationRequestEventStream > GetRequestEventStream() const
Definition: StartConversationRequest.h:276
Aws::LexRuntimeV2::Model::StartConversationRequest::SetBotAliasId
void SetBotAliasId(Aws::String &&value)
Definition: StartConversationRequest.h:124
Aws::LexRuntimeV2::Model::StartConversationRequest::GetEventStreamHandler
const StartConversationHandler & GetEventStreamHandler() const
Definition: StartConversationRequest.h:52
Aws::LexRuntimeV2::Model::StartConversationRequest::SetBotAliasId
void SetBotAliasId(const Aws::String &value)
Definition: StartConversationRequest.h:119
Aws::LexRuntimeV2::Model::StartConversationRequest::WithBotAliasId
StartConversationRequest & WithBotAliasId(const char *value)
Definition: StartConversationRequest.h:144
Aws::LexRuntimeV2::Model::StartConversationRequest::WithBotId
StartConversationRequest & WithBotId(Aws::String &&value)
Definition: StartConversationRequest.h:98
Aws::LexRuntimeV2::Model::StartConversationHandler
Definition: StartConversationHandler.h:38
Aws::LexRuntimeV2::Model::StartConversationRequest::GetConversationMode
const ConversationMode & GetConversationMode() const
Definition: StartConversationRequest.h:234
Aws::Utils::Event::EventStreamDecoder
Definition: EventStreamDecoder.h:20
Aws::LexRuntimeV2::Model::StartConversationRequest::WithLocaleId
StartConversationRequest & WithLocaleId(Aws::String &&value)
Definition: StartConversationRequest.h:180
StartConversationRequestEventStream.h
Aws::LexRuntimeV2::Model::StartConversationRequest::SetConversationMode
void SetConversationMode(ConversationMode &&value)
Definition: StartConversationRequest.h:255
Aws
Definition: AccessManagementClient.h:15
Aws::LexRuntimeV2::Model::StartConversationRequest::StartConversationRequest
StartConversationRequest()
Aws::LexRuntimeV2::Model::StartConversationRequest::WithRequestEventStream
StartConversationRequest & WithRequestEventStream(const std::shared_ptr< StartConversationRequestEventStream > &value)
Definition: StartConversationRequest.h:288
Aws::LexRuntimeV2::Model::StartConversationRequest::GetSessionId
const Aws::String & GetSessionId() const
Definition: StartConversationRequest.h:191
Aws::LexRuntimeV2::Model::StartConversationRequest::GetBody
std::shared_ptr< Aws::IOStream > GetBody() const override
Aws::String
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
Definition: AWSString.h:97
Aws::LexRuntimeV2::Model::StartConversationRequest::SetConversationMode
void SetConversationMode(const ConversationMode &value)
Definition: StartConversationRequest.h:248
Aws::LexRuntimeV2::Model::StartConversationRequest::BotAliasIdHasBeenSet
bool BotAliasIdHasBeenSet() const
Definition: StartConversationRequest.h:114
Aws::LexRuntimeV2::Model::StartConversationRequest::GetEventStreamDecoder
Aws::Utils::Event::EventStreamDecoder & GetEventStreamDecoder()
Definition: StartConversationRequest.h:47
Aws::LexRuntimeV2::Model::StartConversationRequest::WithEventStreamHandler
StartConversationRequest & WithEventStreamHandler(const StartConversationHandler &value)
Definition: StartConversationRequest.h:62
Aws::LexRuntimeV2::Model::StartConversationRequest::SessionIdHasBeenSet
bool SessionIdHasBeenSet() const
Definition: StartConversationRequest.h:196
Aws::LexRuntimeV2::Model::StartConversationRequest::WithSessionId
StartConversationRequest & WithSessionId(const char *value)
Definition: StartConversationRequest.h:226
Aws::LexRuntimeV2::Model::StartConversationRequest::GetServiceRequestName
virtual const char * GetServiceRequestName() const override
Definition: StartConversationRequest.h:35
Aws::LexRuntimeV2::Model::StartConversationRequest::WithLocaleId
StartConversationRequest & WithLocaleId(const Aws::String &value)
Definition: StartConversationRequest.h:175
Aws::LexRuntimeV2::Model::StartConversationRequest::ConversationModeHasBeenSet
bool ConversationModeHasBeenSet() const
Definition: StartConversationRequest.h:241
Aws::LexRuntimeV2::Model::StartConversationRequest::SetBotAliasId
void SetBotAliasId(const char *value)
Definition: StartConversationRequest.h:129
Aws::LexRuntimeV2::Model::StartConversationRequest::GetRequestSpecificHeaders
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override
Aws::LexRuntimeV2::Model::StartConversationRequest
Definition: StartConversationRequest.h:27
Aws::LexRuntimeV2::Model::StartConversationRequest::WithBotId
StartConversationRequest & WithBotId(const char *value)
Definition: StartConversationRequest.h:103
AWS_LEXRUNTIMEV2_API
#define AWS_LEXRUNTIMEV2_API
Definition: LexRuntimeV2_EXPORTS.h:28