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

#include <DetectTextRequest.h>

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

Public Member Functions

 DetectTextRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const ImageGetImage () const
 
bool ImageHasBeenSet () const
 
void SetImage (const Image &value)
 
void SetImage (Image &&value)
 
DetectTextRequestWithImage (const Image &value)
 
DetectTextRequestWithImage (Image &&value)
 
const DetectTextFiltersGetFilters () const
 
bool FiltersHasBeenSet () const
 
void SetFilters (const DetectTextFilters &value)
 
void SetFilters (DetectTextFilters &&value)
 
DetectTextRequestWithFilters (const DetectTextFilters &value)
 
DetectTextRequestWithFilters (DetectTextFilters &&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 DetectTextRequest.h.

Constructor & Destructor Documentation

◆ DetectTextRequest()

Aws::Rekognition::Model::DetectTextRequest::DetectTextRequest ( )

Member Function Documentation

◆ FiltersHasBeenSet()

bool Aws::Rekognition::Model::DetectTextRequest::FiltersHasBeenSet ( ) const
inline

Optional parameters that let you set the criteria that the text must meet to be included in your response.

Definition at line 103 of file DetectTextRequest.h.

◆ GetFilters()

const DetectTextFilters& Aws::Rekognition::Model::DetectTextRequest::GetFilters ( ) const
inline

Optional parameters that let you set the criteria that the text must meet to be included in your response.

Definition at line 97 of file DetectTextRequest.h.

◆ GetImage()

const Image& Aws::Rekognition::Model::DetectTextRequest::GetImage ( ) const
inline

The input image as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Rekognition operations, you can't pass image bytes.

If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

Definition at line 45 of file DetectTextRequest.h.

◆ GetRequestSpecificHeaders()

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

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 31 of file DetectTextRequest.h.

◆ ImageHasBeenSet()

bool Aws::Rekognition::Model::DetectTextRequest::ImageHasBeenSet ( ) const
inline

The input image as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Rekognition operations, you can't pass image bytes.

If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

Definition at line 54 of file DetectTextRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetFilters() [1/2]

void Aws::Rekognition::Model::DetectTextRequest::SetFilters ( const DetectTextFilters value)
inline

Optional parameters that let you set the criteria that the text must meet to be included in your response.

Definition at line 109 of file DetectTextRequest.h.

◆ SetFilters() [2/2]

void Aws::Rekognition::Model::DetectTextRequest::SetFilters ( DetectTextFilters &&  value)
inline

Optional parameters that let you set the criteria that the text must meet to be included in your response.

Definition at line 115 of file DetectTextRequest.h.

◆ SetImage() [1/2]

void Aws::Rekognition::Model::DetectTextRequest::SetImage ( const Image value)
inline

The input image as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Rekognition operations, you can't pass image bytes.

If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

Definition at line 63 of file DetectTextRequest.h.

◆ SetImage() [2/2]

void Aws::Rekognition::Model::DetectTextRequest::SetImage ( Image &&  value)
inline

The input image as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Rekognition operations, you can't pass image bytes.

If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

Definition at line 72 of file DetectTextRequest.h.

◆ WithFilters() [1/2]

DetectTextRequest& Aws::Rekognition::Model::DetectTextRequest::WithFilters ( const DetectTextFilters value)
inline

Optional parameters that let you set the criteria that the text must meet to be included in your response.

Definition at line 121 of file DetectTextRequest.h.

◆ WithFilters() [2/2]

DetectTextRequest& Aws::Rekognition::Model::DetectTextRequest::WithFilters ( DetectTextFilters &&  value)
inline

Optional parameters that let you set the criteria that the text must meet to be included in your response.

Definition at line 127 of file DetectTextRequest.h.

◆ WithImage() [1/2]

DetectTextRequest& Aws::Rekognition::Model::DetectTextRequest::WithImage ( const Image value)
inline

The input image as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Rekognition operations, you can't pass image bytes.

If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

Definition at line 81 of file DetectTextRequest.h.

◆ WithImage() [2/2]

DetectTextRequest& Aws::Rekognition::Model::DetectTextRequest::WithImage ( Image &&  value)
inline

The input image as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Rekognition operations, you can't pass image bytes.

If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

Definition at line 90 of file DetectTextRequest.h.


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