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

#include <GetLabelDetectionRequest.h>

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

Public Member Functions

 GetLabelDetectionRequest ()
 
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)
 
GetLabelDetectionRequestWithJobId (const Aws::String &value)
 
GetLabelDetectionRequestWithJobId (Aws::String &&value)
 
GetLabelDetectionRequestWithJobId (const char *value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
GetLabelDetectionRequestWithMaxResults (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)
 
GetLabelDetectionRequestWithNextToken (const Aws::String &value)
 
GetLabelDetectionRequestWithNextToken (Aws::String &&value)
 
GetLabelDetectionRequestWithNextToken (const char *value)
 
const LabelDetectionSortByGetSortBy () const
 
bool SortByHasBeenSet () const
 
void SetSortBy (const LabelDetectionSortBy &value)
 
void SetSortBy (LabelDetectionSortBy &&value)
 
GetLabelDetectionRequestWithSortBy (const LabelDetectionSortBy &value)
 
GetLabelDetectionRequestWithSortBy (LabelDetectionSortBy &&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 GetLabelDetectionRequest.h.

Constructor & Destructor Documentation

◆ GetLabelDetectionRequest()

Aws::Rekognition::Model::GetLabelDetectionRequest::GetLabelDetectionRequest ( )

Member Function Documentation

◆ GetJobId()

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

Job identifier for the label detection operation for which you want results returned. You get the job identifer from an initial call to StartlabelDetection.

Definition at line 43 of file GetLabelDetectionRequest.h.

◆ GetMaxResults()

int Aws::Rekognition::Model::GetLabelDetectionRequest::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 100 of file GetLabelDetectionRequest.h.

◆ GetNextToken()

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

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

Definition at line 129 of file GetLabelDetectionRequest.h.

◆ GetRequestSpecificHeaders()

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

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 31 of file GetLabelDetectionRequest.h.

◆ GetSortBy()

const LabelDetectionSortBy& Aws::Rekognition::Model::GetLabelDetectionRequest::GetSortBy ( ) const
inline

Sort to use for elements in the Labels array. Use TIMESTAMP to sort array elements by the time labels are detected. Use NAME to alphabetically group elements for a label together. Within each label group, the array element are sorted by detection confidence. The default sort is by TIMESTAMP.

Definition at line 188 of file GetLabelDetectionRequest.h.

◆ JobIdHasBeenSet()

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

Job identifier for the label detection operation for which you want results returned. You get the job identifer from an initial call to StartlabelDetection.

Definition at line 50 of file GetLabelDetectionRequest.h.

◆ MaxResultsHasBeenSet()

bool Aws::Rekognition::Model::GetLabelDetectionRequest::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 107 of file GetLabelDetectionRequest.h.

◆ NextTokenHasBeenSet()

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

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

Definition at line 136 of file GetLabelDetectionRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetJobId() [1/3]

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

Job identifier for the label detection operation for which you want results returned. You get the job identifer from an initial call to StartlabelDetection.

Definition at line 64 of file GetLabelDetectionRequest.h.

◆ SetJobId() [2/3]

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

Job identifier for the label detection operation for which you want results returned. You get the job identifer from an initial call to StartlabelDetection.

Definition at line 57 of file GetLabelDetectionRequest.h.

◆ SetJobId() [3/3]

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

Job identifier for the label detection operation for which you want results returned. You get the job identifer from an initial call to StartlabelDetection.

Definition at line 71 of file GetLabelDetectionRequest.h.

◆ SetMaxResults()

void Aws::Rekognition::Model::GetLabelDetectionRequest::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 114 of file GetLabelDetectionRequest.h.

◆ SetNextToken() [1/3]

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

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

Definition at line 150 of file GetLabelDetectionRequest.h.

◆ SetNextToken() [2/3]

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

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

Definition at line 143 of file GetLabelDetectionRequest.h.

◆ SetNextToken() [3/3]

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

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

Definition at line 157 of file GetLabelDetectionRequest.h.

◆ SetSortBy() [1/2]

void Aws::Rekognition::Model::GetLabelDetectionRequest::SetSortBy ( const LabelDetectionSortBy value)
inline

Sort to use for elements in the Labels array. Use TIMESTAMP to sort array elements by the time labels are detected. Use NAME to alphabetically group elements for a label together. Within each label group, the array element are sorted by detection confidence. The default sort is by TIMESTAMP.

Definition at line 206 of file GetLabelDetectionRequest.h.

◆ SetSortBy() [2/2]

void Aws::Rekognition::Model::GetLabelDetectionRequest::SetSortBy ( LabelDetectionSortBy &&  value)
inline

Sort to use for elements in the Labels array. Use TIMESTAMP to sort array elements by the time labels are detected. Use NAME to alphabetically group elements for a label together. Within each label group, the array element are sorted by detection confidence. The default sort is by TIMESTAMP.

Definition at line 215 of file GetLabelDetectionRequest.h.

◆ SortByHasBeenSet()

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

Sort to use for elements in the Labels array. Use TIMESTAMP to sort array elements by the time labels are detected. Use NAME to alphabetically group elements for a label together. Within each label group, the array element are sorted by detection confidence. The default sort is by TIMESTAMP.

Definition at line 197 of file GetLabelDetectionRequest.h.

◆ WithJobId() [1/3]

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

Job identifier for the label detection operation for which you want results returned. You get the job identifer from an initial call to StartlabelDetection.

Definition at line 85 of file GetLabelDetectionRequest.h.

◆ WithJobId() [2/3]

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

Job identifier for the label detection operation for which you want results returned. You get the job identifer from an initial call to StartlabelDetection.

Definition at line 78 of file GetLabelDetectionRequest.h.

◆ WithJobId() [3/3]

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

Job identifier for the label detection operation for which you want results returned. You get the job identifer from an initial call to StartlabelDetection.

Definition at line 92 of file GetLabelDetectionRequest.h.

◆ WithMaxResults()

GetLabelDetectionRequest& Aws::Rekognition::Model::GetLabelDetectionRequest::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 121 of file GetLabelDetectionRequest.h.

◆ WithNextToken() [1/3]

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

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

Definition at line 171 of file GetLabelDetectionRequest.h.

◆ WithNextToken() [2/3]

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

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

Definition at line 164 of file GetLabelDetectionRequest.h.

◆ WithNextToken() [3/3]

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

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

Definition at line 178 of file GetLabelDetectionRequest.h.

◆ WithSortBy() [1/2]

GetLabelDetectionRequest& Aws::Rekognition::Model::GetLabelDetectionRequest::WithSortBy ( const LabelDetectionSortBy value)
inline

Sort to use for elements in the Labels array. Use TIMESTAMP to sort array elements by the time labels are detected. Use NAME to alphabetically group elements for a label together. Within each label group, the array element are sorted by detection confidence. The default sort is by TIMESTAMP.

Definition at line 224 of file GetLabelDetectionRequest.h.

◆ WithSortBy() [2/2]

GetLabelDetectionRequest& Aws::Rekognition::Model::GetLabelDetectionRequest::WithSortBy ( LabelDetectionSortBy &&  value)
inline

Sort to use for elements in the Labels array. Use TIMESTAMP to sort array elements by the time labels are detected. Use NAME to alphabetically group elements for a label together. Within each label group, the array element are sorted by detection confidence. The default sort is by TIMESTAMP.

Definition at line 233 of file GetLabelDetectionRequest.h.


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