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

#include <StartSegmentDetectionRequest.h>

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

Public Member Functions

 StartSegmentDetectionRequest ()
 
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)
 
StartSegmentDetectionRequestWithVideo (const Video &value)
 
StartSegmentDetectionRequestWithVideo (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)
 
StartSegmentDetectionRequestWithClientRequestToken (const Aws::String &value)
 
StartSegmentDetectionRequestWithClientRequestToken (Aws::String &&value)
 
StartSegmentDetectionRequestWithClientRequestToken (const char *value)
 
const NotificationChannelGetNotificationChannel () const
 
bool NotificationChannelHasBeenSet () const
 
void SetNotificationChannel (const NotificationChannel &value)
 
void SetNotificationChannel (NotificationChannel &&value)
 
StartSegmentDetectionRequestWithNotificationChannel (const NotificationChannel &value)
 
StartSegmentDetectionRequestWithNotificationChannel (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)
 
StartSegmentDetectionRequestWithJobTag (const Aws::String &value)
 
StartSegmentDetectionRequestWithJobTag (Aws::String &&value)
 
StartSegmentDetectionRequestWithJobTag (const char *value)
 
const StartSegmentDetectionFiltersGetFilters () const
 
bool FiltersHasBeenSet () const
 
void SetFilters (const StartSegmentDetectionFilters &value)
 
void SetFilters (StartSegmentDetectionFilters &&value)
 
StartSegmentDetectionRequestWithFilters (const StartSegmentDetectionFilters &value)
 
StartSegmentDetectionRequestWithFilters (StartSegmentDetectionFilters &&value)
 
const Aws::Vector< SegmentType > & GetSegmentTypes () const
 
bool SegmentTypesHasBeenSet () const
 
void SetSegmentTypes (const Aws::Vector< SegmentType > &value)
 
void SetSegmentTypes (Aws::Vector< SegmentType > &&value)
 
StartSegmentDetectionRequestWithSegmentTypes (const Aws::Vector< SegmentType > &value)
 
StartSegmentDetectionRequestWithSegmentTypes (Aws::Vector< SegmentType > &&value)
 
StartSegmentDetectionRequestAddSegmentTypes (const SegmentType &value)
 
