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

#include <GetFaceSearchRequest.h>

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

Public Member Functions

 GetFaceSearchRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetJobId () const
 
bool JobIdHasBeenSet () const
 
void SetJobId (const Aws::String &value)
 
void SetJobId (Aws::String &&value)
 
void SetJobId (const char *value)
 
GetFaceSearchRequestWithJobId (const Aws::String &value)
 
GetFaceSearchRequestWithJobId (Aws::String &&value)
 
GetFaceSearchRequestWithJobId (const char *value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
GetFaceSearchRequestWithMaxResults (int value)
 
const Aws::StringGetNextToken () const
 
bool NextTokenHasBeenSet () const
 
void SetNextToken (const Aws::String &value)
 
void SetNextToken (Aws::String &&value)
 
void SetNextToken (const char *value)
 
GetFaceSearchRequestWithNextToken (const Aws::String &value)
 
GetFaceSearchRequestWithNextToken (Aws::String &&value)
 
GetFaceSearchRequestWithNextToken (const char *value)
 
const FaceSearchSortByGetSortBy () const
 
bool SortByHasBeenSet () const
 
void SetSortBy (const FaceSearchSortBy &value)
 
void SetSortBy (FaceSearchSortBy &&value)
 
GetFaceSearchRequestWithSortBy (const FaceSearchSortBy &value)
 
GetFaceSearchRequestWithSortBy (FaceSearchSortBy &&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 22 of file GetFaceSearchRequest.h.

Constructor & Destructor Documentation

◆ GetFaceSearchRequest()

Aws::Rekognition::Model::GetFaceSearchRequest::GetFaceSearchRequest ( )

Member Function Documentation

◆ GetJobId()

const Aws::String& Aws::Rekognition::Model::GetFaceSearchRequest::GetJobId ( ) const
inline

The job identifer for the search request. You get the job identifier from an initial call to StartFaceSearch.

Definition at line 42 of file GetFaceSearchRequest.h.

◆ GetMaxResults()

int Aws::Rekognition::Model::GetFaceSearchRequest::GetMaxResults ( ) const
inline

Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.

Definition at line 92 of file GetFaceSearchRequest.h.

◆ GetNextToken()

const Aws::String& Aws::Rekognition::Model::GetFaceSearchRequest::GetNextToken ( ) const
inline

If the previous response was incomplete (because there is more search results to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of search results.

Definition at line 122 of file GetFaceSearchRequest.h.

◆ GetRequestSpecificHeaders()

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

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 31 of file GetFaceSearchRequest.h.

◆ GetSortBy()

const FaceSearchSortBy& Aws::Rekognition::Model::GetFaceSearchRequest::GetSortBy ( ) const
inline

Sort to use for grouping faces in the response. Use TIMESTAMP to group faces by the time that they are recognized. Use INDEX to sort by recognized faces.

Definition at line 186 of file GetFaceSearchRequest.h.

◆ JobIdHasBeenSet()

bool Aws::Rekognition::Model::GetFaceSearchRequest::JobIdHasBeenSet ( ) const
inline

The job identifer for the search request. You get the job identifier from an initial call to StartFaceSearch.

Definition at line 48 of file GetFaceSearchRequest.h.

◆ MaxResultsHasBeenSet()

bool Aws::Rekognition::Model::GetFaceSearchRequest::MaxResultsHasBeenSet ( ) const
inline

Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.

Definition at line 99 of file GetFaceSearchRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::Rekognition::Model::GetFaceSearchRequest::NextTokenHasBeenSet ( ) const
inline

If the previous response was incomplete (because there is more search results to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of search results.

Definition at line 130 of file GetFaceSearchRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetJobId() [1/3]

void Aws::Rekognition::Model::GetFaceSearchRequest::SetJobId ( Aws::String &&  value)
inline

The job identifer for the search request. You get the job identifier from an initial call to StartFaceSearch.

Definition at line 60 of file GetFaceSearchRequest.h.

◆ SetJobId() [2/3]

void Aws::Rekognition::Model::GetFaceSearchRequest::SetJobId ( const Aws::String value)
inline

The job identifer for the search request. You get the job identifier from an initial call to StartFaceSearch.

Definition at line 54 of file GetFaceSearchRequest.h.

◆ SetJobId() [3/3]

void Aws::Rekognition::Model::GetFaceSearchRequest::SetJobId ( const char *  value)
inline

The job identifer for the search request. You get the job identifier from an initial call to StartFaceSearch.

Definition at line 66 of file GetFaceSearchRequest.h.

◆ SetMaxResults()

void Aws::Rekognition::Model::GetFaceSearchRequest::SetMaxResults ( int  value)
inline

Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.

Definition at line 106 of file GetFaceSearchRequest.h.

◆ SetNextToken() [1/3]

void Aws::Rekognition::Model::GetFaceSearchRequest::SetNextToken ( Aws::String &&  value)
inline

If the previous response was incomplete (because there is more search results to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of search results.

Definition at line 146 of file GetFaceSearchRequest.h.

◆ SetNextToken() [2/3]

void Aws::Rekognition::Model::GetFaceSearchRequest::SetNextToken ( const Aws::String value)
inline

If the previous response was incomplete (because there is more search results to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of search results.

Definition at line 138 of file GetFaceSearchRequest.h.

◆ SetNextToken() [3/3]

void Aws::Rekognition::Model::GetFaceSearchRequest::SetNextToken ( const char *  value)
inline

If the previous response was incomplete (because there is more search results to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of search results.

Definition at line 154 of file GetFaceSearchRequest.h.

◆ SetSortBy() [1/2]

void Aws::Rekognition::Model::GetFaceSearchRequest::SetSortBy ( const FaceSearchSortBy value)
inline

Sort to use for grouping faces in the response. Use TIMESTAMP to group faces by the time that they are recognized. Use INDEX to sort by recognized faces.

Definition at line 200 of file GetFaceSearchRequest.h.

◆ SetSortBy() [2/2]

void Aws::Rekognition::Model::GetFaceSearchRequest::SetSortBy ( FaceSearchSortBy &&  value)
inline

Sort to use for grouping faces in the response. Use TIMESTAMP to group faces by the time that they are recognized. Use INDEX to sort by recognized faces.

Definition at line 207 of file GetFaceSearchRequest.h.

◆ SortByHasBeenSet()

bool Aws::Rekognition::Model::GetFaceSearchRequest::SortByHasBeenSet ( ) const
inline

Sort to use for grouping faces in the response. Use TIMESTAMP to group faces by the time that they are recognized. Use INDEX to sort by recognized faces.

Definition at line 193 of file GetFaceSearchRequest.h.

◆ WithJobId() [1/3]

GetFaceSearchRequest& Aws::Rekognition::Model::GetFaceSearchRequest::WithJobId ( Aws::String &&  value)
inline

The job identifer for the search request. You get the job identifier from an initial call to StartFaceSearch.

Definition at line 78 of file GetFaceSearchRequest.h.

◆ WithJobId() [2/3]

GetFaceSearchRequest& Aws::Rekognition::Model::GetFaceSearchRequest::WithJobId ( const Aws::String value)
inline

The job identifer for the search request. You get the job identifier from an initial call to StartFaceSearch.

Definition at line 72 of file GetFaceSearchRequest.h.

◆ WithJobId() [3/3]

GetFaceSearchRequest& Aws::Rekognition::Model::GetFaceSearchRequest::WithJobId ( const char *  value)
inline

The job identifer for the search request. You get the job identifier from an initial call to StartFaceSearch.

Definition at line 84 of file GetFaceSearchRequest.h.

◆ WithMaxResults()

GetFaceSearchRequest& Aws::Rekognition::Model::GetFaceSearchRequest::WithMaxResults ( int  value)
inline

Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.

Definition at line 113 of file GetFaceSearchRequest.h.

◆ WithNextToken() [1/3]

GetFaceSearchRequest& Aws::Rekognition::Model::GetFaceSearchRequest::WithNextToken ( Aws::String &&  value)
inline

If the previous response was incomplete (because there is more search results to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of search results.

Definition at line 170 of file GetFaceSearchRequest.h.

◆ WithNextToken() [2/3]

GetFaceSearchRequest& Aws::Rekognition::Model::GetFaceSearchRequest::WithNextToken ( const Aws::String value)
inline

If the previous response was incomplete (because there is more search results to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of search results.

Definition at line 162 of file GetFaceSearchRequest.h.

◆ WithNextToken() [3/3]

GetFaceSearchRequest& Aws::Rekognition::Model::GetFaceSearchRequest::WithNextToken ( const char *  value)
inline

If the previous response was incomplete (because there is more search results to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of search results.

Definition at line 178 of file GetFaceSearchRequest.h.

◆ WithSortBy() [1/2]

GetFaceSearchRequest& Aws::Rekognition::Model::GetFaceSearchRequest::WithSortBy ( const FaceSearchSortBy value)
inline

Sort to use for grouping faces in the response. Use TIMESTAMP to group faces by the time that they are recognized. Use INDEX to sort by recognized faces.

Definition at line 214 of file GetFaceSearchRequest.h.

◆ WithSortBy() [2/2]

GetFaceSearchRequest& Aws::Rekognition::Model::GetFaceSearchRequest::WithSortBy ( FaceSearchSortBy &&  value)
inline

Sort to use for grouping faces in the response. Use TIMESTAMP to group faces by the time that they are recognized. Use INDEX to sort by recognized faces.

Definition at line 221 of file GetFaceSearchRequest.h.


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