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

#include <StartDocumentTextDetectionRequest.h>

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

Public Member Functions

 StartDocumentTextDetectionRequest ()
 
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)
 
StartDocumentTextDetectionRequestWithDocumentLocation (const DocumentLocation &value)
 
StartDocumentTextDetectionRequestWithDocumentLocation (DocumentLocation &&value)
 
const Aws::StringGetClientRequestToken () const
 
bool ClientRequestTokenHasBeenSet () const
 
void SetClientRequestToken (const Aws::String &value)
 
void SetClientRequestToken (Aws::String &&value)
 
void SetClientRequestToken (const char *value)
 
StartDocumentTextDetectionRequestWithClientRequestToken (const Aws::String &value)
 
StartDocumentTextDetectionRequestWithClientRequestToken (Aws::String &&value)
 
StartDocumentTextDetectionRequestWithClientRequestToken (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)
 
StartDocumentTextDetectionRequestWithJobTag (const Aws::String &value)
 
StartDocumentTextDetectionRequestWithJobTag (Aws::String &&value)
 
StartDocumentTextDetectionRequestWithJobTag (const char *value)
 
const NotificationChannelGetNotificationChannel () const
 
bool NotificationChannelHasBeenSet () const
 
void SetNotificationChannel (const NotificationChannel &value)
 
void SetNotificationChannel (NotificationChannel &&value)
 
StartDocumentTextDetectionRequestWithNotificationChannel (const NotificationChannel &value)
 
StartDocumentTextDetectionRequestWithNotificationChannel (NotificationChannel &&value)
 
const OutputConfigGetOutputConfig () const
 
bool OutputConfigHasBeenSet () const
 
void SetOutputConfig (const OutputConfig &value)
 
void SetOutputConfig (OutputConfig &&value)
 
StartDocumentTextDetectionRequestWithOutputConfig (const OutputConfig &value)
 
