AWS SDK for C++  1.9.40
AWS SDK for C++
StartFaceSearchRequest.h
Go to the documentation of this file.
1 
6 #pragma once
12 #include <utility>
13 
14 namespace Aws
15 {
16 namespace Rekognition
17 {
18 namespace Model
19 {
20 
24  {
25  public:
27 
28  // Service request name is the Operation name which will send this request out,
29  // each operation should has unique request name, so that we can get operation's name from this request.
30  // Note: this is not true for response, multiple operations may have the same response name,
31  // so we can not get operation's name from response.
32  inline virtual const char* GetServiceRequestName() const override { return "StartFaceSearch"; }
33 
34  Aws::String SerializePayload() const override;
35 
37 
38 
43  inline const Video& GetVideo() const{ return m_video; }
44 
49  inline bool VideoHasBeenSet() const { return m_videoHasBeenSet; }
50 
55  inline void SetVideo(const Video& value) { m_videoHasBeenSet = true; m_video = value; }
56 
61  inline void SetVideo(Video&& value) { m_videoHasBeenSet = true; m_video = std::move(value); }
62 
67  inline StartFaceSearchRequest& WithVideo(const Video& value) { SetVideo(value); return *this;}
68 
73  inline StartFaceSearchRequest& WithVideo(Video&& value) { SetVideo(std::move(value)); return *this;}
74 
75 
82  inline const Aws::String& GetClientRequestToken() const{ return m_clientRequestToken; }
83 
90  inline bool ClientRequestTokenHasBeenSet() const { return m_clientRequestTokenHasBeenSet; }
91 
98  inline void SetClientRequestToken(const Aws::String& value) { m_clientRequestTokenHasBeenSet = true; m_clientRequestToken = value; }
99 
106  inline void SetClientRequestToken(Aws::String&& value) { m_clientRequestTokenHasBeenSet = true; m_clientRequestToken = std::move(value); }
107 
114  inline void SetClientRequestToken(const char* value) { m_clientRequestTokenHasBeenSet = true; m_clientRequestToken.assign(value); }
115 
122  inline StartFaceSearchRequest& WithClientRequestToken(const Aws::String& value) { SetClientRequestToken(value); return *this;}
123 
130  inline StartFaceSearchRequest& WithClientRequestToken(Aws::String&& value) { SetClientRequestToken(std::move(value)); return *this;}
131 
138  inline StartFaceSearchRequest& WithClientRequestToken(const char* value) { SetClientRequestToken(value); return *this;}
139 
140 
146  inline double GetFaceMatchThreshold() const{ return m_faceMatchThreshold; }
147 
153  inline bool FaceMatchThresholdHasBeenSet() const { return m_faceMatchThresholdHasBeenSet; }
154 
160  inline void SetFaceMatchThreshold(double value) { m_faceMatchThresholdHasBeenSet = true; m_faceMatchThreshold = value; }
161 
167  inline StartFaceSearchRequest& WithFaceMatchThreshold(double value) { SetFaceMatchThreshold(value); return *this;}
168 
169 
173  inline const Aws::String& GetCollectionId() const{ return m_collectionId; }
174 
178  inline bool CollectionIdHasBeenSet() const { return m_collectionIdHasBeenSet; }
179 
183  inline void SetCollectionId(const Aws::String& value) { m_collectionIdHasBeenSet = true; m_collectionId = value; }
184 
188  inline void SetCollectionId(Aws::String&& value) { m_collectionIdHasBeenSet = true; m_collectionId = std::move(value); }
189 
193  inline void SetCollectionId(const char* value) { m_collectionIdHasBeenSet = true; m_collectionId.assign(value); }
194 
198  inline StartFaceSearchRequest& WithCollectionId(const Aws::String& value) { SetCollectionId(value); return *this;}
199 
203  inline StartFaceSearchRequest& WithCollectionId(Aws::String&& value) { SetCollectionId(std::move(value)); return *this;}
204 
208  inline StartFaceSearchRequest& WithCollectionId(const char* value) { SetCollectionId(value); return *this;}
209 
210 
215  inline const NotificationChannel& GetNotificationChannel() const{ return m_notificationChannel; }
216 
221  inline bool NotificationChannelHasBeenSet() const { return m_notificationChannelHasBeenSet; }
222 
227  inline void SetNotificationChannel(const NotificationChannel& value) { m_notificationChannelHasBeenSet = true; m_notificationChannel = value; }
228 
233  inline void SetNotificationChannel(NotificationChannel&& value) { m_notificationChannelHasBeenSet = true; m_notificationChannel = std::move(value); }
234 
239  inline StartFaceSearchRequest& WithNotificationChannel(const NotificationChannel& value) { SetNotificationChannel(value); return *this;}
240 
245  inline StartFaceSearchRequest& WithNotificationChannel(NotificationChannel&& value) { SetNotificationChannel(std::move(value)); return *this;}
246 
247 
254  inline const Aws::String& GetJobTag() const{ return m_jobTag; }
255 
262  inline bool JobTagHasBeenSet() const { return m_jobTagHasBeenSet; }
263 
270  inline void SetJobTag(const Aws::String& value) { m_jobTagHasBeenSet = true; m_jobTag = value; }
271 
278  inline void SetJobTag(Aws::String&& value) { m_jobTagHasBeenSet = true; m_jobTag = std::move(value); }
279 
286  inline void SetJobTag(const char* value) { m_jobTagHasBeenSet = true; m_jobTag.assign(value); }
287 
294  inline StartFaceSearchRequest& WithJobTag(const Aws::String& value) { SetJobTag(value); return *this;}
295 
302  inline StartFaceSearchRequest& WithJobTag(Aws::String&& value) { SetJobTag(std::move(value)); return *this;}
303 
310  inline StartFaceSearchRequest& WithJobTag(const char* value) { SetJobTag(value); return *this;}
311 
312  private:
313 
314  Video m_video;
315  bool m_videoHasBeenSet;
316 
317  Aws::String m_clientRequestToken;
318  bool m_clientRequestTokenHasBeenSet;
319 
320  double m_faceMatchThreshold;
321  bool m_faceMatchThresholdHasBeenSet;
322 
323  Aws::String m_collectionId;
324  bool m_collectionIdHasBeenSet;
325 
326  NotificationChannel m_notificationChannel;
327  bool m_notificationChannelHasBeenSet;
328 
329  Aws::String m_jobTag;
330  bool m_jobTagHasBeenSet;
331  };
332 
333 } // namespace Model
334 } // namespace Rekognition
335 } // namespace Aws
Aws::Rekognition::Model::StartFaceSearchRequest::GetJobTag
const Aws::String & GetJobTag() const
Definition: StartFaceSearchRequest.h:254
Aws::Rekognition::Model::StartFaceSearchRequest::SetCollectionId
void SetCollectionId(Aws::String &&value)
Definition: StartFaceSearchRequest.h:188
Aws::Rekognition::Model::StartFaceSearchRequest::WithClientRequestToken
StartFaceSearchRequest & WithClientRequestToken(Aws::String &&value)
Definition: StartFaceSearchRequest.h:130
Aws::Rekognition::Model::StartFaceSearchRequest::SetVideo
void SetVideo(const Video &value)
Definition: StartFaceSearchRequest.h:55
Aws::Http::HeaderValueCollection
Aws::Map< Aws::String, Aws::String > HeaderValueCollection
Definition: HttpTypes.h:53
Aws::Rekognition::Model::StartFaceSearchRequest::GetClientRequestToken
const Aws::String & GetClientRequestToken() const
Definition: StartFaceSearchRequest.h:82
Aws::Rekognition::Model::StartFaceSearchRequest::WithClientRequestToken
StartFaceSearchRequest & WithClientRequestToken(const Aws::String &value)
Definition: StartFaceSearchRequest.h:122
Aws::Rekognition::Model::StartFaceSearchRequest::SetClientRequestToken
void SetClientRequestToken(const Aws::String &value)
Definition: StartFaceSearchRequest.h:98
Aws::Rekognition::Model::StartFaceSearchRequest::GetRequestSpecificHeaders
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override
Aws::Rekognition::Model::StartFaceSearchRequest::SetNotificationChannel
void SetNotificationChannel(NotificationChannel &&value)
Definition: StartFaceSearchRequest.h:233
Aws::Rekognition::Model::StartFaceSearchRequest::GetFaceMatchThreshold
double GetFaceMatchThreshold() const
Definition: StartFaceSearchRequest.h:146
Aws::Rekognition::Model::StartFaceSearchRequest::SetCollectionId
void SetCollectionId(const Aws::String &value)
Definition: StartFaceSearchRequest.h:183
Aws::Rekognition::Model::StartFaceSearchRequest::WithCollectionId
StartFaceSearchRequest & WithCollectionId(const Aws::String &value)
Definition: StartFaceSearchRequest.h:198
Aws::Rekognition::Model::StartFaceSearchRequest::WithVideo
StartFaceSearchRequest & WithVideo(const Video &value)
Definition: StartFaceSearchRequest.h:67
Aws::Rekognition::Model::StartFaceSearchRequest::SerializePayload
Aws::String SerializePayload() const override
Aws::Rekognition::Model::StartFaceSearchRequest
Definition: StartFaceSearchRequest.h:24
Aws::Rekognition::Model::StartFaceSearchRequest::SetFaceMatchThreshold
void SetFaceMatchThreshold(double value)
Definition: StartFaceSearchRequest.h:160
Aws::Rekognition::Model::StartFaceSearchRequest::SetJobTag
void SetJobTag(Aws::String &&value)
Definition: StartFaceSearchRequest.h:278
Aws::Rekognition::Model::StartFaceSearchRequest::SetJobTag
void SetJobTag(const Aws::String &value)
Definition: StartFaceSearchRequest.h:270
Aws::Rekognition::Model::StartFaceSearchRequest::WithNotificationChannel
StartFaceSearchRequest & WithNotificationChannel(NotificationChannel &&value)
Definition: StartFaceSearchRequest.h:245
Aws::Rekognition::Model::StartFaceSearchRequest::WithJobTag
StartFaceSearchRequest & WithJobTag(Aws::String &&value)
Definition: StartFaceSearchRequest.h:302
Aws::Rekognition::Model::StartFaceSearchRequest::JobTagHasBeenSet
bool JobTagHasBeenSet() const
Definition: StartFaceSearchRequest.h:262
Aws::Rekognition::Model::StartFaceSearchRequest::WithVideo
StartFaceSearchRequest & WithVideo(Video &&value)
Definition: StartFaceSearchRequest.h:73
Aws::Rekognition::Model::StartFaceSearchRequest::WithCollectionId
StartFaceSearchRequest & WithCollectionId(Aws::String &&value)
Definition: StartFaceSearchRequest.h:203
Aws::Rekognition::Model::StartFaceSearchRequest::WithCollectionId
StartFaceSearchRequest & WithCollectionId(const char *value)
Definition: StartFaceSearchRequest.h:208
Aws::Rekognition::Model::NotificationChannel
Definition: NotificationChannel.h:34
Aws::Rekognition::Model::StartFaceSearchRequest::GetServiceRequestName
virtual const char * GetServiceRequestName() const override
Definition: StartFaceSearchRequest.h:32
Video.h
Aws::Rekognition::Model::StartFaceSearchRequest::WithJobTag
StartFaceSearchRequest & WithJobTag(const Aws::String &value)
Definition: StartFaceSearchRequest.h:294
Aws::Rekognition::RekognitionRequest
Definition: RekognitionRequest.h:17
Aws::Rekognition::Model::StartFaceSearchRequest::SetClientRequestToken
void SetClientRequestToken(const char *value)
Definition: StartFaceSearchRequest.h:114
Aws::Rekognition::Model::StartFaceSearchRequest::GetVideo
const Video & GetVideo() const
Definition: StartFaceSearchRequest.h:43
Aws::Rekognition::Model::StartFaceSearchRequest::WithJobTag
StartFaceSearchRequest & WithJobTag(const char *value)
Definition: StartFaceSearchRequest.h:310
Aws::Rekognition::Model::StartFaceSearchRequest::SetClientRequestToken
void SetClientRequestToken(Aws::String &&value)
Definition: StartFaceSearchRequest.h:106
Aws::Rekognition::Model::StartFaceSearchRequest::GetNotificationChannel
const NotificationChannel & GetNotificationChannel() const
Definition: StartFaceSearchRequest.h:215
Aws::Rekognition::Model::StartFaceSearchRequest::FaceMatchThresholdHasBeenSet
bool FaceMatchThresholdHasBeenSet() const
Definition: StartFaceSearchRequest.h:153
AWSString.h
Aws::Rekognition::Model::StartFaceSearchRequest::StartFaceSearchRequest
StartFaceSearchRequest()
Aws::Rekognition::Model::StartFaceSearchRequest::SetJobTag
void SetJobTag(const char *value)
Definition: StartFaceSearchRequest.h:286
Aws::Rekognition::Model::StartFaceSearchRequest::CollectionIdHasBeenSet
bool CollectionIdHasBeenSet() const
Definition: StartFaceSearchRequest.h:178
Aws::Rekognition::Model::StartFaceSearchRequest::WithNotificationChannel
StartFaceSearchRequest & WithNotificationChannel(const NotificationChannel &value)
Definition: StartFaceSearchRequest.h:239
Aws::Rekognition::Model::StartFaceSearchRequest::SetVideo
void SetVideo(Video &&value)
Definition: StartFaceSearchRequest.h:61
Aws::Rekognition::Model::StartFaceSearchRequest::GetCollectionId
const Aws::String & GetCollectionId() const
Definition: StartFaceSearchRequest.h:173
AWS_REKOGNITION_API
#define AWS_REKOGNITION_API
Definition: Rekognition_EXPORTS.h:28
Aws::Rekognition::Model::StartFaceSearchRequest::SetCollectionId
void SetCollectionId(const char *value)
Definition: StartFaceSearchRequest.h:193
Aws::Rekognition::Model::StartFaceSearchRequest::WithFaceMatchThreshold
StartFaceSearchRequest & WithFaceMatchThreshold(double value)
Definition: StartFaceSearchRequest.h:167
Aws
Definition: AccessManagementClient.h:15
NotificationChannel.h
Rekognition_EXPORTS.h
Aws::String
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
Definition: AWSString.h:97
Aws::Rekognition::Model::StartFaceSearchRequest::WithClientRequestToken
StartFaceSearchRequest & WithClientRequestToken(const char *value)
Definition: StartFaceSearchRequest.h:138
Aws::Rekognition::Model::StartFaceSearchRequest::VideoHasBeenSet
bool VideoHasBeenSet() const
Definition: StartFaceSearchRequest.h:49
Aws::Rekognition::Model::StartFaceSearchRequest::ClientRequestTokenHasBeenSet
bool ClientRequestTokenHasBeenSet() const
Definition: StartFaceSearchRequest.h:90
Aws::Rekognition::Model::Video
Definition: Video.h:35
Aws::Rekognition::Model::StartFaceSearchRequest::SetNotificationChannel
void SetNotificationChannel(const NotificationChannel &value)
Definition: StartFaceSearchRequest.h:227
Aws::Rekognition::Model::StartFaceSearchRequest::NotificationChannelHasBeenSet
bool NotificationChannelHasBeenSet() const
Definition: StartFaceSearchRequest.h:221
RekognitionRequest.h