AWS SDK for C++  1.8.99
AWS SDK for C++
Public Member Functions | List of all members
Aws::Comprehend::Model::DetectEntitiesRequest Class Reference

#include <DetectEntitiesRequest.h>

+ Inheritance diagram for Aws::Comprehend::Model::DetectEntitiesRequest:

Public Member Functions

 DetectEntitiesRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetText () const
 
bool TextHasBeenSet () const
 
void SetText (const Aws::String &value)
 
void SetText (Aws::String &&value)
 
void SetText (const char *value)
 
DetectEntitiesRequestWithText (const Aws::String &value)
 
DetectEntitiesRequestWithText (Aws::String &&value)
 
DetectEntitiesRequestWithText (const char *value)
 
const LanguageCodeGetLanguageCode () const
 
bool LanguageCodeHasBeenSet () const
 
void SetLanguageCode (const LanguageCode &value)
 
void SetLanguageCode (LanguageCode &&value)
 
DetectEntitiesRequestWithLanguageCode (const LanguageCode &value)
 
DetectEntitiesRequestWithLanguageCode (LanguageCode &&value)
 
const Aws::StringGetEndpointArn () const
 
bool EndpointArnHasBeenSet () const
 
void SetEndpointArn (const Aws::String &value)
 
void SetEndpointArn (Aws::String &&value)
 
void SetEndpointArn (const char *value)
 
DetectEntitiesRequestWithEndpointArn (const Aws::String &value)
 
DetectEntitiesRequestWithEndpointArn (Aws::String &&value)
 
DetectEntitiesRequestWithEndpointArn (const char *value)
 
- Public Member Functions inherited from Aws::Comprehend::ComprehendRequest
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 ()
 
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 22 of file DetectEntitiesRequest.h.

Constructor & Destructor Documentation

◆ DetectEntitiesRequest()

Aws::Comprehend::Model::DetectEntitiesRequest::DetectEntitiesRequest ( )

Member Function Documentation

◆ EndpointArnHasBeenSet()

bool Aws::Comprehend::Model::DetectEntitiesRequest::EndpointArnHasBeenSet ( ) const
inline

The Amazon Resource Name of an endpoint that is associated with a custom entity recognition model. Provide an endpoint if you want to detect entities by using your own custom model instead of the default model that is used by Amazon Comprehend.

If you specify an endpoint, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you provide in your request.

Definition at line 160 of file DetectEntitiesRequest.h.

◆ GetEndpointArn()

const Aws::String& Aws::Comprehend::Model::DetectEntitiesRequest::GetEndpointArn ( ) const
inline

The Amazon Resource Name of an endpoint that is associated with a custom entity recognition model. Provide an endpoint if you want to detect entities by using your own custom model instead of the default model that is used by Amazon Comprehend.

If you specify an endpoint, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you provide in your request.

Definition at line 150 of file DetectEntitiesRequest.h.

◆ GetLanguageCode()

const LanguageCode& Aws::Comprehend::Model::DetectEntitiesRequest::GetLanguageCode ( ) const
inline

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

If your request includes the endpoint for a custom entity recognition model, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you specify here.

Definition at line 94 of file DetectEntitiesRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::Comprehend::Model::DetectEntitiesRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetServiceRequestName()

virtual const char* Aws::Comprehend::Model::DetectEntitiesRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 31 of file DetectEntitiesRequest.h.

◆ GetText()

const Aws::String& Aws::Comprehend::Model::DetectEntitiesRequest::GetText ( ) const
inline

A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.

Definition at line 42 of file DetectEntitiesRequest.h.

◆ LanguageCodeHasBeenSet()

bool Aws::Comprehend::Model::DetectEntitiesRequest::LanguageCodeHasBeenSet ( ) const
inline

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

If your request includes the endpoint for a custom entity recognition model, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you specify here.

Definition at line 103 of file DetectEntitiesRequest.h.

◆ SerializePayload()

Aws::String Aws::Comprehend::Model::DetectEntitiesRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetEndpointArn() [1/3]

void Aws::Comprehend::Model::DetectEntitiesRequest::SetEndpointArn ( const Aws::String value)
inline

The Amazon Resource Name of an endpoint that is associated with a custom entity recognition model. Provide an endpoint if you want to detect entities by using your own custom model instead of the default model that is used by Amazon Comprehend.

If you specify an endpoint, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you provide in your request.

Definition at line 170 of file DetectEntitiesRequest.h.

◆ SetEndpointArn() [2/3]

void Aws::Comprehend::Model::DetectEntitiesRequest::SetEndpointArn ( Aws::String &&  value)
inline

The Amazon Resource Name of an endpoint that is associated with a custom entity recognition model. Provide an endpoint if you want to detect entities by using your own custom model instead of the default model that is used by Amazon Comprehend.

If you specify an endpoint, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you provide in your request.

