AWS SDK for C++  1.9.159
AWS SDK for C++
IndexFacesRequest.h
Go to the documentation of this file.
1 
6 #pragma once
14 #include <utility>
15 
16 namespace Aws
17 {
18 namespace Rekognition
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 "IndexFaces"; }
35 
36  Aws::String SerializePayload() const override;
37 
39 
40 
45  inline const Aws::String& GetCollectionId() const{ return m_collectionId; }
46 
51  inline bool CollectionIdHasBeenSet() const { return m_collectionIdHasBeenSet; }
52 
57  inline void SetCollectionId(const Aws::String& value) { m_collectionIdHasBeenSet = true; m_collectionId = value; }
58 
63  inline void SetCollectionId(Aws::String&& value) { m_collectionIdHasBeenSet = true; m_collectionId = std::move(value); }
64 
69  inline void SetCollectionId(const char* value) { m_collectionIdHasBeenSet = true; m_collectionId.assign(value); }
70 
75  inline IndexFacesRequest& WithCollectionId(const Aws::String& value) { SetCollectionId(value); return *this;}
76 
81  inline IndexFacesRequest& WithCollectionId(Aws::String&& value) { SetCollectionId(std::move(value)); return *this;}
82 
87  inline IndexFacesRequest& WithCollectionId(const char* value) { SetCollectionId(value); return *this;}
88 
89 
98  inline const Image& GetImage() const{ return m_image; }
99 
108  inline bool ImageHasBeenSet() const { return m_imageHasBeenSet; }
109 
118  inline void SetImage(const Image& value) { m_imageHasBeenSet = true; m_image = value; }
119 
128  inline void SetImage(Image&& value) { m_imageHasBeenSet = true; m_image = std::move(value); }
129 
138  inline IndexFacesRequest& WithImage(const Image& value) { SetImage(value); return *this;}
139 
148  inline IndexFacesRequest& WithImage(Image&& value) { SetImage(std::move(value)); return *this;}
149 
150 
154  inline const Aws::String& GetExternalImageId() const{ return m_externalImageId; }
155 
159  inline bool ExternalImageIdHasBeenSet() const { return m_externalImageIdHasBeenSet; }
160 
164  inline void SetExternalImageId(const Aws::String& value) { m_externalImageIdHasBeenSet = true; m_externalImageId = value; }
165 
169  inline void SetExternalImageId(Aws::String&& value) { m_externalImageIdHasBeenSet = true; m_externalImageId = std::move(value); }
170 
174  inline void SetExternalImageId(const char* value) { m_externalImageIdHasBeenSet = true; m_externalImageId.assign(value); }
175 
179  inline IndexFacesRequest& WithExternalImageId(const Aws::String& value) { SetExternalImageId(value); return *this;}
180 
184  inline IndexFacesRequest& WithExternalImageId(Aws::String&& value) { SetExternalImageId(std::move(value)); return *this;}
185 
189  inline IndexFacesRequest& WithExternalImageId(const char* value) { SetExternalImageId(value); return *this;}
190 
191 
204  inline const Aws::Vector<Attribute>& GetDetectionAttributes() const{ return m_detectionAttributes; }
205 
218  inline bool DetectionAttributesHasBeenSet() const { return m_detectionAttributesHasBeenSet; }
219 
232  inline void SetDetectionAttributes(const Aws::Vector<Attribute>& value) { m_detectionAttributesHasBeenSet = true; m_detectionAttributes = value; }
233 
246  inline void SetDetectionAttributes(Aws::Vector<Attribute>&& value) { m_detectionAttributesHasBeenSet = true; m_detectionAttributes = std::move(value); }
247 
260  inline IndexFacesRequest& WithDetectionAttributes(const Aws::Vector<Attribute>& value) { SetDetectionAttributes(value); return *this;}
261 
274  inline IndexFacesRequest& WithDetectionAttributes(Aws::Vector<Attribute>&& value) { SetDetectionAttributes(std::move(value)); return *this;}
275 
288  inline IndexFacesRequest& AddDetectionAttributes(const Attribute& value) { m_detectionAttributesHasBeenSet = true; m_detectionAttributes.push_back(value); return *this; }
289 
302  inline IndexFacesRequest& AddDetectionAttributes(Attribute&& value) { m_detectionAttributesHasBeenSet = true; m_detectionAttributes.push_back(std::move(value)); return *this; }
303 
304 
320  inline int GetMaxFaces() const{ return m_maxFaces; }
321 
337  inline bool MaxFacesHasBeenSet() const { return m_maxFacesHasBeenSet; }
338 
354  inline void SetMaxFaces(int value) { m_maxFacesHasBeenSet = true; m_maxFaces = value; }
355 
371  inline IndexFacesRequest& WithMaxFaces(int value) { SetMaxFaces(value); return *this;}
372 
373 
387  inline const QualityFilter& GetQualityFilter() const{ return m_qualityFilter; }
388 
402  inline bool QualityFilterHasBeenSet() const { return m_qualityFilterHasBeenSet; }
403 
417  inline void SetQualityFilter(const QualityFilter& value) { m_qualityFilterHasBeenSet = true; m_qualityFilter = value; }
418 
432  inline void SetQualityFilter(QualityFilter&& value) { m_qualityFilterHasBeenSet = true; m_qualityFilter = std::move(value); }
433 
447  inline IndexFacesRequest& WithQualityFilter(const QualityFilter& value) { SetQualityFilter(value); return *this;}
448 
462  inline IndexFacesRequest& WithQualityFilter(QualityFilter&& value) { SetQualityFilter(std::move(value)); return *this;}
463 
464  private:
465 
466  Aws::String m_collectionId;
467  bool m_collectionIdHasBeenSet;
468 
469  Image m_image;
470  bool m_imageHasBeenSet;
471 
472  Aws::String m_externalImageId;
473  bool m_externalImageIdHasBeenSet;
474 
475  Aws::Vector<Attribute> m_detectionAttributes;
476  bool m_detectionAttributesHasBeenSet;
477 
478  int m_maxFaces;
479  bool m_maxFacesHasBeenSet;
480 
481  QualityFilter m_qualityFilter;
482  bool m_qualityFilterHasBeenSet;
483  };
484 
485 } // namespace Model
486 } // namespace Rekognition
487 } // namespace Aws
Aws::Rekognition::Model::IndexFacesRequest::WithQualityFilter
IndexFacesRequest & WithQualityFilter(const QualityFilter &value)
Definition: IndexFacesRequest.h:447
Aws::Rekognition::Model::IndexFacesRequest::QualityFilterHasBeenSet
bool QualityFilterHasBeenSet() const
Definition: IndexFacesRequest.h:402
Aws::Rekognition::Model::IndexFacesRequest::SetDetectionAttributes
void SetDetectionAttributes(Aws::Vector< Attribute > &&value)
Definition: IndexFacesRequest.h:246
Aws::Rekognition::Model::QualityFilter
QualityFilter
Definition: QualityFilter.h:17
Aws::Http::HeaderValueCollection
Aws::Map< Aws::String, Aws::String > HeaderValueCollection
Definition: HttpTypes.h:53
Aws::Rekognition::Model::IndexFacesRequest::CollectionIdHasBeenSet
bool CollectionIdHasBeenSet() const
Definition: IndexFacesRequest.h:51
Aws::Rekognition::Model::IndexFacesRequest::AddDetectionAttributes
IndexFacesRequest & AddDetectionAttributes(Attribute &&value)
Definition: IndexFacesRequest.h:302
Aws::Rekognition::Model::IndexFacesRequest::SetQualityFilter
void SetQualityFilter(QualityFilter &&value)
Definition: IndexFacesRequest.h:432
Aws::Rekognition::Model::IndexFacesRequest::GetDetectionAttributes
const Aws::Vector< Attribute > & GetDetectionAttributes() const
Definition: IndexFacesRequest.h:204
Aws::Rekognition::Model::IndexFacesRequest::GetMaxFaces
int GetMaxFaces() const
Definition: IndexFacesRequest.h:320
Aws::Rekognition::Model::IndexFacesRequest::SetExternalImageId
void SetExternalImageId(const Aws::String &value)
Definition: IndexFacesRequest.h:164
Aws::Rekognition::Model::IndexFacesRequest::SetMaxFaces
void SetMaxFaces(int value)
Definition: IndexFacesRequest.h:354
Aws::Vector
std::vector< T, Aws::Allocator< T > > Vector
Definition: AWSVector.h:17
Aws::Rekognition::Model::IndexFacesRequest::WithExternalImageId
IndexFacesRequest & WithExternalImageId(Aws::String &&value)
Definition: IndexFacesRequest.h:184
Attribute.h
Aws::Rekognition::Model::IndexFacesRequest::SetExternalImageId
void SetExternalImageId(Aws::String &&value)
Definition: IndexFacesRequest.h:169
Aws::Rekognition::Model::IndexFacesRequest::SetCollectionId
void SetCollectionId(const char *value)
Definition: IndexFacesRequest.h:69
Aws::Rekognition::Model::IndexFacesRequest::SetQualityFilter
void SetQualityFilter(const QualityFilter &value)
Definition: IndexFacesRequest.h:417
Aws::Rekognition::Model::IndexFacesRequest::GetImage
const Image & GetImage() const
Definition: IndexFacesRequest.h:98
AWSVector.h
Aws::Rekognition::Model::IndexFacesRequest::WithImage
IndexFacesRequest & WithImage(Image &&value)
Definition: IndexFacesRequest.h:148
Image.h
QualityFilter.h
Aws::Rekognition::Model::IndexFacesRequest::SetDetectionAttributes
void SetDetectionAttributes(const Aws::Vector< Attribute > &value)
Definition: IndexFacesRequest.h:232
Aws::Rekognition::Model::IndexFacesRequest::WithMaxFaces
IndexFacesRequest & WithMaxFaces(int value)
Definition: IndexFacesRequest.h:371
Aws::Rekognition::Model::IndexFacesRequest::SetCollectionId
void SetCollectionId(const Aws::String &value)
Definition: IndexFacesRequest.h:57
Aws::Rekognition::Model::IndexFacesRequest::SerializePayload
Aws::String SerializePayload() const override
Aws::Rekognition::Model::IndexFacesRequest::SetExternalImageId
void SetExternalImageId(const char *value)
Definition: IndexFacesRequest.h:174
Aws::Rekognition::Model::IndexFacesRequest::WithDetectionAttributes
IndexFacesRequest & WithDetectionAttributes(Aws::Vector< Attribute > &&value)
Definition: IndexFacesRequest.h:274
Aws::Rekognition::Model::IndexFacesRequest::SetImage
void SetImage(Image &&value)
Definition: IndexFacesRequest.h:128
Aws::Rekognition::Model::IndexFacesRequest::GetExternalImageId
const Aws::String & GetExternalImageId() const
Definition: IndexFacesRequest.h:154
Aws::Rekognition::Model::IndexFacesRequest::WithImage
IndexFacesRequest & WithImage(const Image &value)
Definition: IndexFacesRequest.h:138
Aws::Rekognition::RekognitionRequest
Definition: RekognitionRequest.h:17
Aws::Rekognition::Model::IndexFacesRequest::AddDetectionAttributes
IndexFacesRequest & AddDetectionAttributes(const Attribute &value)
Definition: IndexFacesRequest.h:288
Aws::Rekognition::Model::IndexFacesRequest::ImageHasBeenSet
bool ImageHasBeenSet() const
Definition: IndexFacesRequest.h:108
Aws::Rekognition::Model::Attribute
Attribute
Definition: Attribute.h:17
Aws::Rekognition::Model::IndexFacesRequest::SetImage
void SetImage(const Image &value)
Definition: IndexFacesRequest.h:118
Aws::Rekognition::Model::IndexFacesRequest::ExternalImageIdHasBeenSet
bool ExternalImageIdHasBeenSet() const
Definition: IndexFacesRequest.h:159
Aws::Rekognition::Model::IndexFacesRequest::GetRequestSpecificHeaders
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override
Aws::Rekognition::Model::IndexFacesRequest::WithCollectionId
IndexFacesRequest & WithCollectionId(Aws::String &&value)
Definition: IndexFacesRequest.h:81
AWSString.h
Aws::Rekognition::Model::IndexFacesRequest::WithDetectionAttributes
IndexFacesRequest & WithDetectionAttributes(const Aws::Vector< Attribute > &value)
Definition: IndexFacesRequest.h:260
Aws::Rekognition::Model::IndexFacesRequest::IndexFacesRequest
IndexFacesRequest()
Aws::Rekognition::Model::IndexFacesRequest::MaxFacesHasBeenSet
bool MaxFacesHasBeenSet() const
Definition: IndexFacesRequest.h:337
Aws::Rekognition::Model::IndexFacesRequest::WithQualityFilter
IndexFacesRequest & WithQualityFilter(QualityFilter &&value)
Definition: IndexFacesRequest.h:462
Aws::Rekognition::Model::Image
Definition: Image.h:51
Aws::Rekognition::Model::IndexFacesRequest::GetQualityFilter
const QualityFilter & GetQualityFilter() const
Definition: IndexFacesRequest.h:387
AWS_REKOGNITION_API
#define AWS_REKOGNITION_API
Definition: Rekognition_EXPORTS.h:28
Aws
Definition: AccessManagementClient.h:15
Aws::Rekognition::Model::IndexFacesRequest::WithCollectionId
IndexFacesRequest & WithCollectionId(const char *value)
Definition: IndexFacesRequest.h:87
Aws::Rekognition::Model::IndexFacesRequest::DetectionAttributesHasBeenSet
bool DetectionAttributesHasBeenSet() const
Definition: IndexFacesRequest.h:218
Rekognition_EXPORTS.h
Aws::Rekognition::Model::IndexFacesRequest::WithExternalImageId
IndexFacesRequest & WithExternalImageId(const char *value)
Definition: IndexFacesRequest.h:189
Aws::String
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
Definition: AWSString.h:97
Aws::Rekognition::Model::IndexFacesRequest::SetCollectionId
void SetCollectionId(Aws::String &&value)
Definition: IndexFacesRequest.h:63
Aws::Rekognition::Model::IndexFacesRequest::GetCollectionId
const Aws::String & GetCollectionId() const
Definition: IndexFacesRequest.h:45
Aws::Rekognition::Model::IndexFacesRequest::GetServiceRequestName
virtual const char * GetServiceRequestName() const override
Definition: IndexFacesRequest.h:34
Aws::Rekognition::Model::IndexFacesRequest::WithCollectionId
IndexFacesRequest & WithCollectionId(const Aws::String &value)
Definition: IndexFacesRequest.h:75
Aws::Rekognition::Model::IndexFacesRequest::WithExternalImageId
IndexFacesRequest & WithExternalImageId(const Aws::String &value)
Definition: IndexFacesRequest.h:179
Aws::Rekognition::Model::IndexFacesRequest
Definition: IndexFacesRequest.h:26
RekognitionRequest.h