StartDocumentTextDetectionRequestWithOutputConfig (OutputConfig &&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 StartDocumentTextDetectionRequest.h.

Constructor & Destructor Documentation

◆ StartDocumentTextDetectionRequest()

Aws::Textract::Model::StartDocumentTextDetectionRequest::StartDocumentTextDetectionRequest ( )

Member Function Documentation

◆ ClientRequestTokenHasBeenSet()

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

The idempotent token that's used to identify the start request. If you use the same token with multiple StartDocumentTextDetection 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 91 of file StartDocumentTextDetectionRequest.h.

◆ DocumentLocationHasBeenSet()

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

The location of the document to be processed.

Definition at line 48 of file StartDocumentTextDetectionRequest.h.

◆ GetClientRequestToken()

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

The idempotent token that's used to identify the start request. If you use the same token with multiple StartDocumentTextDetection 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 80 of file StartDocumentTextDetectionRequest.h.

◆ GetDocumentLocation()

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

The location of the document to be processed.

Definition at line 43 of file StartDocumentTextDetectionRequest.h.

◆ GetJobTag()

const Aws::String& Aws::Textract::Model::StartDocumentTextDetectionRequest::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 166 of file StartDocumentTextDetectionRequest.h.

◆ GetNotificationChannel()

const NotificationChannel& Aws::Textract::Model::StartDocumentTextDetectionRequest::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 229 of file StartDocumentTextDetectionRequest.h.

◆ GetOutputConfig()

const OutputConfig& Aws::Textract::Model::StartDocumentTextDetectionRequest::GetOutputConfig ( ) const
inline

Sets if the output will go to a customer defined bucket. By default Amazon Textract will save the results internally to be accessed with the GetDocumentTextDetection operation.

Definition at line 267 of file StartDocumentTextDetectionRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::Textract::TextractRequest.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file StartDocumentTextDetectionRequest.h.

◆ JobTagHasBeenSet()

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

◆ NotificationChannelHasBeenSet()

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

◆ OutputConfigHasBeenSet()

bool Aws::Textract::Model::StartDocumentTextDetectionRequest::OutputConfigHasBeenSet ( ) const
inline

Sets if the output will go to a customer defined bucket. By default Amazon Textract will save the results internally to be accessed with the GetDocumentTextDetection operation.

Definition at line 274 of file StartDocumentTextDetectionRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetClientRequestToken() [1/3]

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

The idempotent token that's used to identify the start request. If you use the same token with multiple StartDocumentTextDetection 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 102 of file StartDocumentTextDetectionRequest.h.

◆ SetClientRequestToken() [2/3]

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

The idempotent token that's used to identify the start request. If you use the same token with multiple StartDocumentTextDetection 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 113 of file StartDocumentTextDetectionRequest.h.

◆ SetClientRequestToken() [3/3]

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

The idempotent token that's used to identify the start request. If you use the same token with multiple StartDocumentTextDetection 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 124 of file StartDocumentTextDetectionRequest.h.

◆ SetDocumentLocation() [1/2]

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

The location of the document to be processed.

Definition at line 53 of file StartDocumentTextDetectionRequest.h.

◆ SetDocumentLocation() [2/2]

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

The location of the document to be processed.

Definition at line 58 of file StartDocumentTextDetectionRequest.h.

◆ SetJobTag() [1/3]

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

◆ SetJobTag() [2/3]

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

◆ SetJobTag() [3/3]

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

◆ SetNotificationChannel() [1/2]

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

◆ SetNotificationChannel() [2/2]

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

◆ SetOutputConfig() [1/2]

void Aws::Textract::Model::StartDocumentTextDetectionRequest::SetOutputConfig ( const OutputConfig value)
inline

Sets if the output will go to a customer defined bucket. By default Amazon Textract will save the results internally to be accessed with the GetDocumentTextDetection operation.

Definition at line 281 of file StartDocumentTextDetectionRequest.h.

◆ SetOutputConfig() [2/2]

void Aws::Textract::Model::StartDocumentTextDetectionRequest::SetOutputConfig ( OutputConfig &&  value)
inline

Sets if the output will go to a customer defined bucket. By default Amazon Textract will save the results internally to be accessed with the GetDocumentTextDetection operation.

Definition at line 288 of file StartDocumentTextDetectionRequest.h.

◆ WithClientRequestToken() [1/3]

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

The idempotent token that's used to identify the start request. If you use the same token with multiple StartDocumentTextDetection 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 135 of file StartDocumentTextDetectionRequest.h.

◆ WithClientRequestToken() [2/3]

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

The idempotent token that's used to identify the start request. If you use the same token with multiple StartDocumentTextDetection 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 146 of file StartDocumentTextDetectionRequest.h.

◆ WithClientRequestToken() [3/3]

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

The idempotent token that's used to identify the start request. If you use the same token with multiple StartDocumentTextDetection 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 157 of file StartDocumentTextDetectionRequest.h.

◆ WithDocumentLocation() [1/2]

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

The location of the document to be processed.

Definition at line 63 of file StartDocumentTextDetectionRequest.h.

◆ WithDocumentLocation() [2/2]

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

The location of the document to be processed.

Definition at line 68 of file StartDocumentTextDetectionRequest.h.

◆ WithJobTag() [1/3]

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

◆ WithJobTag() [2/3]

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

◆ WithJobTag() [3/3]

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

◆ WithNotificationChannel() [1/2]

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

◆ WithNotificationChannel() [2/2]

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

◆ WithOutputConfig() [1/2]

StartDocumentTextDetectionRequest& Aws::Textract::Model::StartDocumentTextDetectionRequest::WithOutputConfig ( const OutputConfig value)
inline

Sets if the output will go to a customer defined bucket. By default Amazon Textract will save the results internally to be accessed with the GetDocumentTextDetection operation.

Definition at line 295 of file StartDocumentTextDetectionRequest.h.

◆ WithOutputConfig() [2/2]

StartDocumentTextDetectionRequest& Aws::Textract::Model::StartDocumentTextDetectionRequest::WithOutputConfig ( OutputConfig &&  value)
inline

Sets if the output will go to a customer defined bucket. By default Amazon Textract will save the results internally to be accessed with the GetDocumentTextDetection operation.

Definition at line 302 of file StartDocumentTextDetectionRequest.h.


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