Definition at line 180 of file DetectEntitiesRequest.h.

◆ SetEndpointArn() [3/3]

void Aws::Comprehend::Model::DetectEntitiesRequest::SetEndpointArn ( const char *  value)
inline

The Amazon Resource Name of an endpoint that is associated with a custom entity recognition model. Provide an endpoint if you want to detect entities by using your own custom model instead of the default model that is used by Amazon Comprehend.

If you specify an endpoint, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you provide in your request.

Definition at line 190 of file DetectEntitiesRequest.h.

◆ SetLanguageCode() [1/2]

void Aws::Comprehend::Model::DetectEntitiesRequest::SetLanguageCode ( const LanguageCode value)
inline

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

If your request includes the endpoint for a custom entity recognition model, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you specify here.

Definition at line 112 of file DetectEntitiesRequest.h.

◆ SetLanguageCode() [2/2]

void Aws::Comprehend::Model::DetectEntitiesRequest::SetLanguageCode ( LanguageCode &&  value)
inline

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

If your request includes the endpoint for a custom entity recognition model, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you specify here.

Definition at line 121 of file DetectEntitiesRequest.h.

◆ SetText() [1/3]

void Aws::Comprehend::Model::DetectEntitiesRequest::SetText ( const Aws::String value)
inline

A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.

Definition at line 54 of file DetectEntitiesRequest.h.

◆ SetText() [2/3]

void Aws::Comprehend::Model::DetectEntitiesRequest::SetText ( Aws::String &&  value)
inline

A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.

Definition at line 60 of file DetectEntitiesRequest.h.

◆ SetText() [3/3]

void Aws::Comprehend::Model::DetectEntitiesRequest::SetText ( const char *  value)
inline

A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.

Definition at line 66 of file DetectEntitiesRequest.h.

◆ TextHasBeenSet()

bool Aws::Comprehend::Model::DetectEntitiesRequest::TextHasBeenSet ( ) const
inline

A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.

Definition at line 48 of file DetectEntitiesRequest.h.

◆ WithEndpointArn() [1/3]

DetectEntitiesRequest& Aws::Comprehend::Model::DetectEntitiesRequest::WithEndpointArn ( const Aws::String value)
inline

The Amazon Resource Name of an endpoint that is associated with a custom entity recognition model. Provide an endpoint if you want to detect entities by using your own custom model instead of the default model that is used by Amazon Comprehend.

If you specify an endpoint, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you provide in your request.

Definition at line 200 of file DetectEntitiesRequest.h.

◆ WithEndpointArn() [2/3]

DetectEntitiesRequest& Aws::Comprehend::Model::DetectEntitiesRequest::WithEndpointArn ( Aws::String &&  value)
inline

The Amazon Resource Name of an endpoint that is associated with a custom entity recognition model. Provide an endpoint if you want to detect entities by using your own custom model instead of the default model that is used by Amazon Comprehend.

If you specify an endpoint, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you provide in your request.

Definition at line 210 of file DetectEntitiesRequest.h.

◆ WithEndpointArn() [3/3]

DetectEntitiesRequest& Aws::Comprehend::Model::DetectEntitiesRequest::WithEndpointArn ( const char *  value)
inline

The Amazon Resource Name of an endpoint that is associated with a custom entity recognition model. Provide an endpoint if you want to detect entities by using your own custom model instead of the default model that is used by Amazon Comprehend.

If you specify an endpoint, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you provide in your request.

Definition at line 220 of file DetectEntitiesRequest.h.

◆ WithLanguageCode() [1/2]

DetectEntitiesRequest& Aws::Comprehend::Model::DetectEntitiesRequest::WithLanguageCode ( const LanguageCode value)
inline

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

If your request includes the endpoint for a custom entity recognition model, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you specify here.

Definition at line 130 of file DetectEntitiesRequest.h.

◆ WithLanguageCode() [2/2]

DetectEntitiesRequest& Aws::Comprehend::Model::DetectEntitiesRequest::WithLanguageCode ( LanguageCode &&  value)
inline

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

If your request includes the endpoint for a custom entity recognition model, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you specify here.

Definition at line 139 of file DetectEntitiesRequest.h.

◆ WithText() [1/3]

DetectEntitiesRequest& Aws::Comprehend::Model::DetectEntitiesRequest::WithText ( const Aws::String value)
inline

A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.

Definition at line 72 of file DetectEntitiesRequest.h.

◆ WithText() [2/3]

DetectEntitiesRequest& Aws::Comprehend::Model::DetectEntitiesRequest::WithText ( Aws::String &&  value)
inline

A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.

Definition at line 78 of file DetectEntitiesRequest.h.

◆ WithText() [3/3]

DetectEntitiesRequest& Aws::Comprehend::Model::DetectEntitiesRequest::WithText ( const char *  value)
inline

A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.

Definition at line 84 of file DetectEntitiesRequest.h.


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