Aws::Textract::Model::AnalyzeDocumentRequest Class Reference

#include <AnalyzeDocumentRequest.h>

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

Public Member Functions

AWS_TEXTRACT_API AnalyzeDocumentRequest ()=default

 

virtual const char * GetServiceRequestName () const override

 

AWS_TEXTRACT_API Aws::String SerializePayload () const override

 

AWS_TEXTRACT_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override

 

const Document & GetDocument () const

 

bool DocumentHasBeenSet () const

 

template<typename DocumentT = Document>

void SetDocument (DocumentT &&value)

 

template<typename DocumentT = Document>

AnalyzeDocumentRequest & WithDocument (DocumentT &&value)

 

const Aws::Vector< FeatureType > & GetFeatureTypes () const

 

bool FeatureTypesHasBeenSet () const

 

template<typename FeatureTypesT = Aws::Vector<FeatureType>>

void SetFeatureTypes (FeatureTypesT &&value)

 

template<typename FeatureTypesT = Aws::Vector<FeatureType>>

AnalyzeDocumentRequest & WithFeatureTypes (FeatureTypesT &&value)

 

AnalyzeDocumentRequest & AddFeatureTypes (FeatureType value)

 

const HumanLoopConfig & GetHumanLoopConfig () const

 

bool HumanLoopConfigHasBeenSet () const

 

template<typename HumanLoopConfigT = HumanLoopConfig>

void SetHumanLoopConfig (HumanLoopConfigT &&value)

 

template<typename HumanLoopConfigT = HumanLoopConfig>

AnalyzeDocumentRequest & WithHumanLoopConfig (HumanLoopConfigT &&value)

 

const QueriesConfig & GetQueriesConfig () const

 

bool QueriesConfigHasBeenSet () const

 

template<typename QueriesConfigT = QueriesConfig>

void SetQueriesConfig (QueriesConfigT &&value)

 

template<typename QueriesConfigT = QueriesConfig>

AnalyzeDocumentRequest & WithQueriesConfig (QueriesConfigT &&value)

 

const AdaptersConfig & GetAdaptersConfig () const

 

bool AdaptersConfigHasBeenSet () const

 

template<typename AdaptersConfigT = AdaptersConfig>

void SetAdaptersConfig (AdaptersConfigT &&value)

 

template<typename AdaptersConfigT = AdaptersConfig>

AnalyzeDocumentRequest & WithAdaptersConfig (AdaptersConfigT &&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::IOStream > GetBody () const override

 

Public Member Functions inherited from Aws::AmazonWebServiceRequest

 AmazonWebServiceRequest ()

 

virtual ~AmazonWebServiceRequest ()=default

 

virtual const Aws::Http::HeaderValueCollection & GetAdditionalCustomHeaders () const

 

virtual void SetAdditionalCustomHeaderValue (const Aws::String &headerName, const Aws::String &headerValue)

 

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 HasEventStreamResponse () const

 

virtual bool SignBody () const

 

virtual bool HasEmbeddedError (Aws::IOStream &body, const Aws::Http::HeaderValueCollection &header) const

 

virtual bool IsChunked () const

 

virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)

 

virtual const RequestSignedHandler & GetRequestSignedHandler () const

 

const Aws::IOStreamFactory & GetResponseStreamFactory () const

 

void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)

 

virtual const Aws::Http::HeadersReceivedEventHandler & GetHeadersReceivedEventHandler () const

 

virtual const Aws::Http::DataReceivedEventHandler & GetDataReceivedEventHandler () const

 

virtual const Aws::Http::DataSentEventHandler & GetDataSentEventHandler () const

 

virtual const Aws::Http::ContinueRequestHandler & GetContinueRequestHandler () const

 

virtual const RequestRetryHandler & GetRequestRetryHandler () const

 

virtual bool ShouldComputeContentMd5 () const

 

virtual bool ShouldValidateResponseChecksum () const

 

virtual Aws::Vector< Aws::String > GetResponseChecksumAlgorithmNames () const

 

