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

#include <StartDocumentAnalysisRequest.h>

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

Public Member Functions

 StartDocumentAnalysisRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const DocumentLocationGetDocumentLocation () const
 
bool DocumentLocationHasBeenSet () const
 
void SetDocumentLocation (const DocumentLocation &value)
 
void SetDocumentLocation (DocumentLocation &&value)
 
StartDocumentAnalysisRequestWithDocumentLocation (const DocumentLocation &value)
 
StartDocumentAnalysisRequestWithDocumentLocation (DocumentLocation &&value)
 
const Aws::Vector< FeatureType > & GetFeatureTypes () const
 
bool FeatureTypesHasBeenSet () const
 
void SetFeatureTypes (const Aws::Vector< FeatureType > &value)
 
void SetFeatureTypes (Aws::Vector< FeatureType > &&value)
 
StartDocumentAnalysisRequestWithFeatureTypes (const Aws::Vector< FeatureType > &value)
 
StartDocumentAnalysisRequestWithFeatureTypes (Aws::Vector< FeatureType > &&value)
 
StartDocumentAnalysisRequestAddFeatureTypes (const FeatureType &value)
 
StartDocumentAnalysisRequestAddFeatureTypes (FeatureType &&value)
 
const Aws::StringGetClientRequestToken () const
 
bool ClientRequestTokenHasBeenSet () const
 
void SetClientRequestToken (const Aws::String &value)
 
void SetClientRequestToken (Aws::String &&value)
 
void SetClientRequestToken (const char *value)
 
StartDocumentAnalysisRequestWithClientRequestToken (const Aws::String &value)
 
StartDocumentAnalysisRequestWithClientRequestToken (Aws::String &&value)
 
StartDocumentAnalysisRequestWithClientRequestToken (const char *value)
 
const Aws::StringGetJobTag () const
 
bool JobTagHasBeenSet () const
 
void SetJobTag (const Aws::String &value)
 
void SetJobTag (Aws::String &&value)
 
void SetJobTag (const char *value)
 
StartDocumentAnalysisRequestWithJobTag (const Aws::String &value)
 
StartDocumentAnalysisRequestWithJobTag (Aws::String &&value)
 
StartDocumentAnalysisRequestWithJobTag (const char *value)
 
const NotificationChannelGetNotificationChannel () const
 
bool NotificationChannelHasBeenSet () const
 
void SetNotificationChannel (const NotificationChannel &value)
 
void SetNotificationChannel (NotificationChannel &&value)
 
StartDocumentAnalysisRequestWithNotificationChannel (const NotificationChannel &value)
 
