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

#include <GetDocumentAnalysisRequest.h>

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

Public Member Functions

 GetDocumentAnalysisRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetJobId () const
 
bool JobIdHasBeenSet () const
 
void SetJobId (const Aws::String &value)
 
void SetJobId (Aws::String &&value)
 
void SetJobId (const char *value)
 
GetDocumentAnalysisRequestWithJobId (const Aws::String &value)
 
GetDocumentAnalysisRequestWithJobId (Aws::String &&value)
 
GetDocumentAnalysisRequestWithJobId (const char *value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
GetDocumentAnalysisRequestWithMaxResults (int value)
 
const Aws::StringGetNextToken () const
 
bool NextTokenHasBeenSet () const
 
void SetNextToken (const Aws::String &value)
 
void SetNextToken (Aws::String &&value)
 
void SetNextToken (const char *value)
 
GetDocumentAnalysisRequestWithNextToken (const Aws::String &value)
 
GetDocumentAnalysisRequestWithNextToken (Aws::String &&value)
 
GetDocumentAnalysisRequestWithNextToken (const char *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 21 of file GetDocumentAnalysisRequest.h.

Constructor & Destructor Documentation

◆ GetDocumentAnalysisRequest()

Aws::Textract::Model::GetDocumentAnalysisRequest::GetDocumentAnalysisRequest ( )

Member Function Documentation

◆ GetJobId()

const Aws::String& Aws::Textract::Model::GetDocumentAnalysisRequest::GetJobId ( ) const
inline

A unique identifier for the text-detection job. The JobId is returned from StartDocumentAnalysis. A JobId value is only valid for 7 days.

Definition at line 42 of file GetDocumentAnalysisRequest.h.

◆ GetMaxResults()

int Aws::Textract::Model::GetDocumentAnalysisRequest::GetMaxResults ( ) const
inline

The maximum number of results to return per paginated call. The largest value that you can specify is 1,000. If you specify a value greater than 1,000, a maximum of 1,000 results is returned. The default value is 1,000.

Definition at line 99 of file GetDocumentAnalysisRequest.h.

◆ GetNextToken()

const Aws::String& Aws::Textract::Model::GetDocumentAnalysisRequest::GetNextToken ( ) const
inline

If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a pagination token in the response. You can use this pagination token to retrieve the next set of blocks.

Definition at line 128 of file GetDocumentAnalysisRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::Textract::TextractRequest.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 30 of file GetDocumentAnalysisRequest.h.

◆ JobIdHasBeenSet()

bool Aws::Textract::Model::GetDocumentAnalysisRequest::JobIdHasBeenSet ( ) const
inline

A unique identifier for the text-detection job. The JobId is returned from StartDocumentAnalysis. A JobId value is only valid for 7 days.

Definition at line 49 of file GetDocumentAnalysisRequest.h.

◆ MaxResultsHasBeenSet()

bool Aws::Textract::Model::GetDocumentAnalysisRequest::MaxResultsHasBeenSet ( ) const
inline

The maximum number of results to return per paginated call. The largest value that you can specify is 1,000. If you specify a value greater than 1,000, a maximum of 1,000 results is returned. The default value is 1,000.

Definition at line 106 of file GetDocumentAnalysisRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::Textract::Model::GetDocumentAnalysisRequest::NextTokenHasBeenSet ( ) const
inline

If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a pagination token in the response. You can use this pagination token to retrieve the next set of blocks.

Definition at line 135 of file GetDocumentAnalysisRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetJobId() [1/3]

void Aws::Textract::Model::GetDocumentAnalysisRequest::SetJobId ( const Aws::String value)
inline

A unique identifier for the text-detection job. The JobId is returned from StartDocumentAnalysis. A JobId value is only valid for 7 days.

Definition at line 56 of file GetDocumentAnalysisRequest.h.

◆ SetJobId() [2/3]

void Aws::Textract::Model::GetDocumentAnalysisRequest::SetJobId ( Aws::String &&  value)
inline

A unique identifier for the text-detection job. The JobId is returned from StartDocumentAnalysis. A JobId value is only valid for 7 days.

Definition at line 63 of file GetDocumentAnalysisRequest.h.

◆ SetJobId() [3/3]

void Aws::Textract::Model::GetDocumentAnalysisRequest::SetJobId ( const char *  value)
inline

A unique identifier for the text-detection job. The JobId is returned from StartDocumentAnalysis. A JobId value is only valid for 7 days.

Definition at line 70 of file GetDocumentAnalysisRequest.h.

◆ SetMaxResults()

void Aws::Textract::Model::GetDocumentAnalysisRequest::SetMaxResults ( int  value)
inline

The maximum number of results to return per paginated call. The largest value that you can specify is 1,000. If you specify a value greater than 1,000, a maximum of 1,000 results is returned. The default value is 1,000.

Definition at line 113 of file GetDocumentAnalysisRequest.h.

◆ SetNextToken() [1/3]

void Aws::Textract::Model::GetDocumentAnalysisRequest::SetNextToken ( const Aws::String value)
inline

If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a pagination token in the response. You can use this pagination token to retrieve the next set of blocks.

Definition at line 142 of file GetDocumentAnalysisRequest.h.

◆ SetNextToken() [2/3]

void Aws::Textract::Model::GetDocumentAnalysisRequest::SetNextToken ( Aws::String &&  value)
inline

If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a pagination token in the response. You can use this pagination token to retrieve the next set of blocks.

Definition at line 149 of file GetDocumentAnalysisRequest.h.

◆ SetNextToken() [3/3]

void Aws::Textract::Model::GetDocumentAnalysisRequest::SetNextToken ( const char *  value)
inline

If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a pagination token in the response. You can use this pagination token to retrieve the next set of blocks.

Definition at line 156 of file GetDocumentAnalysisRequest.h.

◆ WithJobId() [1/3]

GetDocumentAnalysisRequest& Aws::Textract::Model::GetDocumentAnalysisRequest::WithJobId ( const Aws::String value)
inline

A unique identifier for the text-detection job. The JobId is returned from StartDocumentAnalysis. A JobId value is only valid for 7 days.

Definition at line 77 of file GetDocumentAnalysisRequest.h.

◆ WithJobId() [2/3]

GetDocumentAnalysisRequest& Aws::Textract::Model::GetDocumentAnalysisRequest::WithJobId ( Aws::String &&  value)
inline

A unique identifier for the text-detection job. The JobId is returned from StartDocumentAnalysis. A JobId value is only valid for 7 days.

Definition at line 84 of file GetDocumentAnalysisRequest.h.

◆ WithJobId() [3/3]

GetDocumentAnalysisRequest& Aws::Textract::Model::GetDocumentAnalysisRequest::WithJobId ( const char *  value)
inline

A unique identifier for the text-detection job. The JobId is returned from StartDocumentAnalysis. A JobId value is only valid for 7 days.

Definition at line 91 of file GetDocumentAnalysisRequest.h.

◆ WithMaxResults()

GetDocumentAnalysisRequest& Aws::Textract::Model::GetDocumentAnalysisRequest::WithMaxResults ( int  value)
inline

The maximum number of results to return per paginated call. The largest value that you can specify is 1,000. If you specify a value greater than 1,000, a maximum of 1,000 results is returned. The default value is 1,000.

Definition at line 120 of file GetDocumentAnalysisRequest.h.

◆ WithNextToken() [1/3]

GetDocumentAnalysisRequest& Aws::Textract::Model::GetDocumentAnalysisRequest::WithNextToken ( const Aws::String value)
inline

If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a pagination token in the response. You can use this pagination token to retrieve the next set of blocks.

Definition at line 163 of file GetDocumentAnalysisRequest.h.

◆ WithNextToken() [2/3]

GetDocumentAnalysisRequest& Aws::Textract::Model::GetDocumentAnalysisRequest::WithNextToken ( Aws::String &&  value)
inline

If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a pagination token in the response. You can use this pagination token to retrieve the next set of blocks.

Definition at line 170 of file GetDocumentAnalysisRequest.h.

◆ WithNextToken() [3/3]

GetDocumentAnalysisRequest& Aws::Textract::Model::GetDocumentAnalysisRequest::WithNextToken ( const char *  value)
inline

If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a pagination token in the response. You can use this pagination token to retrieve the next set of blocks.

Definition at line 177 of file GetDocumentAnalysisRequest.h.


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