AWS SDK for C++  1.9.125
AWS SDK for C++
Public Member Functions | List of all members
Aws::Rekognition::Model::SearchFacesRequest Class Reference

#include <SearchFacesRequest.h>

+ Inheritance diagram for Aws::Rekognition::Model::SearchFacesRequest:

Public Member Functions

 SearchFacesRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetCollectionId () const
 
bool CollectionIdHasBeenSet () const
 
void SetCollectionId (const Aws::String &value)
 
void SetCollectionId (Aws::String &&value)
 
void SetCollectionId (const char *value)
 
SearchFacesRequestWithCollectionId (const Aws::String &value)
 
SearchFacesRequestWithCollectionId (Aws::String &&value)
 
SearchFacesRequestWithCollectionId (const char *value)
 
const Aws::StringGetFaceId () const
 
bool FaceIdHasBeenSet () const
 
void SetFaceId (const Aws::String &value)
 
void SetFaceId (Aws::String &&value)
 
void SetFaceId (const char *value)
 
SearchFacesRequestWithFaceId (const Aws::String &value)
 
SearchFacesRequestWithFaceId (Aws::String &&value)
 
SearchFacesRequestWithFaceId (const char *value)
 
int GetMaxFaces () const
 
bool MaxFacesHasBeenSet () const
 
void SetMaxFaces (int value)
 
SearchFacesRequestWithMaxFaces (int value)
 
double GetFaceMatchThreshold () const
 
bool FaceMatchThresholdHasBeenSet () const
 
void SetFaceMatchThreshold (double value)
 
SearchFacesRequestWithFaceMatchThreshold (double value)
 
- Public Member Functions inherited from Aws::Rekognition::RekognitionRequest
virtual ~RekognitionRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- 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 IsEventStreamRequest () 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 21 of file SearchFacesRequest.h.

Constructor & Destructor Documentation

◆ SearchFacesRequest()

Aws::Rekognition::Model::SearchFacesRequest::SearchFacesRequest ( )

Member Function Documentation

◆ CollectionIdHasBeenSet()

bool Aws::Rekognition::Model::SearchFacesRequest::CollectionIdHasBeenSet ( ) const
inline

ID of the collection the face belongs to.

Definition at line 45 of file SearchFacesRequest.h.

◆ FaceIdHasBeenSet()

bool Aws::Rekognition::Model::SearchFacesRequest::FaceIdHasBeenSet ( ) const
inline

ID of a face to find matches for in the collection.

Definition at line 86 of file SearchFacesRequest.h.

◆ FaceMatchThresholdHasBeenSet()

bool Aws::Rekognition::Model::SearchFacesRequest::FaceMatchThresholdHasBeenSet ( ) const
inline

Optional value specifying the minimum confidence in the face match to return. For example, don't return any matches where confidence in matches is less than 70%. The default value is 80%.

Definition at line 156 of file SearchFacesRequest.h.

◆ GetCollectionId()

const Aws::String& Aws::Rekognition::Model::SearchFacesRequest::GetCollectionId ( ) const
inline

ID of the collection the face belongs to.

Definition at line 40 of file SearchFacesRequest.h.

◆ GetFaceId()

const Aws::String& Aws::Rekognition::Model::SearchFacesRequest::GetFaceId ( ) const
inline

ID of a face to find matches for in the collection.

Definition at line 81 of file SearchFacesRequest.h.

◆ GetFaceMatchThreshold()

double Aws::Rekognition::Model::SearchFacesRequest::GetFaceMatchThreshold ( ) const
inline

Optional value specifying the minimum confidence in the face match to return. For example, don't return any matches where confidence in matches is less than 70%. The default value is 80%.

Definition at line 149 of file SearchFacesRequest.h.

◆ GetMaxFaces()

int Aws::Rekognition::Model::SearchFacesRequest::GetMaxFaces ( ) const
inline

Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.

Definition at line 123 of file SearchFacesRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::Rekognition::Model::SearchFacesRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetServiceRequestName()

virtual const char* Aws::Rekognition::Model::SearchFacesRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 30 of file SearchFacesRequest.h.

◆ MaxFacesHasBeenSet()

bool Aws::Rekognition::Model::SearchFacesRequest::MaxFacesHasBeenSet ( ) const
inline

Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.

Definition at line 129 of file SearchFacesRequest.h.

◆ SerializePayload()

