AWS SDK for C++  1.9.126
AWS SDK for C++
CreateQuerySuggestionsBlockListRequest.h
Go to the documentation of this file.
1 
6 #pragma once
12 #include <aws/kendra/model/Tag.h>
13 #include <utility>
14 #include <aws/core/utils/UUID.h>
15 
16 namespace Aws
17 {
18 namespace kendra
19 {
20 namespace Model
21 {
22 
26  {
27  public:
29 
30  // Service request name is the Operation name which will send this request out,
31  // each operation should has unique request name, so that we can get operation's name from this request.
32  // Note: this is not true for response, multiple operations may have the same response name,
33  // so we can not get operation's name from response.
34  inline virtual const char* GetServiceRequestName() const override { return "CreateQuerySuggestionsBlockList"; }
35 
36  Aws::String SerializePayload() const override;
37 
39 
40 
45  inline const Aws::String& GetIndexId() const{ return m_indexId; }
46 
51  inline bool IndexIdHasBeenSet() const { return m_indexIdHasBeenSet; }
52 
57  inline void SetIndexId(const Aws::String& value) { m_indexIdHasBeenSet = true; m_indexId = value; }
58 
63  inline void SetIndexId(Aws::String&& value) { m_indexIdHasBeenSet = true; m_indexId = std::move(value); }
64 
69  inline void SetIndexId(const char* value) { m_indexIdHasBeenSet = true; m_indexId.assign(value); }
70 
75  inline CreateQuerySuggestionsBlockListRequest& WithIndexId(const Aws::String& value) { SetIndexId(value); return *this;}
76 
81  inline CreateQuerySuggestionsBlockListRequest& WithIndexId(Aws::String&& value) { SetIndexId(std::move(value)); return *this;}
82 
87  inline CreateQuerySuggestionsBlockListRequest& WithIndexId(const char* value) { SetIndexId(value); return *this;}
88 
89 
95  inline const Aws::String& GetName() const{ return m_name; }
96 
102  inline bool NameHasBeenSet() const { return m_nameHasBeenSet; }
103 
109  inline void SetName(const Aws::String& value) { m_nameHasBeenSet = true; m_name = value; }
110 
116  inline void SetName(Aws::String&& value) { m_nameHasBeenSet = true; m_name = std::move(value); }
117 
123  inline void SetName(const char* value) { m_nameHasBeenSet = true; m_name.assign(value); }
124 
130  inline CreateQuerySuggestionsBlockListRequest& WithName(const Aws::String& value) { SetName(value); return *this;}
131 
137  inline CreateQuerySuggestionsBlockListRequest& WithName(Aws::String&& value) { SetName(std::move(value)); return *this;}
138 
144  inline CreateQuerySuggestionsBlockListRequest& WithName(const char* value) { SetName(value); return *this;}
145 
146 
152  inline const Aws::String& GetDescription() const{ return m_description; }
153 
159  inline bool DescriptionHasBeenSet() const { return m_descriptionHasBeenSet; }
160 
166  inline void SetDescription(const Aws::String& value) { m_descriptionHasBeenSet = true; m_description = value; }
167 
173  inline void SetDescription(Aws::String&& value) { m_descriptionHasBeenSet = true; m_description = std::move(value); }
174 
180  inline void SetDescription(const char* value) { m_descriptionHasBeenSet = true; m_description.assign(value); }
181 
187  inline CreateQuerySuggestionsBlockListRequest& WithDescription(const Aws::String& value) { SetDescription(value); return *this;}
188 
194  inline CreateQuerySuggestionsBlockListRequest& WithDescription(Aws::String&& value) { SetDescription(std::move(value)); return *this;}
195 
201  inline CreateQuerySuggestionsBlockListRequest& WithDescription(const char* value) { SetDescription(value); return *this;}
202 
203 
211  inline const S3Path& GetSourceS3Path() const{ return m_sourceS3Path; }
212 
220  inline bool SourceS3PathHasBeenSet() const { return m_sourceS3PathHasBeenSet; }
221 
229  inline void SetSourceS3Path(const S3Path& value) { m_sourceS3PathHasBeenSet = true; m_sourceS3Path = value; }
230 
238  inline void SetSourceS3Path(S3Path&& value) { m_sourceS3PathHasBeenSet = true; m_sourceS3Path = std::move(value); }
239 
247  inline CreateQuerySuggestionsBlockListRequest& WithSourceS3Path(const S3Path& value) { SetSourceS3Path(value); return *this;}
248 
256  inline CreateQuerySuggestionsBlockListRequest& WithSourceS3Path(S3Path&& value) { SetSourceS3Path(std::move(value)); return *this;}
257 
258 
263  inline const Aws::String& GetClientToken() const{ return m_clientToken; }
264 
269  inline bool ClientTokenHasBeenSet() const { return m_clientTokenHasBeenSet; }
270 
275  inline void SetClientToken(const Aws::String& value) { m_clientTokenHasBeenSet = true; m_clientToken = value; }
276 
281  inline void SetClientToken(Aws::String&& value) { m_clientTokenHasBeenSet = true; m_clientToken = std::move(value); }
282 
287  inline void SetClientToken(const char* value) { m_clientTokenHasBeenSet = true; m_clientToken.assign(value); }
288 
293  inline CreateQuerySuggestionsBlockListRequest& WithClientToken(const Aws::String& value) { SetClientToken(value); return *this;}
294 
299  inline CreateQuerySuggestionsBlockListRequest& WithClientToken(Aws::String&& value) { SetClientToken(std::move(value)); return *this;}
300 
305  inline CreateQuerySuggestionsBlockListRequest& WithClientToken(const char* value) { SetClientToken(value); return *this;}
306 
307 
315  inline const Aws::String& GetRoleArn() const{ return m_roleArn; }
316 
324  inline bool RoleArnHasBeenSet() const { return m_roleArnHasBeenSet; }
325 
333  inline void SetRoleArn(const Aws::String& value) { m_roleArnHasBeenSet = true; m_roleArn = value; }
334 
342  inline void SetRoleArn(Aws::String&& value) { m_roleArnHasBeenSet = true; m_roleArn = std::move(value); }
343 
351  inline void SetRoleArn(const char* value) { m_roleArnHasBeenSet = true; m_roleArn.assign(value); }
352 
360  inline CreateQuerySuggestionsBlockListRequest& WithRoleArn(const Aws::String& value) { SetRoleArn(value); return *this;}
361 
369  inline CreateQuerySuggestionsBlockListRequest& WithRoleArn(Aws::String&& value) { SetRoleArn(std::move(value)); return *this;}
370 
378  inline CreateQuerySuggestionsBlockListRequest& WithRoleArn(const char* value) { SetRoleArn(value); return *this;}
379 
380 
385  inline const Aws::Vector<Tag>& GetTags() const{ return m_tags; }
386 
391  inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; }
392 
397  inline void SetTags(const Aws::Vector<Tag>& value) { m_tagsHasBeenSet = true; m_tags = value; }
398 
403  inline void SetTags(Aws::Vector<Tag>&& value) { m_tagsHasBeenSet = true; m_tags = std::move(value); }
404 
409  inline CreateQuerySuggestionsBlockListRequest& WithTags(const Aws::Vector<Tag>& value) { SetTags(value); return *this;}
410 
415  inline CreateQuerySuggestionsBlockListRequest& WithTags(Aws::Vector<Tag>&& value) { SetTags(std::move(value)); return *this;}
416 
421  inline CreateQuerySuggestionsBlockListRequest& AddTags(const Tag& value) { m_tagsHasBeenSet = true; m_tags.push_back(value); return *this; }
422 
427  inline CreateQuerySuggestionsBlockListRequest& AddTags(Tag&& value) { m_tagsHasBeenSet = true; m_tags.push_back(std::move(value)); return *this; }
428 
429  private:
430 
431  Aws::String m_indexId;
432  bool m_indexIdHasBeenSet;
433 
434  Aws::String m_name;
435  bool m_nameHasBeenSet;
436 
437  Aws::String m_description;
438  bool m_descriptionHasBeenSet;
439 
440  S3Path m_sourceS3Path;
441  bool m_sourceS3PathHasBeenSet;
442 
443  Aws::String m_clientToken;
444  bool m_clientTokenHasBeenSet;
445 
446  Aws::String m_roleArn;
447  bool m_roleArnHasBeenSet;
448 
449  Aws::Vector<Tag> m_tags;
450  bool m_tagsHasBeenSet;
451  };
452 
453 } // namespace Model
454 } // namespace kendra
455 } // namespace Aws
Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::DescriptionHasBeenSet
bool DescriptionHasBeenSet() const
Definition: CreateQuerySuggestionsBlockListRequest.h:159
Aws::kendra::KendraRequest
Definition: KendraRequest.h:17
Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::GetDescription
const Aws::String & GetDescription() const
Definition: CreateQuerySuggestionsBlockListRequest.h:152
Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::WithIndexId
CreateQuerySuggestionsBlockListRequest & WithIndexId(const Aws::String &value)
Definition: CreateQuerySuggestionsBlockListRequest.h:75
Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::WithClientToken
CreateQuerySuggestionsBlockListRequest & WithClientToken(const Aws::String &value)
Definition: CreateQuerySuggestionsBlockListRequest.h:293
Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::WithName
CreateQuerySuggestionsBlockListRequest & WithName(Aws::String &&value)
Definition: CreateQuerySuggestionsBlockListRequest.h:137
Aws::Http::HeaderValueCollection
Aws::Map< Aws::String, Aws::String > HeaderValueCollection
Definition: HttpTypes.h:53
Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::SetTags
void SetTags(Aws::Vector< Tag > &&value)
Definition: CreateQuerySuggestionsBlockListRequest.h:403
Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::GetRoleArn
const Aws::String & GetRoleArn() const
Definition: CreateQuerySuggestionsBlockListRequest.h:315
Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::SerializePayload
Aws::String SerializePayload() const override
Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::GetIndexId
const Aws::String & GetIndexId() const
Definition: CreateQuerySuggestionsBlockListRequest.h:45
Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::SetDescription
void SetDescription(const char *value)
Definition: CreateQuerySuggestionsBlockListRequest.h:180
Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::SetClientToken
void SetClientToken(const char *value)
Definition: CreateQuerySuggestionsBlockListRequest.h:287
Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::WithTags
CreateQuerySuggestionsBlockListRequest & WithTags(Aws::Vector< Tag > &&value)
Definition: CreateQuerySuggestionsBlockListRequest.h:415
Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::SetName
void SetName(const Aws::String &value)
Definition: CreateQuerySuggestionsBlockListRequest.h:109
Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::WithClientToken
CreateQuerySuggestionsBlockListRequest & WithClientToken(Aws::String &&value)
Definition: CreateQuerySuggestionsBlockListRequest.h:299
Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::CreateQuerySuggestionsBlockListRequest
CreateQuerySuggestionsBlockListRequest()
Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::GetRequestSpecificHeaders
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override
Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::SetIndexId
void SetIndexId(const char *value)
Definition: CreateQuerySuggestionsBlockListRequest.h:69
Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::SourceS3PathHasBeenSet
bool SourceS3PathHasBeenSet() const
Definition: CreateQuerySuggestionsBlockListRequest.h:220
Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::GetSourceS3Path
const S3Path & GetSourceS3Path() const
Definition: CreateQuerySuggestionsBlockListRequest.h:211
KendraRequest.h
Aws::Vector
std::vector< T, Aws::Allocator< T > > Vector
Definition: AWSVector.h:17
Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::WithName
CreateQuerySuggestionsBlockListRequest & WithName(const char *value)
Definition: CreateQuerySuggestionsBlockListRequest.h:144
S3Path.h
Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::RoleArnHasBeenSet
bool RoleArnHasBeenSet() const
Definition: CreateQuerySuggestionsBlockListRequest.h:324
Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::SetRoleArn
void SetRoleArn(const Aws::String &value)
Definition: CreateQuerySuggestionsBlockListRequest.h:333
Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::WithRoleArn
CreateQuerySuggestionsBlockListRequest & WithRoleArn(const char *value)
Definition: CreateQuerySuggestionsBlockListRequest.h:378
AWSVector.h
Aws::kendra::Model::S3Path
Definition: S3Path.h:33
Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::SetRoleArn
void SetRoleArn(const char *value)
Definition: CreateQuerySuggestionsBlockListRequest.h:351
Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::NameHasBeenSet
bool NameHasBeenSet() const
Definition: CreateQuerySuggestionsBlockListRequest.h:102
Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::SetClientToken
void SetClientToken(Aws::String &&value)
Definition: CreateQuerySuggestionsBlockListRequest.h:281
Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::WithIndexId
CreateQuerySuggestionsBlockListRequest & WithIndexId(Aws::String &&value)
Definition: CreateQuerySuggestionsBlockListRequest.h:81
Kendra_EXPORTS.h
Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::SetIndexId
void SetIndexId(const Aws::String &value)
Definition: CreateQuerySuggestionsBlockListRequest.h:57
Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::SetSourceS3Path
void SetSourceS3Path(S3Path &&value)
Definition: CreateQuerySuggestionsBlockListRequest.h:238
Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::IndexIdHasBeenSet
bool IndexIdHasBeenSet() const
Definition: CreateQuerySuggestionsBlockListRequest.h:51
Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::SetRoleArn
void SetRoleArn(Aws::String &&value)
Definition: CreateQuerySuggestionsBlockListRequest.h:342
Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::GetTags
const Aws::Vector< Tag > & GetTags() const
Definition: CreateQuerySuggestionsBlockListRequest.h:385
Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::WithRoleArn
CreateQuerySuggestionsBlockListRequest & WithRoleArn(Aws::String &&value)
Definition: CreateQuerySuggestionsBlockListRequest.h:369
Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::SetName
void SetName(const char *value)
Definition: CreateQuerySuggestionsBlockListRequest.h:123
Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::SetIndexId
void SetIndexId(Aws::String &&value)
Definition: CreateQuerySuggestionsBlockListRequest.h:63
AWSString.h
Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::SetTags
void SetTags(const Aws::Vector< Tag > &value)
Definition: CreateQuerySuggestionsBlockListRequest.h:397
Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::AddTags
CreateQuerySuggestionsBlockListRequest & AddTags(const Tag &value)
Definition: CreateQuerySuggestionsBlockListRequest.h:421
Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::SetDescription
void SetDescription(Aws::String &&value)
Definition: CreateQuerySuggestionsBlockListRequest.h:173
Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::ClientTokenHasBeenSet
bool ClientTokenHasBeenSet() const
Definition: CreateQuerySuggestionsBlockListRequest.h:269
Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::WithRoleArn
CreateQuerySuggestionsBlockListRequest & WithRoleArn(const Aws::String &value)
Definition: CreateQuerySuggestionsBlockListRequest.h:360
Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::WithIndexId
CreateQuerySuggestionsBlockListRequest & WithIndexId(const char *value)
Definition: CreateQuerySuggestionsBlockListRequest.h:87
Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::WithSourceS3Path
CreateQuerySuggestionsBlockListRequest & WithSourceS3Path(S3Path &&value)
Definition: CreateQuerySuggestionsBlockListRequest.h:256
Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::GetClientToken
const Aws::String & GetClientToken() const
Definition: CreateQuerySuggestionsBlockListRequest.h:263
Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest
Definition: CreateQuerySuggestionsBlockListRequest.h:26
Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::SetName
void SetName(Aws::String &&value)
Definition: CreateQuerySuggestionsBlockListRequest.h:116
Aws
Definition: AccessManagementClient.h:15
Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::GetServiceRequestName
virtual const char * GetServiceRequestName() const override
Definition: CreateQuerySuggestionsBlockListRequest.h:34
Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::WithDescription
CreateQuerySuggestionsBlockListRequest & WithDescription(const char *value)
Definition: CreateQuerySuggestionsBlockListRequest.h:201
Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::WithSourceS3Path
CreateQuerySuggestionsBlockListRequest & WithSourceS3Path(const S3Path &value)
Definition: CreateQuerySuggestionsBlockListRequest.h:247
Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::SetClientToken
void SetClientToken(const Aws::String &value)
Definition: CreateQuerySuggestionsBlockListRequest.h:275
Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::SetDescription
void SetDescription(const Aws::String &value)
Definition: CreateQuerySuggestionsBlockListRequest.h:166
Aws::String
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
Definition: AWSString.h:97
Tag.h
Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::TagsHasBeenSet
bool TagsHasBeenSet() const
Definition: CreateQuerySuggestionsBlockListRequest.h:391
Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::SetSourceS3Path
void SetSourceS3Path(const S3Path &value)
Definition: CreateQuerySuggestionsBlockListRequest.h:229
AWS_KENDRA_API
#define AWS_KENDRA_API
Definition: Kendra_EXPORTS.h:28
Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::GetName
const Aws::String & GetName() const
Definition: CreateQuerySuggestionsBlockListRequest.h:95
Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::WithName
CreateQuerySuggestionsBlockListRequest & WithName(const Aws::String &value)
Definition: CreateQuerySuggestionsBlockListRequest.h:130
UUID.h
Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::WithDescription
CreateQuerySuggestionsBlockListRequest & WithDescription(Aws::String &&value)
Definition: CreateQuerySuggestionsBlockListRequest.h:194
Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::WithDescription
CreateQuerySuggestionsBlockListRequest & WithDescription(const Aws::String &value)
Definition: CreateQuerySuggestionsBlockListRequest.h:187
Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::WithTags
CreateQuerySuggestionsBlockListRequest & WithTags(const Aws::Vector< Tag > &value)
Definition: CreateQuerySuggestionsBlockListRequest.h:409
Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::AddTags
CreateQuerySuggestionsBlockListRequest & AddTags(Tag &&value)
Definition: CreateQuerySuggestionsBlockListRequest.h:427
Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::WithClientToken
CreateQuerySuggestionsBlockListRequest & WithClientToken(const char *value)
Definition: CreateQuerySuggestionsBlockListRequest.h:305
Aws::kendra::Model::Tag
Definition: Tag.h:34