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

#include <GetPersonTrackingRequest.h>

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

Public Member Functions

 GetPersonTrackingRequest ()
 
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)
 
GetPersonTrackingRequestWithJobId (const Aws::String &value)
 
GetPersonTrackingRequestWithJobId (Aws::String &&value)
 
GetPersonTrackingRequestWithJobId (const char *value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
GetPersonTrackingRequestWithMaxResults (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)
 
GetPersonTrackingRequestWithNextToken (const Aws::String &value)
 
GetPersonTrackingRequestWithNextToken (Aws::String &&value)
 
GetPersonTrackingRequestWithNextToken (const char *value)
 
const PersonTrackingSortByGetSortBy () const
 
bool SortByHasBeenSet () const
 
void SetSortBy (const PersonTrackingSortBy &value)
 
void SetSortBy (PersonTrackingSortBy &&value)
 
GetPersonTrackingRequestWithSortBy (const PersonTrackingSortBy &value)
 
GetPersonTrackingRequestWithSortBy (PersonTrackingSortBy &&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 GetPersonTrackingRequest.h.

Constructor & Destructor Documentation

◆ GetPersonTrackingRequest()

Aws::Rekognition::Model::GetPersonTrackingRequest::GetPersonTrackingRequest ( )

Member Function Documentation

◆ GetJobId()

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

The identifier for a job that tracks persons in a video. You get the JobId from a call to StartPersonTracking.

Definition at line 42 of file GetPersonTrackingRequest.h.

◆ GetMaxResults()

int Aws::Rekognition::Model::GetPersonTrackingRequest::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 GetPersonTrackingRequest.h.

◆ GetNextToken()

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

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

Definition at line 121 of file GetPersonTrackingRequest.h.

◆ GetRequestSpecificHeaders()

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

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 31 of file GetPersonTrackingRequest.h.

◆ GetSortBy()

const PersonTrackingSortBy& Aws::Rekognition::Model::GetPersonTrackingRequest::GetSortBy ( ) const
inline

Sort to use for elements in the Persons array. Use TIMESTAMP to sort array elements by the time persons are detected. Use INDEX to sort by the tracked persons. If you sort by INDEX, the array elements for each person are sorted by detection confidence. The default sort is by TIMESTAMP.

Definition at line 180 of file GetPersonTrackingRequest.h.

◆ JobIdHasBeenSet()

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

The identifier for a job that tracks persons in a video. You get the JobId from a call to StartPersonTracking.

Definition at line 48 of file GetPersonTrackingRequest.h.

◆ MaxResultsHasBeenSet()

bool Aws::Rekognition::Model::GetPersonTrackingRequest::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 GetPersonTrackingRequest.h.

◆ NextTokenHasBeenSet()

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

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

Definition at line 128 of file GetPersonTrackingRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetJobId() [1/3]

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

The identifier for a job that tracks persons in a video. You get the JobId from a call to StartPersonTracking.

Definition at line 60 of file GetPersonTrackingRequest.h.

◆ SetJobId() [2/3]

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

The identifier for a job that tracks persons in a video. You get the JobId from a call to StartPersonTracking.

Definition at line 54 of file GetPersonTrackingRequest.h.

◆ SetJobId() [3/3]

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

The identifier for a job that tracks persons in a video. You get the JobId from a call to StartPersonTracking.

Definition at line 66 of file GetPersonTrackingRequest.h.

◆ SetMaxResults()

void Aws::Rekognition::Model::GetPersonTrackingRequest::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 GetPersonTrackingRequest.h.

◆ SetNextToken() [1/3]

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

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

Definition at line 142 of file GetPersonTrackingRequest.h.

◆ SetNextToken() [2/3]

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

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

Definition at line 135 of file GetPersonTrackingRequest.h.

◆ SetNextToken() [3/3]

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

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

Definition at line 149 of file GetPersonTrackingRequest.h.

◆ SetSortBy() [1/2]

void Aws::Rekognition::Model::GetPersonTrackingRequest::SetSortBy ( const PersonTrackingSortBy value)
inline

Sort to use for elements in the Persons array. Use TIMESTAMP to sort array elements by the time persons are detected. Use INDEX to sort by the tracked persons. If you sort by INDEX, the array elements for each person are sorted by detection confidence. The default sort is by TIMESTAMP.

Definition at line 198 of file GetPersonTrackingRequest.h.

◆ SetSortBy() [2/2]

void Aws::Rekognition::Model::GetPersonTrackingRequest::SetSortBy ( PersonTrackingSortBy &&  value)
inline

Sort to use for elements in the Persons array. Use TIMESTAMP to sort array elements by the time persons are detected. Use INDEX to sort by the tracked persons. If you sort by INDEX, the array elements for each person are sorted by detection confidence. The default sort is by TIMESTAMP.

Definition at line 207 of file GetPersonTrackingRequest.h.

◆ SortByHasBeenSet()

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

Sort to use for elements in the Persons array. Use TIMESTAMP to sort array elements by the time persons are detected. Use INDEX to sort by the tracked persons. If you sort by INDEX, the array elements for each person are sorted by detection confidence. The default sort is by TIMESTAMP.

Definition at line 189 of file GetPersonTrackingRequest.h.

◆ WithJobId() [1/3]

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

The identifier for a job that tracks persons in a video. You get the JobId from a call to StartPersonTracking.

Definition at line 78 of file GetPersonTrackingRequest.h.

◆ WithJobId() [2/3]

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

The identifier for a job that tracks persons in a video. You get the JobId from a call to StartPersonTracking.

Definition at line 72 of file GetPersonTrackingRequest.h.

◆ WithJobId() [3/3]

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

The identifier for a job that tracks persons in a video. You get the JobId from a call to StartPersonTracking.

Definition at line 84 of file GetPersonTrackingRequest.h.

◆ WithMaxResults()

GetPersonTrackingRequest& Aws::Rekognition::Model::GetPersonTrackingRequest::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 GetPersonTrackingRequest.h.

◆ WithNextToken() [1/3]

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

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

Definition at line 163 of file GetPersonTrackingRequest.h.

◆ WithNextToken() [2/3]

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

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

Definition at line 156 of file GetPersonTrackingRequest.h.

◆ WithNextToken() [3/3]

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

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

Definition at line 170 of file GetPersonTrackingRequest.h.

◆ WithSortBy() [1/2]

GetPersonTrackingRequest& Aws::Rekognition::Model::GetPersonTrackingRequest::WithSortBy ( const PersonTrackingSortBy value)
inline

Sort to use for elements in the Persons array. Use TIMESTAMP to sort array elements by the time persons are detected. Use INDEX to sort by the tracked persons. If you sort by INDEX, the array elements for each person are sorted by detection confidence. The default sort is by TIMESTAMP.

Definition at line 216 of file GetPersonTrackingRequest.h.

◆ WithSortBy() [2/2]

GetPersonTrackingRequest& Aws::Rekognition::Model::GetPersonTrackingRequest::WithSortBy ( PersonTrackingSortBy &&  value)
inline

Sort to use for elements in the Persons array. Use TIMESTAMP to sort array elements by the time persons are detected. Use INDEX to sort by the tracked persons. If you sort by INDEX, the array elements for each person are sorted by detection confidence. The default sort is by TIMESTAMP.

Definition at line 225 of file GetPersonTrackingRequest.h.


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