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

#include <ListFacesRequest.h>

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

Public Member Functions

 ListFacesRequest ()
 
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)
 
ListFacesRequestWithCollectionId (const Aws::String &value)
 
ListFacesRequestWithCollectionId (Aws::String &&value)
 
ListFacesRequestWithCollectionId (const char *value)
 
const Aws::StringGetNextToken () const
 
bool NextTokenHasBeenSet () const
 
void SetNextToken (const Aws::String &value)
 
void SetNextToken (Aws::String &&value)
 
void SetNextToken (const char *value)
 
ListFacesRequestWithNextToken (const Aws::String &value)
 
ListFacesRequestWithNextToken (Aws::String &&value)
 
ListFacesRequestWithNextToken (const char *value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
ListFacesRequestWithMaxResults (int 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 ListFacesRequest.h.

Constructor & Destructor Documentation

◆ ListFacesRequest()

Aws::Rekognition::Model::ListFacesRequest::ListFacesRequest ( )

Member Function Documentation

◆ CollectionIdHasBeenSet()

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

ID of the collection from which to list the faces.

Definition at line 45 of file ListFacesRequest.h.

◆ GetCollectionId()

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

ID of the collection from which to list the faces.

Definition at line 40 of file ListFacesRequest.h.

◆ GetMaxResults()

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

Maximum number of faces to return.

Definition at line 138 of file ListFacesRequest.h.

◆ GetNextToken()

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

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

Definition at line 83 of file ListFacesRequest.h.

◆ GetRequestSpecificHeaders()

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

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 30 of file ListFacesRequest.h.

◆ MaxResultsHasBeenSet()

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

Maximum number of faces to return.

Definition at line 143 of file ListFacesRequest.h.

◆ NextTokenHasBeenSet()

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

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

Definition at line 90 of file ListFacesRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetCollectionId() [1/3]

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

ID of the collection from which to list the faces.

Definition at line 55 of file ListFacesRequest.h.

◆ SetCollectionId() [2/3]

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

ID of the collection from which to list the faces.

Definition at line 50 of file ListFacesRequest.h.

◆ SetCollectionId() [3/3]

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

ID of the collection from which to list the faces.

Definition at line 60 of file ListFacesRequest.h.

◆ SetMaxResults()

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

Maximum number of faces to return.

Definition at line 148 of file ListFacesRequest.h.

◆ SetNextToken() [1/3]

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

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

Definition at line 104 of file ListFacesRequest.h.

◆ SetNextToken() [2/3]

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

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

Definition at line 97 of file ListFacesRequest.h.

◆ SetNextToken() [3/3]

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

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

Definition at line 111 of file ListFacesRequest.h.

◆ WithCollectionId() [1/3]

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

ID of the collection from which to list the faces.

Definition at line 70 of file ListFacesRequest.h.

◆ WithCollectionId() [2/3]

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

ID of the collection from which to list the faces.

Definition at line 65 of file ListFacesRequest.h.

◆ WithCollectionId() [3/3]

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

ID of the collection from which to list the faces.

Definition at line 75 of file ListFacesRequest.h.

◆ WithMaxResults()

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

Maximum number of faces to return.

Definition at line 153 of file ListFacesRequest.h.

◆ WithNextToken() [1/3]

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

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

Definition at line 125 of file ListFacesRequest.h.

◆ WithNextToken() [2/3]

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

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

Definition at line 118 of file ListFacesRequest.h.

◆ WithNextToken() [3/3]

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

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

Definition at line 132 of file ListFacesRequest.h.


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