Aws::Comprehend::ComprehendRequest Class Reference

#include <ComprehendRequest.h>

Inherits Aws::AmazonSerializableWebServiceRequest.

Inherited by Aws::Comprehend::Model::BatchDetectDominantLanguageRequest, Aws::Comprehend::Model::BatchDetectEntitiesRequest, Aws::Comprehend::Model::BatchDetectKeyPhrasesRequest, Aws::Comprehend::Model::BatchDetectSentimentRequest, Aws::Comprehend::Model::BatchDetectSyntaxRequest, Aws::Comprehend::Model::BatchDetectTargetedSentimentRequest, Aws::Comprehend::Model::ClassifyDocumentRequest, Aws::Comprehend::Model::ContainsPiiEntitiesRequest, Aws::Comprehend::Model::CreateDatasetRequest, Aws::Comprehend::Model::CreateDocumentClassifierRequest, Aws::Comprehend::Model::CreateEndpointRequest, Aws::Comprehend::Model::CreateEntityRecognizerRequest, Aws::Comprehend::Model::CreateFlywheelRequest, Aws::Comprehend::Model::DeleteDocumentClassifierRequest, Aws::Comprehend::Model::DeleteEndpointRequest, Aws::Comprehend::Model::DeleteEntityRecognizerRequest, Aws::Comprehend::Model::DeleteFlywheelRequest, Aws::Comprehend::Model::DeleteResourcePolicyRequest, Aws::Comprehend::Model::DescribeDatasetRequest, Aws::Comprehend::Model::DescribeDocumentClassificationJobRequest, Aws::Comprehend::Model::DescribeDocumentClassifierRequest, Aws::Comprehend::Model::DescribeDominantLanguageDetectionJobRequest, Aws::Comprehend::Model::DescribeEndpointRequest, Aws::Comprehend::Model::DescribeEntitiesDetectionJobRequest, Aws::Comprehend::Model::DescribeEntityRecognizerRequest, Aws::Comprehend::Model::DescribeEventsDetectionJobRequest, Aws::Comprehend::Model::DescribeFlywheelIterationRequest, Aws::Comprehend::Model::DescribeFlywheelRequest, Aws::Comprehend::Model::DescribeKeyPhrasesDetectionJobRequest, Aws::Comprehend::Model::DescribePiiEntitiesDetectionJobRequest, Aws::Comprehend::Model::DescribeResourcePolicyRequest, Aws::Comprehend::Model::DescribeSentimentDetectionJobRequest, Aws::Comprehend::Model::DescribeTargetedSentimentDetectionJobRequest, Aws::Comprehend::Model::DescribeTopicsDetectionJobRequest, Aws::Comprehend::Model::DetectDominantLanguageRequest, Aws::Comprehend::Model::DetectEntitiesRequest, Aws::Comprehend::Model::DetectKeyPhrasesRequest, Aws::Comprehend::Model::DetectPiiEntitiesRequest, Aws::Comprehend::Model::DetectSentimentRequest, Aws::Comprehend::Model::DetectSyntaxRequest, Aws::Comprehend::Model::DetectTargetedSentimentRequest, Aws::Comprehend::Model::DetectToxicContentRequest, Aws::Comprehend::Model::ImportModelRequest, Aws::Comprehend::Model::ListDatasetsRequest, Aws::Comprehend::Model::ListDocumentClassificationJobsRequest, Aws::Comprehend::Model::ListDocumentClassifierSummariesRequest, Aws::Comprehend::Model::ListDocumentClassifiersRequest, Aws::Comprehend::Model::ListDominantLanguageDetectionJobsRequest, Aws::Comprehend::Model::ListEndpointsRequest, Aws::Comprehend::Model::ListEntitiesDetectionJobsRequest, Aws::Comprehend::Model::ListEntityRecognizerSummariesRequest, Aws::Comprehend::Model::ListEntityRecognizersRequest, Aws::Comprehend::Model::ListEventsDetectionJobsRequest, Aws::Comprehend::Model::ListFlywheelIterationHistoryRequest, Aws::Comprehend::Model::ListFlywheelsRequest, Aws::Comprehend::Model::ListKeyPhrasesDetectionJobsRequest, Aws::Comprehend::Model::ListPiiEntitiesDetectionJobsRequest, Aws::Comprehend::Model::ListSentimentDetectionJobsRequest, Aws::Comprehend::Model::ListTagsForResourceRequest, Aws::Comprehend::Model::ListTargetedSentimentDetectionJobsRequest, Aws::Comprehend::Model::ListTopicsDetectionJobsRequest, Aws::Comprehend::Model::PutResourcePolicyRequest, Aws::Comprehend::Model::StartDocumentClassificationJobRequest, Aws::Comprehend::Model::StartDominantLanguageDetectionJobRequest, Aws::Comprehend::Model::StartEntitiesDetectionJobRequest, Aws::Comprehend::Model::StartEventsDetectionJobRequest, Aws::Comprehend::Model::StartFlywheelIterationRequest, Aws::Comprehend::Model::StartKeyPhrasesDetectionJobRequest, Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest, Aws::Comprehend::Model::StartSentimentDetectionJobRequest, Aws::Comprehend::Model::StartTargetedSentimentDetectionJobRequest, Aws::Comprehend::Model::StartTopicsDetectionJobRequest, Aws::Comprehend::Model::StopDominantLanguageDetectionJobRequest, Aws::Comprehend::Model::StopEntitiesDetectionJobRequest, Aws::Comprehend::Model::StopEventsDetectionJobRequest, Aws::Comprehend::Model::StopKeyPhrasesDetectionJobRequest, Aws::Comprehend::Model::StopPiiEntitiesDetectionJobRequest, Aws::Comprehend::Model::StopSentimentDetectionJobRequest, Aws::Comprehend::Model::StopTargetedSentimentDetectionJobRequest, Aws::Comprehend::Model::StopTrainingDocumentClassifierRequest, Aws::Comprehend::Model::StopTrainingEntityRecognizerRequest, Aws::Comprehend::Model::TagResourceRequest, Aws::Comprehend::Model::UntagResourceRequest, Aws::Comprehend::Model::UpdateEndpointRequest, and Aws::Comprehend::Model::UpdateFlywheelRequest.

