AWS SDK for C++  1.9.16
AWS SDK for C++
Public Member Functions | List of all members
Aws::Rekognition::Model::StartTextDetectionRequest Class Reference

#include <StartTextDetectionRequest.h>

+ Inheritance diagram for Aws::Rekognition::Model::StartTextDetectionRequest:

Public Member Functions

 StartTextDetectionRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const VideoGetVideo () const
 
bool VideoHasBeenSet () const
 
void SetVideo (const Video &value)
 
void SetVideo (Video &&value)
 
StartTextDetectionRequestWithVideo (const Video &value)
 
StartTextDetectionRequestWithVideo (Video &&value)
 
const Aws::StringGetClientRequestToken () const
 
bool ClientRequestTokenHasBeenSet () const
 
void SetClientRequestToken (const Aws::String &value)
 
void SetClientRequestToken (Aws::String &&value)
 
void SetClientRequestToken (const char *value)
 
StartTextDetectionRequestWithClientRequestToken (const Aws::String &value)
 
StartTextDetectionRequestWithClientRequestToken (Aws::String &&value)
 
StartTextDetectionRequestWithClientRequestToken (const char *value)
 
const NotificationChannelGetNotificationChannel () const
 
bool NotificationChannelHasBeenSet () const
 
void SetNotificationChannel (const NotificationChannel &value)
 
void SetNotificationChannel (NotificationChannel &&value)
 
StartTextDetectionRequestWithNotificationChannel (const NotificationChannel &value)
 
StartTextDetectionRequestWithNotificationChannel (NotificationChannel &&value)
 
const Aws::StringGetJobTag () const
 
bool JobTagHasBeenSet () const
 
void SetJobTag (const Aws::String &value)
 
void SetJobTag (Aws::String &&value)
 
void SetJobTag (const char *value)
 
StartTextDetectionRequestWithJobTag (const Aws::String &value)
 
StartTextDetectionRequestWithJobTag (Aws::String &&value)
 
StartTextDetectionRequestWithJobTag (const char *value)
 
const StartTextDetectionFiltersGetFilters () const
 
bool FiltersHasBeenSet () const
 
void SetFilters (const StartTextDetectionFilters &value)
 
void SetFilters (StartTextDetectionFilters &&value)
 
StartTextDetectionRequestWithFilters (const StartTextDetectionFilters &value)
 
StartTextDetectionRequestWithFilters (StartTextDetectionFilters &&value)
 
- Public Member Functions inherited from Aws::Rekognition::RekognitionRequest
virtual ~RekognitionRequest ()
 
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 StartTextDetectionRequest.h.

Constructor & Destructor Documentation

◆ StartTextDetectionRequest()

Aws::Rekognition::Model::StartTextDetectionRequest::StartTextDetectionRequest ( )

Member Function Documentation

◆ ClientRequestTokenHasBeenSet()

bool Aws::Rekognition::Model::StartTextDetectionRequest::ClientRequestTokenHasBeenSet ( ) const
inline

Idempotent token used to identify the start request. If you use the same token with multiple StartTextDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentaly started more than once.

Definition at line 73 of file StartTextDetectionRequest.h.

◆ FiltersHasBeenSet()

bool Aws::Rekognition::Model::StartTextDetectionRequest::FiltersHasBeenSet ( ) const
inline

Optional parameters that let you set criteria the text must meet to be included in your response.

Definition at line 210 of file StartTextDetectionRequest.h.

◆ GetClientRequestToken()

const Aws::String& Aws::Rekognition::Model::StartTextDetectionRequest::GetClientRequestToken ( ) const
inline

Idempotent token used to identify the start request. If you use the same token with multiple StartTextDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentaly started more than once.

Definition at line 65 of file StartTextDetectionRequest.h.

◆ GetFilters()

const StartTextDetectionFilters& Aws::Rekognition::Model::StartTextDetectionRequest::GetFilters ( ) const
inline

Optional parameters that let you set criteria the text must meet to be included in your response.

Definition at line 204 of file StartTextDetectionRequest.h.

◆ GetJobTag()

const Aws::String& Aws::Rekognition::Model::StartTextDetectionRequest::GetJobTag ( ) const
inline

