AWS SDK for C++  1.8.74
AWS SDK for C++
Public Member Functions | List of all members
Aws::Textract::Model::AnalyzeDocumentRequest Class Reference

#include <AnalyzeDocumentRequest.h>

+ Inheritance diagram for Aws::Textract::Model::AnalyzeDocumentRequest:

Public Member Functions

 AnalyzeDocumentRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const DocumentGetDocument () const
 
bool DocumentHasBeenSet () const
 
void SetDocument (const Document &value)
 
void SetDocument (Document &&value)
 
AnalyzeDocumentRequestWithDocument (const Document &value)
 
AnalyzeDocumentRequestWithDocument (Document &&value)
 
const Aws::Vector< FeatureType > & GetFeatureTypes () const
 
bool FeatureTypesHasBeenSet () const
 
void SetFeatureTypes (const Aws::Vector< FeatureType > &value)
 
void SetFeatureTypes (Aws::Vector< FeatureType > &&value)
 
AnalyzeDocumentRequestWithFeatureTypes (const Aws::Vector< FeatureType > &value)
 
AnalyzeDocumentRequestWithFeatureTypes (Aws::Vector< FeatureType > &&value)
 
AnalyzeDocumentRequestAddFeatureTypes (const FeatureType &value)
 
AnalyzeDocumentRequestAddFeatureTypes (FeatureType &&value)
 
const HumanLoopConfigGetHumanLoopConfig () const
 
bool HumanLoopConfigHasBeenSet () const
 
void SetHumanLoopConfig (const HumanLoopConfig &value)
 
void SetHumanLoopConfig (HumanLoopConfig &&value)
 
AnalyzeDocumentRequestWithHumanLoopConfig (const HumanLoopConfig &value)
 
AnalyzeDocumentRequestWithHumanLoopConfig (HumanLoopConfig &&value)
 
- Public Member Functions inherited from Aws::Textract::TextractRequest
virtual ~TextractRequest ()
 
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 24 of file AnalyzeDocumentRequest.h.

Constructor & Destructor Documentation

◆ AnalyzeDocumentRequest()

Aws::Textract::Model::AnalyzeDocumentRequest::AnalyzeDocumentRequest ( )

Member Function Documentation

◆ AddFeatureTypes() [1/2]

AnalyzeDocumentRequest& Aws::Textract::Model::AnalyzeDocumentRequest::AddFeatureTypes ( const FeatureType value)
inline