Public Types

using EndpointParameter = Aws::Endpoint::EndpointParameter

 

using EndpointParameters = Aws::Endpoint::EndpointParameters

 

Public Types inherited from Aws::AmazonWebServiceRequest

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

 

Public Member Functions

virtual ~ComprehendRequest ()

 

void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const

 

Aws::Http::HeaderValueCollection GetHeaders () const override

 

Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest

 AmazonSerializableWebServiceRequest ()

 

virtual ~AmazonSerializableWebServiceRequest ()

 

virtual Aws::String SerializePayload () const=0

 

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 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 const char * GetServiceRequestName () const=0

 

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

 

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)

 

Protected Member Functions

virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const

 

Protected Member Functions inherited from Aws::AmazonWebServiceRequest

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

 

Additional Inherited Members

Protected Attributes inherited from Aws::AmazonWebServiceRequest

Aws::Http::HeaderValueCollection m_additionalCustomHeaders

 

Detailed Description

Definition at line 17 of file ComprehendRequest.h.

Member Typedef Documentation

EndpointParameter

using Aws::Comprehend::ComprehendRequest::EndpointParameter = Aws::Endpoint::EndpointParameter

Definition at line 20 of file ComprehendRequest.h.

EndpointParameters

using Aws::Comprehend::ComprehendRequest::EndpointParameters = Aws::Endpoint::EndpointParameters

Definition at line 21 of file ComprehendRequest.h.

Constructor & Destructor Documentation

~ComprehendRequest()

virtual Aws::Comprehend::ComprehendRequest::~ComprehendRequest ( )

inlinevirtual

Definition at line 23 of file ComprehendRequest.h.

Member Function Documentation

AddParametersToRequest()

void Aws::Comprehend::ComprehendRequest::AddParametersToRequest ( Aws::Http::HttpRequest &  httpRequest) const

inline

Definition at line 25 of file ComprehendRequest.h.

GetHeaders()

Aws::Http::HeaderValueCollection Aws::Comprehend::ComprehendRequest::GetHeaders ( ) const

inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 27 of file ComprehendRequest.h.

GetRequestSpecificHeaders()

virtual Aws::Http::HeaderValueCollection Aws::Comprehend::ComprehendRequest::GetRequestSpecificHeaders ( ) const

inlineprotectedvirtual