An identifier returned in the completion status published by your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.

Definition at line 148 of file StartTextDetectionRequest.h.

◆ GetNotificationChannel()

const NotificationChannel& Aws::Rekognition::Model::StartTextDetectionRequest::GetNotificationChannel ( ) const
inline

Definition at line 125 of file StartTextDetectionRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::Rekognition::Model::StartTextDetectionRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetServiceRequestName()

virtual const char* Aws::Rekognition::Model::StartTextDetectionRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file StartTextDetectionRequest.h.

◆ GetVideo()

const Video& Aws::Rekognition::Model::StartTextDetectionRequest::GetVideo ( ) const
inline

Definition at line 41 of file StartTextDetectionRequest.h.

◆ JobTagHasBeenSet()

bool Aws::Rekognition::Model::StartTextDetectionRequest::JobTagHasBeenSet ( ) const
inline

An identifier returned in the completion status published by your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.

Definition at line 155 of file StartTextDetectionRequest.h.

◆ NotificationChannelHasBeenSet()

bool Aws::Rekognition::Model::StartTextDetectionRequest::NotificationChannelHasBeenSet ( ) const
inline

Definition at line 128 of file StartTextDetectionRequest.h.

◆ SerializePayload()

Aws::String Aws::Rekognition::Model::StartTextDetectionRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetClientRequestToken() [1/3]

void Aws::Rekognition::Model::StartTextDetectionRequest::SetClientRequestToken ( Aws::String &&  value)
inline

Idempotent token used to identify the start request. If you use the same token with multiple StartTextDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentaly started more than once.

Definition at line 89 of file StartTextDetectionRequest.h.

◆ SetClientRequestToken() [2/3]

void Aws::Rekognition::Model::StartTextDetectionRequest::SetClientRequestToken ( const Aws::String value)
inline

Idempotent token used to identify the start request. If you use the same token with multiple StartTextDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentaly started more than once.

Definition at line 81 of file StartTextDetectionRequest.h.

◆ SetClientRequestToken() [3/3]

void Aws::Rekognition::Model::StartTextDetectionRequest::SetClientRequestToken ( const char *  value)
inline

Idempotent token used to identify the start request. If you use the same token with multiple StartTextDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentaly started more than once.

Definition at line 97 of file StartTextDetectionRequest.h.

◆ SetFilters() [1/2]

void Aws::Rekognition::Model::StartTextDetectionRequest::SetFilters ( const StartTextDetectionFilters value)
inline

Optional parameters that let you set criteria the text must meet to be included in your response.

Definition at line 216 of file StartTextDetectionRequest.h.

◆ SetFilters() [2/2]

void Aws::Rekognition::Model::StartTextDetectionRequest::SetFilters ( StartTextDetectionFilters &&  value)
inline

Optional parameters that let you set criteria the text must meet to be included in your response.

Definition at line 222 of file StartTextDetectionRequest.h.

◆ SetJobTag() [1/3]

void Aws::Rekognition::Model::StartTextDetectionRequest::SetJobTag ( Aws::String &&  value)
inline

An identifier returned in the completion status published by your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.

Definition at line 169 of file StartTextDetectionRequest.h.

◆ SetJobTag() [2/3]

void Aws::Rekognition::Model::StartTextDetectionRequest::SetJobTag ( const Aws::String value)
inline

An identifier returned in the completion status published by your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.

Definition at line 162 of file StartTextDetectionRequest.h.

◆ SetJobTag() [3/3]

void Aws::Rekognition::Model::StartTextDetectionRequest::SetJobTag ( const char *  value)
inline

An identifier returned in the completion status published by your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.

Definition at line 176 of file StartTextDetectionRequest.h.

◆ SetNotificationChannel() [1/2]

void Aws::Rekognition::Model::StartTextDetectionRequest::SetNotificationChannel ( const NotificationChannel value)
inline

Definition at line 131 of file StartTextDetectionRequest.h.

◆ SetNotificationChannel() [2/2]

void Aws::Rekognition::Model::StartTextDetectionRequest::SetNotificationChannel ( NotificationChannel &&  value)
inline

Definition at line 134 of file StartTextDetectionRequest.h.

◆ SetVideo() [1/2]