virtual Aws::String GetChecksumAlgorithmName () const

 

virtual void SetServiceSpecificParameters (const std::shared_ptr< Http::ServiceSpecificParameters > &serviceSpecificParameters) const

 

virtual std::shared_ptr< Http::ServiceSpecificParameters > GetServiceSpecificParameters () const

 

virtual EndpointParameters GetEndpointContextParams () const

 

virtual Aws::Client::CompressionAlgorithm GetSelectedCompressionAlgorithm (Aws::Client::RequestCompressionConfig) const

 

void AddUserAgentFeature (Aws::Client::UserAgentFeature feature) const

 

Aws::Set< Aws::Client::UserAgentFeature > GetUserAgentFeatures () const

 

virtual bool RequestChecksumRequired () const

 

virtual void SetHeadersReceivedEventHandler (const Aws::Http::HeadersReceivedEventHandler &headersReceivedEventHandler)

 

virtual void SetHeadersReceivedEventHandler (Aws::Http::HeadersReceivedEventHandler &&headersReceivedEventHandler)

 

virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)

 

virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)

 

virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)

 

virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)

 

virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)

 

virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)

 

virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)

 

virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)

 

virtual void SetHeadersReceivedEventHandler (const Aws::Http::HeadersReceivedEventHandler &headersReceivedEventHandler)

 

virtual void SetHeadersReceivedEventHandler (Aws::Http::HeadersReceivedEventHandler &&headersReceivedEventHandler)

 

virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)

 

virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)

 

virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)

 

virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)

 

virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)

 

virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)

 

virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)

 

virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)

 

Additional Inherited Members

Public Types inherited from Aws::Textract::TextractRequest

using EndpointParameter = Aws::Endpoint::EndpointParameter

 

using EndpointParameters = Aws::Endpoint::EndpointParameters

 

Public Types inherited from Aws::AmazonWebServiceRequest

typedef Aws::Vector< Aws::Endpoint::EndpointParameter > EndpointParameters

 

Protected Member Functions inherited from Aws::AmazonWebServiceRequest

virtual void DumpBodyToUrl (Aws::Http::URI &uri) const

 

Protected Attributes inherited from Aws::AmazonWebServiceRequest

Aws::Http::HeaderValueCollection m_additionalCustomHeaders

 

Detailed Description

Definition at line 26 of file AnalyzeDocumentRequest.h.

Constructor & Destructor Documentation

AnalyzeDocumentRequest()

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

default

Member Function Documentation

AdaptersConfigHasBeenSet()

bool Aws::Textract::Model::AnalyzeDocumentRequest::AdaptersConfigHasBeenSet ( ) const

inline

Specifies the adapter to be used when analyzing a document.

Definition at line 108 of file AnalyzeDocumentRequest.h.

AddFeatureTypes()

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. Add SIGNATURES to return the locations of detected signatures. Add LAYOUT to the list to return information about the layout of the document. 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 74 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, PNG, PDF, or TIFF 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 51 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. Add SIGNATURES to return the locations of detected signatures. Add LAYOUT to the list to return information about the layout of the document. 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 69 of file AnalyzeDocumentRequest.h.

GetAdaptersConfig()

const AdaptersConfig & Aws::Textract::Model::AnalyzeDocumentRequest::GetAdaptersConfig ( ) const

inline

Specifies the adapter to be used when analyzing a document.

Definition at line 107 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, PNG, PDF, or TIFF 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 50 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. Add SIGNATURES to return the locations of detected signatures. Add LAYOUT to the list to return information about the layout of the document. 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 68 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 82 of file AnalyzeDocumentRequest.h.

GetQueriesConfig()

const QueriesConfig & Aws::Textract::Model::AnalyzeDocumentRequest::GetQueriesConfig ( ) const

inline

Contains Queries and the alias for those Queries, as determined by the input.

Definition at line 95 of file AnalyzeDocumentRequest.h.

GetRequestSpecificHeaders()

AWS_TEXTRACT_API 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 35 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 83 of file AnalyzeDocumentRequest.h.