Reimplemented in Aws::Comprehend::Model::BatchDetectDominantLanguageRequest, Aws::Comprehend::Model::BatchDetectEntitiesRequest, Aws::Comprehend::Model::BatchDetectKeyPhrasesRequest, Aws::Comprehend::Model::BatchDetectSentimentRequest, Aws::Comprehend::Model::BatchDetectSyntaxRequest, Aws::Comprehend::Model::BatchDetectTargetedSentimentRequest, Aws::Comprehend::Model::ClassifyDocumentRequest, Aws::Comprehend::Model::ContainsPiiEntitiesRequest, Aws::Comprehend::Model::CreateDatasetRequest, Aws::Comprehend::Model::CreateDocumentClassifierRequest, Aws::Comprehend::Model::CreateEndpointRequest, Aws::Comprehend::Model::CreateEntityRecognizerRequest, Aws::Comprehend::Model::CreateFlywheelRequest, Aws::Comprehend::Model::DeleteDocumentClassifierRequest, Aws::Comprehend::Model::DeleteEndpointRequest, Aws::Comprehend::Model::DeleteEntityRecognizerRequest, Aws::Comprehend::Model::DeleteFlywheelRequest, Aws::Comprehend::Model::DeleteResourcePolicyRequest, Aws::Comprehend::Model::DescribeDatasetRequest, Aws::Comprehend::Model::DescribeDocumentClassificationJobRequest, Aws::Comprehend::Model::DescribeDocumentClassifierRequest, Aws::Comprehend::Model::DescribeDominantLanguageDetectionJobRequest, Aws::Comprehend::Model::DescribeEndpointRequest, Aws::Comprehend::Model::DescribeEntitiesDetectionJobRequest, Aws::Comprehend::Model::DescribeEntityRecognizerRequest, Aws::Comprehend::Model::DescribeEventsDetectionJobRequest, Aws::Comprehend::Model::DescribeFlywheelIterationRequest, Aws::Comprehend::Model::DescribeFlywheelRequest, Aws::Comprehend::Model::DescribeKeyPhrasesDetectionJobRequest, Aws::Comprehend::Model::DescribePiiEntitiesDetectionJobRequest, Aws::Comprehend::Model::DescribeResourcePolicyRequest, Aws::Comprehend::Model::DescribeSentimentDetectionJobRequest, Aws::Comprehend::Model::DescribeTargetedSentimentDetectionJobRequest, Aws::Comprehend::Model::DescribeTopicsDetectionJobRequest, Aws::Comprehend::Model::DetectDominantLanguageRequest, Aws::Comprehend::Model::DetectEntitiesRequest, Aws::Comprehend::Model::DetectKeyPhrasesRequest, Aws::Comprehend::Model::DetectPiiEntitiesRequest, Aws::Comprehend::Model::DetectSentimentRequest, Aws::Comprehend::Model::DetectSyntaxRequest, Aws::Comprehend::Model::DetectTargetedSentimentRequest, Aws::Comprehend::Model::DetectToxicContentRequest, Aws::Comprehend::Model::ImportModelRequest, Aws::Comprehend::Model::ListDatasetsRequest, Aws::Comprehend::Model::ListDocumentClassificationJobsRequest, Aws::Comprehend::Model::ListDocumentClassifiersRequest, Aws::Comprehend::Model::ListDocumentClassifierSummariesRequest, Aws::Comprehend::Model::ListDominantLanguageDetectionJobsRequest, Aws::Comprehend::Model::ListEndpointsRequest, Aws::Comprehend::Model::ListEntitiesDetectionJobsRequest, Aws::Comprehend::Model::ListEntityRecognizersRequest, Aws::Comprehend::Model::ListEntityRecognizerSummariesRequest, Aws::Comprehend::Model::ListEventsDetectionJobsRequest, Aws::Comprehend::Model::ListFlywheelIterationHistoryRequest, Aws::Comprehend::Model::ListFlywheelsRequest, Aws::Comprehend::Model::ListKeyPhrasesDetectionJobsRequest, Aws::Comprehend::Model::ListPiiEntitiesDetectionJobsRequest, Aws::Comprehend::Model::ListSentimentDetectionJobsRequest, Aws::Comprehend::Model::ListTagsForResourceRequest, Aws::Comprehend::Model::ListTargetedSentimentDetectionJobsRequest, Aws::Comprehend::Model::ListTopicsDetectionJobsRequest, Aws::Comprehend::Model::PutResourcePolicyRequest, Aws::Comprehend::Model::StartDocumentClassificationJobRequest, Aws::Comprehend::Model::StartDominantLanguageDetectionJobRequest, Aws::Comprehend::Model::StartEntitiesDetectionJobRequest, Aws::Comprehend::Model::StartEventsDetectionJobRequest, Aws::Comprehend::Model::StartFlywheelIterationRequest, Aws::Comprehend::Model::StartKeyPhrasesDetectionJobRequest, Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest, Aws::Comprehend::Model::StartSentimentDetectionJobRequest, Aws::Comprehend::Model::StartTargetedSentimentDetectionJobRequest, Aws::Comprehend::Model::StartTopicsDetectionJobRequest, Aws::Comprehend::Model::StopDominantLanguageDetectionJobRequest, Aws::Comprehend::Model::StopEntitiesDetectionJobRequest, Aws::Comprehend::Model::StopEventsDetectionJobRequest, Aws::Comprehend::Model::StopKeyPhrasesDetectionJobRequest, Aws::Comprehend::Model::StopPiiEntitiesDetectionJobRequest, Aws::Comprehend::Model::StopSentimentDetectionJobRequest, Aws::Comprehend::Model::StopTargetedSentimentDetectionJobRequest, Aws::Comprehend::Model::StopTrainingDocumentClassifierRequest, Aws::Comprehend::Model::StopTrainingEntityRecognizerRequest, Aws::Comprehend::Model::TagResourceRequest, Aws::Comprehend::Model::UntagResourceRequest, Aws::Comprehend::Model::UpdateEndpointRequest, and Aws::Comprehend::Model::UpdateFlywheelRequest.

Definition at line 40 of file ComprehendRequest.h.

---

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

• generated/src/aws-cpp-sdk-comprehend/include/aws/comprehend/ComprehendRequest.h