StartSegmentDetectionRequestAddSegmentTypes (SegmentType &&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 26 of file StartSegmentDetectionRequest.h.

Constructor & Destructor Documentation

◆ StartSegmentDetectionRequest()

Aws::Rekognition::Model::StartSegmentDetectionRequest::StartSegmentDetectionRequest ( )

Member Function Documentation

◆ AddSegmentTypes() [1/2]

StartSegmentDetectionRequest& Aws::Rekognition::Model::StartSegmentDetectionRequest::AddSegmentTypes ( const SegmentType value)
inline

An array of segment types to detect in the video. Valid values are TECHNICAL_CUE and SHOT.

Definition at line 299 of file StartSegmentDetectionRequest.h.

◆ AddSegmentTypes() [2/2]

StartSegmentDetectionRequest& Aws::Rekognition::Model::StartSegmentDetectionRequest::AddSegmentTypes ( SegmentType &&  value)
inline

An array of segment types to detect in the video. Valid values are TECHNICAL_CUE and SHOT.

Definition at line 305 of file StartSegmentDetectionRequest.h.

◆ ClientRequestTokenHasBeenSet()

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

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

Definition at line 75 of file StartSegmentDetectionRequest.h.

◆ FiltersHasBeenSet()

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

Filters for technical cue or shot detection.

Definition at line 236 of file StartSegmentDetectionRequest.h.

◆ GetClientRequestToken()

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

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

Definition at line 67 of file StartSegmentDetectionRequest.h.

◆ GetFilters()

const StartSegmentDetectionFilters& Aws::Rekognition::Model::StartSegmentDetectionRequest::GetFilters ( ) const
inline

Filters for technical cue or shot detection.

Definition at line 231 of file StartSegmentDetectionRequest.h.

◆ GetJobTag()

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

An identifier you specify that's returned in the completion notification that's published to 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 StartSegmentDetectionRequest.h.

◆ GetNotificationChannel()

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

The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the segment detection operation.

Definition at line 130 of file StartSegmentDetectionRequest.h.

◆ GetRequestSpecificHeaders()

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

◆ GetSegmentTypes()

const Aws::Vector<SegmentType>& Aws::Rekognition::Model::StartSegmentDetectionRequest::GetSegmentTypes ( ) const
inline

An array of segment types to detect in the video. Valid values are TECHNICAL_CUE and SHOT.

Definition at line 263 of file StartSegmentDetectionRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 35 of file StartSegmentDetectionRequest.h.

◆ GetVideo()

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

Definition at line 43 of file StartSegmentDetectionRequest.h.

◆ JobTagHasBeenSet()

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

An identifier you specify that's returned in the completion notification that's published to 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 177 of file StartSegmentDetectionRequest.h.

◆ NotificationChannelHasBeenSet()

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

The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the segment detection operation.

Definition at line 136 of file StartSegmentDetectionRequest.h.

◆ SegmentTypesHasBeenSet()

bool Aws::Rekognition::Model::StartSegmentDetectionRequest::SegmentTypesHasBeenSet ( ) const
inline

An array of segment types to detect in the video. Valid values are TECHNICAL_CUE and SHOT.

Definition at line 269 of file StartSegmentDetectionRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetClientRequestToken() [1/3]

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

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

Definition at line 91 of file StartSegmentDetectionRequest.h.

◆ SetClientRequestToken() [2/3]

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

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

Definition at line 83 of file StartSegmentDetectionRequest.h.

◆ SetClientRequestToken() [3/3]

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

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

Definition at line 99 of file StartSegmentDetectionRequest.h.

◆ SetFilters() [1/2]

void Aws::Rekognition::Model::StartSegmentDetectionRequest::SetFilters ( const StartSegmentDetectionFilters value)
inline

Filters for technical cue or shot detection.

Definition at line 241 of file StartSegmentDetectionRequest.h.

◆ SetFilters() [2/2]

void Aws::Rekognition::Model::StartSegmentDetectionRequest::SetFilters ( StartSegmentDetectionFilters &&  value)
inline

Filters for technical cue or shot detection.

Definition at line 246 of file StartSegmentDetectionRequest.h.

◆ SetJobTag() [1/3]

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

An identifier you specify that's returned in the completion notification that's published to 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 193 of file StartSegmentDetectionRequest.h.

◆ SetJobTag() [2/3]

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

An identifier you specify that's returned in the completion notification that's published to 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 185 of file StartSegmentDetectionRequest.h.

◆ SetJobTag() [3/3]

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

An identifier you specify that's returned in the completion notification that's published to 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 201 of file StartSegmentDetectionRequest.h.

◆ SetNotificationChannel() [1/2]

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

The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the segment detection operation.

Definition at line 142 of file StartSegmentDetectionRequest.h.

◆ SetNotificationChannel() [2/2]

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

The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the segment detection operation.

Definition at line 148 of file StartSegmentDetectionRequest.h.

◆ SetSegmentTypes() [1/2]

void Aws::Rekognition::Model::StartSegmentDetectionRequest::SetSegmentTypes ( Aws::Vector< SegmentType > &&  value)
inline

An array of segment types to detect in the video. Valid values are TECHNICAL_CUE and SHOT.

Definition at line 281 of file StartSegmentDetectionRequest.h.

◆ SetSegmentTypes() [2/2]

void Aws::Rekognition::Model::StartSegmentDetectionRequest::SetSegmentTypes ( const Aws::Vector< SegmentType > &  value)
inline

An array of segment types to detect in the video. Valid values are TECHNICAL_CUE and SHOT.

Definition at line 275 of file StartSegmentDetectionRequest.h.

◆ SetVideo() [1/2]

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

Definition at line 49 of file StartSegmentDetectionRequest.h.

◆ SetVideo() [2/2]

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

Definition at line 52 of file StartSegmentDetectionRequest.h.

◆ VideoHasBeenSet()

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

Definition at line 46 of file StartSegmentDetectionRequest.h.

◆ WithClientRequestToken() [1/3]

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

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

Definition at line 115 of file StartSegmentDetectionRequest.h.

◆ WithClientRequestToken() [2/3]

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

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

Definition at line 107 of file StartSegmentDetectionRequest.h.

◆ WithClientRequestToken() [3/3]

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

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

Definition at line 123 of file StartSegmentDetectionRequest.h.

◆ WithFilters() [1/2]

StartSegmentDetectionRequest& Aws::Rekognition::Model::StartSegmentDetectionRequest::WithFilters ( const StartSegmentDetectionFilters value)
inline

Filters for technical cue or shot detection.

Definition at line 251 of file StartSegmentDetectionRequest.h.

◆ WithFilters() [2/2]

StartSegmentDetectionRequest& Aws::Rekognition::Model::StartSegmentDetectionRequest::WithFilters ( StartSegmentDetectionFilters &&  value)
inline

Filters for technical cue or shot detection.

Definition at line 256 of file StartSegmentDetectionRequest.h.

◆ WithJobTag() [1/3]

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

An identifier you specify that's returned in the completion notification that's published to 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 217 of file StartSegmentDetectionRequest.h.

◆ WithJobTag() [2/3]

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

An identifier you specify that's returned in the completion notification that's published to 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 209 of file StartSegmentDetectionRequest.h.

◆ WithJobTag() [3/3]

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

An identifier you specify that's returned in the completion notification that's published to 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 225 of file StartSegmentDetectionRequest.h.

◆ WithNotificationChannel() [1/2]

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

The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the segment detection operation.

Definition at line 154 of file StartSegmentDetectionRequest.h.

◆ WithNotificationChannel() [2/2]

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

The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the segment detection operation.

Definition at line 160 of file StartSegmentDetectionRequest.h.

◆ WithSegmentTypes() [1/2]

StartSegmentDetectionRequest& Aws::Rekognition::Model::StartSegmentDetectionRequest::WithSegmentTypes ( Aws::Vector< SegmentType > &&  value)
inline

An array of segment types to detect in the video. Valid values are TECHNICAL_CUE and SHOT.

Definition at line 293 of file StartSegmentDetectionRequest.h.

◆ WithSegmentTypes() [2/2]

StartSegmentDetectionRequest& Aws::Rekognition::Model::StartSegmentDetectionRequest::WithSegmentTypes ( const Aws::Vector< SegmentType > &  value)
inline

An array of segment types to detect in the video. Valid values are TECHNICAL_CUE and SHOT.

Definition at line 287 of file StartSegmentDetectionRequest.h.

◆ WithVideo() [1/2]

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

Definition at line 55 of file StartSegmentDetectionRequest.h.

◆ WithVideo() [2/2]

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

Definition at line 58 of file StartSegmentDetectionRequest.h.


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