void Aws::Rekognition::Model::StartTextDetectionRequest::SetVideo ( const Video value)
inline

Definition at line 47 of file StartTextDetectionRequest.h.

◆ SetVideo() [2/2]

void Aws::Rekognition::Model::StartTextDetectionRequest::SetVideo ( Video &&  value)
inline

Definition at line 50 of file StartTextDetectionRequest.h.

◆ VideoHasBeenSet()

bool Aws::Rekognition::Model::StartTextDetectionRequest::VideoHasBeenSet ( ) const
inline

Definition at line 44 of file StartTextDetectionRequest.h.

◆ WithClientRequestToken() [1/3]

StartTextDetectionRequest& Aws::Rekognition::Model::StartTextDetectionRequest::WithClientRequestToken ( Aws::String &&  value)
inline

Idempotent token used to identify the start request. If you use the same token with multiple StartTextDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentaly started more than once.

Definition at line 113 of file StartTextDetectionRequest.h.

◆ WithClientRequestToken() [2/3]

StartTextDetectionRequest& Aws::Rekognition::Model::StartTextDetectionRequest::WithClientRequestToken ( const Aws::String value)
inline

Idempotent token used to identify the start request. If you use the same token with multiple StartTextDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentaly started more than once.

Definition at line 105 of file StartTextDetectionRequest.h.

◆ WithClientRequestToken() [3/3]

StartTextDetectionRequest& Aws::Rekognition::Model::StartTextDetectionRequest::WithClientRequestToken ( const char *  value)
inline

Idempotent token used to identify the start request. If you use the same token with multiple StartTextDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentaly started more than once.

Definition at line 121 of file StartTextDetectionRequest.h.

◆ WithFilters() [1/2]

StartTextDetectionRequest& Aws::Rekognition::Model::StartTextDetectionRequest::WithFilters ( const StartTextDetectionFilters value)
inline

Optional parameters that let you set criteria the text must meet to be included in your response.

Definition at line 228 of file StartTextDetectionRequest.h.

◆ WithFilters() [2/2]

StartTextDetectionRequest& Aws::Rekognition::Model::StartTextDetectionRequest::WithFilters ( StartTextDetectionFilters &&  value)
inline

Optional parameters that let you set criteria the text must meet to be included in your response.

Definition at line 234 of file StartTextDetectionRequest.h.

◆ WithJobTag() [1/3]

StartTextDetectionRequest& Aws::Rekognition::Model::StartTextDetectionRequest::WithJobTag ( Aws::String &&  value)
inline

An identifier returned in the completion status published by your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.

Definition at line 190 of file StartTextDetectionRequest.h.

◆ WithJobTag() [2/3]

StartTextDetectionRequest& Aws::Rekognition::Model::StartTextDetectionRequest::WithJobTag ( const Aws::String value)
inline

An identifier returned in the completion status published by your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.

Definition at line 183 of file StartTextDetectionRequest.h.

◆ WithJobTag() [3/3]

StartTextDetectionRequest& Aws::Rekognition::Model::StartTextDetectionRequest::WithJobTag ( const char *  value)
inline

An identifier returned in the completion status published by your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.

Definition at line 197 of file StartTextDetectionRequest.h.

◆ WithNotificationChannel() [1/2]

StartTextDetectionRequest& Aws::Rekognition::Model::StartTextDetectionRequest::WithNotificationChannel ( const NotificationChannel value)
inline

Definition at line 137 of file StartTextDetectionRequest.h.

◆ WithNotificationChannel() [2/2]

StartTextDetectionRequest& Aws::Rekognition::Model::StartTextDetectionRequest::WithNotificationChannel ( NotificationChannel &&  value)
inline

Definition at line 140 of file StartTextDetectionRequest.h.

◆ WithVideo() [1/2]

StartTextDetectionRequest& Aws::Rekognition::Model::StartTextDetectionRequest::WithVideo ( const Video value)
inline

Definition at line 53 of file StartTextDetectionRequest.h.

◆ WithVideo() [2/2]

StartTextDetectionRequest& Aws::Rekognition::Model::StartTextDetectionRequest::WithVideo ( Video &&  value)
inline

Definition at line 56 of file StartTextDetectionRequest.h.


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