Aws::String Aws::Rekognition::Model::SearchFacesRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetCollectionId() [1/3]

void Aws::Rekognition::Model::SearchFacesRequest::SetCollectionId ( Aws::String &&  value)
inline

ID of the collection the face belongs to.

Definition at line 55 of file SearchFacesRequest.h.

◆ SetCollectionId() [2/3]

void Aws::Rekognition::Model::SearchFacesRequest::SetCollectionId ( const Aws::String value)
inline

ID of the collection the face belongs to.

Definition at line 50 of file SearchFacesRequest.h.

◆ SetCollectionId() [3/3]

void Aws::Rekognition::Model::SearchFacesRequest::SetCollectionId ( const char *  value)
inline

ID of the collection the face belongs to.

Definition at line 60 of file SearchFacesRequest.h.

◆ SetFaceId() [1/3]

void Aws::Rekognition::Model::SearchFacesRequest::SetFaceId ( Aws::String &&  value)
inline

ID of a face to find matches for in the collection.

Definition at line 96 of file SearchFacesRequest.h.

◆ SetFaceId() [2/3]

void Aws::Rekognition::Model::SearchFacesRequest::SetFaceId ( const Aws::String value)
inline

ID of a face to find matches for in the collection.

Definition at line 91 of file SearchFacesRequest.h.

◆ SetFaceId() [3/3]

void Aws::Rekognition::Model::SearchFacesRequest::SetFaceId ( const char *  value)
inline

ID of a face to find matches for in the collection.

Definition at line 101 of file SearchFacesRequest.h.

◆ SetFaceMatchThreshold()

void Aws::Rekognition::Model::SearchFacesRequest::SetFaceMatchThreshold ( double  value)
inline

Optional value specifying the minimum confidence in the face match to return. For example, don't return any matches where confidence in matches is less than 70%. The default value is 80%.

Definition at line 163 of file SearchFacesRequest.h.

◆ SetMaxFaces()

void Aws::Rekognition::Model::SearchFacesRequest::SetMaxFaces ( int  value)
inline

Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.

Definition at line 135 of file SearchFacesRequest.h.

◆ WithCollectionId() [1/3]

SearchFacesRequest& Aws::Rekognition::Model::SearchFacesRequest::WithCollectionId ( Aws::String &&  value)
inline

ID of the collection the face belongs to.

Definition at line 70 of file SearchFacesRequest.h.

◆ WithCollectionId() [2/3]

SearchFacesRequest& Aws::Rekognition::Model::SearchFacesRequest::WithCollectionId ( const Aws::String value)
inline

ID of the collection the face belongs to.

Definition at line 65 of file SearchFacesRequest.h.

◆ WithCollectionId() [3/3]

SearchFacesRequest& Aws::Rekognition::Model::SearchFacesRequest::WithCollectionId ( const char *  value)
inline

ID of the collection the face belongs to.

Definition at line 75 of file SearchFacesRequest.h.

◆ WithFaceId() [1/3]

SearchFacesRequest& Aws::Rekognition::Model::SearchFacesRequest::WithFaceId ( Aws::String &&  value)
inline

ID of a face to find matches for in the collection.

Definition at line 111 of file SearchFacesRequest.h.

◆ WithFaceId() [2/3]

SearchFacesRequest& Aws::Rekognition::Model::SearchFacesRequest::WithFaceId ( const Aws::String value)
inline

ID of a face to find matches for in the collection.

Definition at line 106 of file SearchFacesRequest.h.

◆ WithFaceId() [3/3]

SearchFacesRequest& Aws::Rekognition::Model::SearchFacesRequest::WithFaceId ( const char *  value)
inline

ID of a face to find matches for in the collection.

Definition at line 116 of file SearchFacesRequest.h.

◆ WithFaceMatchThreshold()

SearchFacesRequest& Aws::Rekognition::Model::SearchFacesRequest::WithFaceMatchThreshold ( double  value)
inline

Optional value specifying the minimum confidence in the face match to return. For example, don't return any matches where confidence in matches is less than 70%. The default value is 80%.

Definition at line 170 of file SearchFacesRequest.h.

◆ WithMaxFaces()

SearchFacesRequest& Aws::Rekognition::Model::SearchFacesRequest::WithMaxFaces ( int  value)
inline

Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.

Definition at line 141 of file SearchFacesRequest.h.


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