StartDocumentAnalysisRequestWithNotificationChannel (NotificationChannel &&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 25 of file StartDocumentAnalysisRequest.h.

Constructor & Destructor Documentation

◆ StartDocumentAnalysisRequest()

Aws::Textract::Model::StartDocumentAnalysisRequest::StartDocumentAnalysisRequest ( )

Member Function Documentation

◆ AddFeatureTypes() [1/2]

StartDocumentAnalysisRequest& Aws::Textract::Model::StartDocumentAnalysisRequest::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 140 of file StartDocumentAnalysisRequest.h.

◆ AddFeatureTypes() [2/2]

StartDocumentAnalysisRequest& Aws::Textract::Model::StartDocumentAnalysisRequest::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 150 of file StartDocumentAnalysisRequest.h.

◆ ClientRequestTokenHasBeenSet()

bool Aws::Textract::Model::StartDocumentAnalysisRequest::ClientRequestTokenHasBeenSet ( ) const
inline

The idempotent token that you use to identify the start request. If you use the same token with multiple StartDocumentAnalysis requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentally started more than once. For more information, see Calling Amazon Textract Asynchronous Operations.

Definition at line 173 of file StartDocumentAnalysisRequest.h.

◆ DocumentLocationHasBeenSet()

bool Aws::Textract::Model::StartDocumentAnalysisRequest::DocumentLocationHasBeenSet ( ) const
inline

The location of the document to be processed.

Definition at line 49 of file StartDocumentAnalysisRequest.h.

◆ FeatureTypesHasBeenSet()

bool Aws::Textract::Model::StartDocumentAnalysisRequest::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 90 of file StartDocumentAnalysisRequest.h.

◆ GetClientRequestToken()

const Aws::String& Aws::Textract::Model::StartDocumentAnalysisRequest::GetClientRequestToken ( ) const
inline

The idempotent token that you use to identify the start request. If you use the same token with multiple StartDocumentAnalysis requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentally started more than once. For more information, see Calling Amazon Textract Asynchronous Operations.

Definition at line 162 of file StartDocumentAnalysisRequest.h.

◆ GetDocumentLocation()

const DocumentLocation& Aws::Textract::Model::StartDocumentAnalysisRequest::GetDocumentLocation ( ) const
inline

The location of the document to be processed.

Definition at line 44 of file StartDocumentAnalysisRequest.h.

◆ GetFeatureTypes()

const Aws::Vector<FeatureType>& Aws::Textract::Model::StartDocumentAnalysisRequest::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 80 of file StartDocumentAnalysisRequest.h.

◆ GetJobTag()

const Aws::String& Aws::Textract::Model::StartDocumentAnalysisRequest::GetJobTag ( ) const
inline

An identifier that you specify that's included in the completion notification published to the Amazon SNS topic. For example, you can use JobTag to identify the type of document that the completion notification corresponds to (such as a tax form or a receipt).

Definition at line 248 of file StartDocumentAnalysisRequest.h.

◆ GetNotificationChannel()

const NotificationChannel& Aws::Textract::Model::StartDocumentAnalysisRequest::GetNotificationChannel ( ) const
inline

The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.

Definition at line 311 of file StartDocumentAnalysisRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::Textract::TextractRequest.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file StartDocumentAnalysisRequest.h.

◆ JobTagHasBeenSet()

bool Aws::Textract::Model::StartDocumentAnalysisRequest::JobTagHasBeenSet ( ) const
inline

An identifier that you specify that's included in the completion notification published to the Amazon SNS topic. For example, you can use JobTag to identify the type of document that the completion notification corresponds to (such as a tax form or a receipt).

Definition at line 256 of file StartDocumentAnalysisRequest.h.

◆ NotificationChannelHasBeenSet()

bool Aws::Textract::Model::StartDocumentAnalysisRequest::NotificationChannelHasBeenSet ( ) const
inline

The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.

Definition at line 317 of file StartDocumentAnalysisRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetClientRequestToken() [1/3]

void Aws::Textract::Model::StartDocumentAnalysisRequest::SetClientRequestToken ( const Aws::String value)
inline

The idempotent token that you use to identify the start request. If you use the same token with multiple StartDocumentAnalysis requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentally started more than once. For more information, see Calling Amazon Textract Asynchronous Operations.

Definition at line 184 of file StartDocumentAnalysisRequest.h.

◆ SetClientRequestToken() [2/3]

void Aws::Textract::Model::StartDocumentAnalysisRequest::SetClientRequestToken ( Aws::String &&  value)
inline

The idempotent token that you use to identify the start request. If you use the same token with multiple StartDocumentAnalysis requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentally started more than once. For more information, see Calling Amazon Textract Asynchronous Operations.

Definition at line 195 of file StartDocumentAnalysisRequest.h.

◆ SetClientRequestToken() [3/3]

void Aws::Textract::Model::StartDocumentAnalysisRequest::SetClientRequestToken ( const char *  value)
inline

The idempotent token that you use to identify the start request. If you use the same token with multiple StartDocumentAnalysis requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentally started more than once. For more information, see Calling Amazon Textract Asynchronous Operations.

Definition at line 206 of file StartDocumentAnalysisRequest.h.

◆ SetDocumentLocation() [1/2]

void Aws::Textract::Model::StartDocumentAnalysisRequest::SetDocumentLocation ( const DocumentLocation value)
inline

The location of the document to be processed.

Definition at line 54 of file StartDocumentAnalysisRequest.h.

◆ SetDocumentLocation() [2/2]

void Aws::Textract::Model::StartDocumentAnalysisRequest::SetDocumentLocation ( DocumentLocation &&  value)
inline

The location of the document to be processed.

Definition at line 59 of file StartDocumentAnalysisRequest.h.

◆ SetFeatureTypes() [1/2]

void Aws::Textract::Model::StartDocumentAnalysisRequest::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 100 of file StartDocumentAnalysisRequest.h.

◆ SetFeatureTypes() [2/2]

void Aws::Textract::Model::StartDocumentAnalysisRequest::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 110 of file StartDocumentAnalysisRequest.h.

◆ SetJobTag() [1/3]

void Aws::Textract::Model::StartDocumentAnalysisRequest::SetJobTag ( const Aws::String value)
inline

An identifier that you specify that's included in the completion notification published to the Amazon SNS topic. For example, you can use JobTag to identify the type of document that the completion notification corresponds to (such as a tax form or a receipt).

Definition at line 264 of file StartDocumentAnalysisRequest.h.

◆ SetJobTag() [2/3]

void Aws::Textract::Model::StartDocumentAnalysisRequest::SetJobTag ( Aws::String &&  value)
inline

An identifier that you specify that's included in the completion notification published to the Amazon SNS topic. For example, you can use JobTag to identify the type of document that the completion notification corresponds to (such as a tax form or a receipt).

Definition at line 272 of file StartDocumentAnalysisRequest.h.

◆ SetJobTag() [3/3]

void Aws::Textract::Model::StartDocumentAnalysisRequest::SetJobTag ( const char *  value)
inline

An identifier that you specify that's included in the completion notification published to the Amazon SNS topic. For example, you can use JobTag to identify the type of document that the completion notification corresponds to (such as a tax form or a receipt).

Definition at line 280 of file StartDocumentAnalysisRequest.h.

◆ SetNotificationChannel() [1/2]

void Aws::Textract::Model::StartDocumentAnalysisRequest::SetNotificationChannel ( const NotificationChannel value)
inline

The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.

Definition at line 323 of file StartDocumentAnalysisRequest.h.

◆ SetNotificationChannel() [2/2]

void Aws::Textract::Model::StartDocumentAnalysisRequest::SetNotificationChannel ( NotificationChannel &&  value)
inline

The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.

Definition at line 329 of file StartDocumentAnalysisRequest.h.

◆ WithClientRequestToken() [1/3]

StartDocumentAnalysisRequest& Aws::Textract::Model::StartDocumentAnalysisRequest::WithClientRequestToken ( const Aws::String value)
inline

The idempotent token that you use to identify the start request. If you use the same token with multiple StartDocumentAnalysis requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentally started more than once. For more information, see Calling Amazon Textract Asynchronous Operations.

Definition at line 217 of file StartDocumentAnalysisRequest.h.

◆ WithClientRequestToken() [2/3]

StartDocumentAnalysisRequest& Aws::Textract::Model::StartDocumentAnalysisRequest::WithClientRequestToken ( Aws::String &&  value)
inline

The idempotent token that you use to identify the start request. If you use the same token with multiple StartDocumentAnalysis requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentally started more than once. For more information, see Calling Amazon Textract Asynchronous Operations.

Definition at line 228 of file StartDocumentAnalysisRequest.h.

◆ WithClientRequestToken() [3/3]

StartDocumentAnalysisRequest& Aws::Textract::Model::StartDocumentAnalysisRequest::WithClientRequestToken ( const char *  value)
inline

The idempotent token that you use to identify the start request. If you use the same token with multiple StartDocumentAnalysis requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentally started more than once. For more information, see Calling Amazon Textract Asynchronous Operations.

Definition at line 239 of file StartDocumentAnalysisRequest.h.

◆ WithDocumentLocation() [1/2]

StartDocumentAnalysisRequest& Aws::Textract::Model::StartDocumentAnalysisRequest::WithDocumentLocation ( const DocumentLocation value)
inline

The location of the document to be processed.

Definition at line 64 of file StartDocumentAnalysisRequest.h.

◆ WithDocumentLocation() [2/2]

StartDocumentAnalysisRequest& Aws::Textract::Model::StartDocumentAnalysisRequest::WithDocumentLocation ( DocumentLocation &&  value)
inline

The location of the document to be processed.

Definition at line 69 of file StartDocumentAnalysisRequest.h.

◆ WithFeatureTypes() [1/2]

StartDocumentAnalysisRequest& Aws::Textract::Model::StartDocumentAnalysisRequest::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 120 of file StartDocumentAnalysisRequest.h.

◆ WithFeatureTypes() [2/2]

StartDocumentAnalysisRequest& Aws::Textract::Model::StartDocumentAnalysisRequest::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 130 of file StartDocumentAnalysisRequest.h.

◆ WithJobTag() [1/3]

StartDocumentAnalysisRequest& Aws::Textract::Model::StartDocumentAnalysisRequest::WithJobTag ( const Aws::String value)
inline

An identifier that you specify that's included in the completion notification published to the Amazon SNS topic. For example, you can use JobTag to identify the type of document that the completion notification corresponds to (such as a tax form or a receipt).

Definition at line 288 of file StartDocumentAnalysisRequest.h.

◆ WithJobTag() [2/3]

StartDocumentAnalysisRequest& Aws::Textract::Model::StartDocumentAnalysisRequest::WithJobTag ( Aws::String &&  value)
inline

An identifier that you specify that's included in the completion notification published to the Amazon SNS topic. For example, you can use JobTag to identify the type of document that the completion notification corresponds to (such as a tax form or a receipt).

Definition at line 296 of file StartDocumentAnalysisRequest.h.

◆ WithJobTag() [3/3]

StartDocumentAnalysisRequest& Aws::Textract::Model::StartDocumentAnalysisRequest::WithJobTag ( const char *  value)
inline

An identifier that you specify that's included in the completion notification published to the Amazon SNS topic. For example, you can use JobTag to identify the type of document that the completion notification corresponds to (such as a tax form or a receipt).

Definition at line 304 of file StartDocumentAnalysisRequest.h.

◆ WithNotificationChannel() [1/2]

StartDocumentAnalysisRequest& Aws::Textract::Model::StartDocumentAnalysisRequest::WithNotificationChannel ( const NotificationChannel value)
inline

The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.

Definition at line 335 of file StartDocumentAnalysisRequest.h.

◆ WithNotificationChannel() [2/2]

StartDocumentAnalysisRequest& Aws::Textract::Model::StartDocumentAnalysisRequest::WithNotificationChannel ( NotificationChannel &&  value)
inline

The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.

Definition at line 341 of file StartDocumentAnalysisRequest.h.


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