A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected form data. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All lines and words detected in the document are included in the response (including text that isn't related to the value of FeatureTypes).

Definition at line 163 of file AnalyzeDocumentRequest.h.

◆ AddFeatureTypes() [2/2]

AnalyzeDocumentRequest& Aws::Textract::Model::AnalyzeDocumentRequest::AddFeatureTypes ( FeatureType &&  value)
inline

A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected form data. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All lines and words detected in the document are included in the response (including text that isn't related to the value of FeatureTypes).

Definition at line 173 of file AnalyzeDocumentRequest.h.

◆ DocumentHasBeenSet()

bool Aws::Textract::Model::AnalyzeDocumentRequest::DocumentHasBeenSet ( ) const
inline

The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Textract operations, you can't pass image bytes. The document must be an image in JPEG or PNG format.

If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes that are passed using the Bytes field.

Definition at line 56 of file AnalyzeDocumentRequest.h.

◆ FeatureTypesHasBeenSet()

bool Aws::Textract::Model::AnalyzeDocumentRequest::FeatureTypesHasBeenSet ( ) const
inline

A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected form data. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All lines and words detected in the document are included in the response (including text that isn't related to the value of FeatureTypes).

Definition at line 113 of file AnalyzeDocumentRequest.h.

◆ GetDocument()

const Document& Aws::Textract::Model::AnalyzeDocumentRequest::GetDocument ( ) const
inline

The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Textract operations, you can't pass image bytes. The document must be an image in JPEG or PNG format.

If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes that are passed using the Bytes field.

Definition at line 47 of file AnalyzeDocumentRequest.h.

◆ GetFeatureTypes()

const Aws::Vector<FeatureType>& Aws::Textract::Model::AnalyzeDocumentRequest::GetFeatureTypes ( ) const
inline

A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected form data. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All lines and words detected in the document are included in the response (including text that isn't related to the value of FeatureTypes).

Definition at line 103 of file AnalyzeDocumentRequest.h.

◆ GetHumanLoopConfig()

const HumanLoopConfig& Aws::Textract::Model::AnalyzeDocumentRequest::GetHumanLoopConfig ( ) const
inline

Sets the configuration for the human in the loop workflow for analyzing documents.

Definition at line 180 of file AnalyzeDocumentRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::Textract::Model::AnalyzeDocumentRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::Textract::TextractRequest.

◆ GetServiceRequestName()

virtual const char* Aws::Textract::Model::AnalyzeDocumentRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file AnalyzeDocumentRequest.h.

◆ HumanLoopConfigHasBeenSet()

bool Aws::Textract::Model::AnalyzeDocumentRequest::HumanLoopConfigHasBeenSet ( ) const
inline

Sets the configuration for the human in the loop workflow for analyzing documents.

Definition at line 186 of file AnalyzeDocumentRequest.h.

◆ SerializePayload()

Aws::String Aws::Textract::Model::AnalyzeDocumentRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDocument() [1/2]

void Aws::Textract::Model::AnalyzeDocumentRequest::SetDocument ( const Document value)
inline

The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Textract operations, you can't pass image bytes. The document must be an image in JPEG or PNG format.

If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes that are passed using the Bytes field.

Definition at line 65 of file AnalyzeDocumentRequest.h.

◆ SetDocument() [2/2]

void Aws::Textract::Model::AnalyzeDocumentRequest::SetDocument ( Document &&  value)
inline

The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Textract operations, you can't pass image bytes. The document must be an image in JPEG or PNG format.

If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes that are passed using the Bytes field.

Definition at line 74 of file AnalyzeDocumentRequest.h.

◆ SetFeatureTypes() [1/2]

void Aws::Textract::Model::AnalyzeDocumentRequest::SetFeatureTypes ( const Aws::Vector< FeatureType > &  value)
inline

A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected form data. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All lines and words detected in the document are included in the response (including text that isn't related to the value of FeatureTypes).

Definition at line 123 of file AnalyzeDocumentRequest.h.

◆ SetFeatureTypes() [2/2]

void Aws::Textract::Model::AnalyzeDocumentRequest::SetFeatureTypes ( Aws::Vector< FeatureType > &&  value)
inline

A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected form data. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All lines and words detected in the document are included in the response (including text that isn't related to the value of FeatureTypes).

Definition at line 133 of file AnalyzeDocumentRequest.h.

◆ SetHumanLoopConfig() [1/2]

void Aws::Textract::Model::AnalyzeDocumentRequest::SetHumanLoopConfig ( const HumanLoopConfig value)
inline

Sets the configuration for the human in the loop workflow for analyzing documents.

Definition at line 192 of file AnalyzeDocumentRequest.h.

◆ SetHumanLoopConfig() [2/2]

void Aws::Textract::Model::AnalyzeDocumentRequest::SetHumanLoopConfig ( HumanLoopConfig &&  value)
inline

Sets the configuration for the human in the loop workflow for analyzing documents.

Definition at line 198 of file AnalyzeDocumentRequest.h.

◆ WithDocument() [1/2]

AnalyzeDocumentRequest& Aws::Textract::Model::AnalyzeDocumentRequest::WithDocument ( const Document value)
inline

The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Textract operations, you can't pass image bytes. The document must be an image in JPEG or PNG format.

If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes that are passed using the Bytes field.

Definition at line 83 of file AnalyzeDocumentRequest.h.

◆ WithDocument() [2/2]

AnalyzeDocumentRequest& Aws::Textract::Model::AnalyzeDocumentRequest::WithDocument ( Document &&  value)
inline

The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Textract operations, you can't pass image bytes. The document must be an image in JPEG or PNG format.

If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes that are passed using the Bytes field.

Definition at line 92 of file AnalyzeDocumentRequest.h.

◆ WithFeatureTypes() [1/2]

AnalyzeDocumentRequest& Aws::Textract::Model::AnalyzeDocumentRequest::WithFeatureTypes ( const Aws::Vector< FeatureType > &  value)
inline

A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected form data. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All lines and words detected in the document are included in the response (including text that isn't related to the value of FeatureTypes).

Definition at line 143 of file AnalyzeDocumentRequest.h.

◆ WithFeatureTypes() [2/2]

AnalyzeDocumentRequest& Aws::Textract::Model::AnalyzeDocumentRequest::WithFeatureTypes ( Aws::Vector< FeatureType > &&  value)
inline

A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected form data. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All lines and words detected in the document are included in the response (including text that isn't related to the value of FeatureTypes).

Definition at line 153 of file AnalyzeDocumentRequest.h.

◆ WithHumanLoopConfig() [1/2]

AnalyzeDocumentRequest& Aws::Textract::Model::AnalyzeDocumentRequest::WithHumanLoopConfig ( const HumanLoopConfig value)
inline

Sets the configuration for the human in the loop workflow for analyzing documents.

Definition at line 204 of file AnalyzeDocumentRequest.h.

◆ WithHumanLoopConfig() [2/2]

AnalyzeDocumentRequest& Aws::Textract::Model::AnalyzeDocumentRequest::WithHumanLoopConfig ( HumanLoopConfig &&  value)
inline

Sets the configuration for the human in the loop workflow for analyzing documents.

Definition at line 210 of file AnalyzeDocumentRequest.h.


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