QueriesConfigHasBeenSet()

bool Aws::Textract::Model::AnalyzeDocumentRequest::QueriesConfigHasBeenSet ( ) const

inline

Contains Queries and the alias for those Queries, as determined by the input.

Definition at line 96 of file AnalyzeDocumentRequest.h.

SerializePayload()

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

overridevirtual

Implements Aws::AmazonSerializableWebServiceRequest.

SetAdaptersConfig()

template<typename AdaptersConfigT = AdaptersConfig>

void Aws::Textract::Model::AnalyzeDocumentRequest::SetAdaptersConfig ( AdaptersConfigT &&  value)

inline

Specifies the adapter to be used when analyzing a document.

Definition at line 110 of file AnalyzeDocumentRequest.h.

SetDocument()

template<typename DocumentT = Document>

void Aws::Textract::Model::AnalyzeDocumentRequest::SetDocument ( DocumentT &&  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, PNG, PDF, or TIFF 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 53 of file AnalyzeDocumentRequest.h.

SetFeatureTypes()

template<typename FeatureTypesT = Aws::Vector<FeatureType>>

void Aws::Textract::Model::AnalyzeDocumentRequest::SetFeatureTypes ( FeatureTypesT &&  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. Add SIGNATURES to return the locations of detected signatures. Add LAYOUT to the list to return information about the layout of the document. 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 71 of file AnalyzeDocumentRequest.h.

SetHumanLoopConfig()

template<typename HumanLoopConfigT = HumanLoopConfig>

void Aws::Textract::Model::AnalyzeDocumentRequest::SetHumanLoopConfig ( HumanLoopConfigT &&  value)

inline

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

Definition at line 85 of file AnalyzeDocumentRequest.h.

SetQueriesConfig()

template<typename QueriesConfigT = QueriesConfig>

void Aws::Textract::Model::AnalyzeDocumentRequest::SetQueriesConfig ( QueriesConfigT &&  value)

inline

Contains Queries and the alias for those Queries, as determined by the input.

Definition at line 98 of file AnalyzeDocumentRequest.h.

WithAdaptersConfig()

template<typename AdaptersConfigT = AdaptersConfig>

AnalyzeDocumentRequest & Aws::Textract::Model::AnalyzeDocumentRequest::WithAdaptersConfig ( AdaptersConfigT &&  value)

inline

Specifies the adapter to be used when analyzing a document.

Definition at line 112 of file AnalyzeDocumentRequest.h.

WithDocument()

template<typename DocumentT = Document>

AnalyzeDocumentRequest & Aws::Textract::Model::AnalyzeDocumentRequest::WithDocument ( DocumentT &&  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, PNG, PDF, or TIFF 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 55 of file AnalyzeDocumentRequest.h.

WithFeatureTypes()

template<typename FeatureTypesT = Aws::Vector<FeatureType>>

AnalyzeDocumentRequest & Aws::Textract::Model::AnalyzeDocumentRequest::WithFeatureTypes ( FeatureTypesT &&  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. Add SIGNATURES to return the locations of detected signatures. Add LAYOUT to the list to return information about the layout of the document. 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 73 of file AnalyzeDocumentRequest.h.

WithHumanLoopConfig()

template<typename HumanLoopConfigT = HumanLoopConfig>

AnalyzeDocumentRequest & Aws::Textract::Model::AnalyzeDocumentRequest::WithHumanLoopConfig ( HumanLoopConfigT &&  value)

inline

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

Definition at line 87 of file AnalyzeDocumentRequest.h.

WithQueriesConfig()

template<typename QueriesConfigT = QueriesConfig>

AnalyzeDocumentRequest & Aws::Textract::Model::AnalyzeDocumentRequest::WithQueriesConfig ( QueriesConfigT &&  value)

inline

Contains Queries and the alias for those Queries, as determined by the input.

Definition at line 100 of file AnalyzeDocumentRequest.h.

---

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

• generated/src/aws-cpp-sdk-textract/include/aws/textract/model/AnalyzeDocumentRequest.h