AWS SDK for C++

AWS SDK for C++ Version 1.11.606

Loading...
Searching...
No Matches
StartTranscriptionJobRequest.h
1
6#pragma once
7#include <aws/transcribe/TranscribeService_EXPORTS.h>
8#include <aws/transcribe/TranscribeServiceRequest.h>
9#include <aws/core/utils/memory/stl/AWSString.h>
10#include <aws/transcribe/model/LanguageCode.h>
11#include <aws/transcribe/model/MediaFormat.h>
12#include <aws/transcribe/model/Media.h>
13#include <aws/core/utils/memory/stl/AWSMap.h>
14#include <aws/transcribe/model/Settings.h>
15#include <aws/transcribe/model/ModelSettings.h>
16#include <aws/transcribe/model/JobExecutionSettings.h>
17#include <aws/transcribe/model/ContentRedaction.h>
18#include <aws/core/utils/memory/stl/AWSVector.h>
19#include <aws/transcribe/model/Subtitles.h>
20#include <aws/transcribe/model/Tag.h>
21#include <aws/transcribe/model/LanguageIdSettings.h>
22#include <aws/transcribe/model/ToxicityDetectionSettings.h>
23#include <utility>
24
25namespace Aws
26{
27namespace TranscribeService
28{
29namespace Model
30{
31
35 {
36 public:
37 AWS_TRANSCRIBESERVICE_API StartTranscriptionJobRequest() = default;
38
39 // Service request name is the Operation name which will send this request out,
40 // each operation should has unique request name, so that we can get operation's name from this request.
41 // Note: this is not true for response, multiple operations may have the same response name,
42 // so we can not get operation's name from response.
43 inline virtual const char* GetServiceRequestName() const override { return "StartTranscriptionJob"; }
44
45 AWS_TRANSCRIBESERVICE_API Aws::String SerializePayload() const override;
46
47 AWS_TRANSCRIBESERVICE_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override;
48
49
51
60 inline const Aws::String& GetTranscriptionJobName() const { return m_transcriptionJobName; }
61 inline bool TranscriptionJobNameHasBeenSet() const { return m_transcriptionJobNameHasBeenSet; }
62 template<typename TranscriptionJobNameT = Aws::String>
63 void SetTranscriptionJobName(TranscriptionJobNameT&& value) { m_transcriptionJobNameHasBeenSet = true; m_transcriptionJobName = std::forward<TranscriptionJobNameT>(value); }
64 template<typename TranscriptionJobNameT = Aws::String>
65 StartTranscriptionJobRequest& WithTranscriptionJobName(TranscriptionJobNameT&& value) { SetTranscriptionJobName(std::forward<TranscriptionJobNameT>(value)); return *this;}
67
69
86 inline LanguageCode GetLanguageCode() const { return m_languageCode; }
87 inline bool LanguageCodeHasBeenSet() const { return m_languageCodeHasBeenSet; }
88 inline void SetLanguageCode(LanguageCode value) { m_languageCodeHasBeenSet = true; m_languageCode = value; }
91
93
102 inline int GetMediaSampleRateHertz() const { return m_mediaSampleRateHertz; }
103 inline bool MediaSampleRateHertzHasBeenSet() const { return m_mediaSampleRateHertzHasBeenSet; }
104 inline void SetMediaSampleRateHertz(int value) { m_mediaSampleRateHertzHasBeenSet = true; m_mediaSampleRateHertz = value; }
107
109
112 inline MediaFormat GetMediaFormat() const { return m_mediaFormat; }
113 inline bool MediaFormatHasBeenSet() const { return m_mediaFormatHasBeenSet; }
114 inline void SetMediaFormat(MediaFormat value) { m_mediaFormatHasBeenSet = true; m_mediaFormat = value; }
117
119
123 inline const Media& GetMedia() const { return m_media; }
124 inline bool MediaHasBeenSet() const { return m_mediaHasBeenSet; }
125 template<typename MediaT = Media>
126 void SetMedia(MediaT&& value) { m_mediaHasBeenSet = true; m_media = std::forward<MediaT>(value); }
127 template<typename MediaT = Media>
128 StartTranscriptionJobRequest& WithMedia(MediaT&& value) { SetMedia(std::forward<MediaT>(value)); return *this;}
130
132
153 inline const Aws::String& GetOutputBucketName() const { return m_outputBucketName; }
154 inline bool OutputBucketNameHasBeenSet() const { return m_outputBucketNameHasBeenSet; }
155 template<typename OutputBucketNameT = Aws::String>
156 void SetOutputBucketName(OutputBucketNameT&& value) { m_outputBucketNameHasBeenSet = true; m_outputBucketName = std::forward<OutputBucketNameT>(value); }
157 template<typename OutputBucketNameT = Aws::String>
158 StartTranscriptionJobRequest& WithOutputBucketName(OutputBucketNameT&& value) { SetOutputBucketName(std::forward<OutputBucketNameT>(value)); return *this;}
160
162
188 inline const Aws::String& GetOutputKey() const { return m_outputKey; }
189 inline bool OutputKeyHasBeenSet() const { return m_outputKeyHasBeenSet; }
190 template<typename OutputKeyT = Aws::String>
191 void SetOutputKey(OutputKeyT&& value) { m_outputKeyHasBeenSet = true; m_outputKey = std::forward<OutputKeyT>(value); }
192 template<typename OutputKeyT = Aws::String>
193 StartTranscriptionJobRequest& WithOutputKey(OutputKeyT&& value) { SetOutputKey(std::forward<OutputKeyT>(value)); return *this;}
195
197
220 inline const Aws::String& GetOutputEncryptionKMSKeyId() const { return m_outputEncryptionKMSKeyId; }
221 inline bool OutputEncryptionKMSKeyIdHasBeenSet() const { return m_outputEncryptionKMSKeyIdHasBeenSet; }
222 template<typename OutputEncryptionKMSKeyIdT = Aws::String>
223 void SetOutputEncryptionKMSKeyId(OutputEncryptionKMSKeyIdT&& value) { m_outputEncryptionKMSKeyIdHasBeenSet = true; m_outputEncryptionKMSKeyId = std::forward<OutputEncryptionKMSKeyIdT>(value); }
224 template<typename OutputEncryptionKMSKeyIdT = Aws::String>
225 StartTranscriptionJobRequest& WithOutputEncryptionKMSKeyId(OutputEncryptionKMSKeyIdT&& value) { SetOutputEncryptionKMSKeyId(std::forward<OutputEncryptionKMSKeyIdT>(value)); return *this;}
227
229
238 inline const Aws::Map<Aws::String, Aws::String>& GetKMSEncryptionContext() const { return m_kMSEncryptionContext; }
239 inline bool KMSEncryptionContextHasBeenSet() const { return m_kMSEncryptionContextHasBeenSet; }
240 template<typename KMSEncryptionContextT = Aws::Map<Aws::String, Aws::String>>
241 void SetKMSEncryptionContext(KMSEncryptionContextT&& value) { m_kMSEncryptionContextHasBeenSet = true; m_kMSEncryptionContext = std::forward<KMSEncryptionContextT>(value); }
242 template<typename KMSEncryptionContextT = Aws::Map<Aws::String, Aws::String>>
243 StartTranscriptionJobRequest& WithKMSEncryptionContext(KMSEncryptionContextT&& value) { SetKMSEncryptionContext(std::forward<KMSEncryptionContextT>(value)); return *this;}
244 template<typename KMSEncryptionContextKeyT = Aws::String, typename KMSEncryptionContextValueT = Aws::String>
245 StartTranscriptionJobRequest& AddKMSEncryptionContext(KMSEncryptionContextKeyT&& key, KMSEncryptionContextValueT&& value) {
246 m_kMSEncryptionContextHasBeenSet = true; m_kMSEncryptionContext.emplace(std::forward<KMSEncryptionContextKeyT>(key), std::forward<KMSEncryptionContextValueT>(value)); return *this;
247 }
249
251
265 inline const Settings& GetSettings() const { return m_settings; }
266 inline bool SettingsHasBeenSet() const { return m_settingsHasBeenSet; }
267 template<typename SettingsT = Settings>
268 void SetSettings(SettingsT&& value) { m_settingsHasBeenSet = true; m_settings = std::forward<SettingsT>(value); }
269 template<typename SettingsT = Settings>
270 StartTranscriptionJobRequest& WithSettings(SettingsT&& value) { SetSettings(std::forward<SettingsT>(value)); return *this;}
272
274
282 inline const ModelSettings& GetModelSettings() const { return m_modelSettings; }
283 inline bool ModelSettingsHasBeenSet() const { return m_modelSettingsHasBeenSet; }
284 template<typename ModelSettingsT = ModelSettings>
285 void SetModelSettings(ModelSettingsT&& value) { m_modelSettingsHasBeenSet = true; m_modelSettings = std::forward<ModelSettingsT>(value); }
286 template<typename ModelSettingsT = ModelSettings>
287 StartTranscriptionJobRequest& WithModelSettings(ModelSettingsT&& value) { SetModelSettings(std::forward<ModelSettingsT>(value)); return *this;}
289
291
299 inline const JobExecutionSettings& GetJobExecutionSettings() const { return m_jobExecutionSettings; }
300 inline bool JobExecutionSettingsHasBeenSet() const { return m_jobExecutionSettingsHasBeenSet; }
301 template<typename JobExecutionSettingsT = JobExecutionSettings>
302 void SetJobExecutionSettings(JobExecutionSettingsT&& value) { m_jobExecutionSettingsHasBeenSet = true; m_jobExecutionSettings = std::forward<JobExecutionSettingsT>(value); }
303 template<typename JobExecutionSettingsT = JobExecutionSettings>
304 StartTranscriptionJobRequest& WithJobExecutionSettings(JobExecutionSettingsT&& value) { SetJobExecutionSettings(std::forward<JobExecutionSettingsT>(value)); return *this;}
306
308
317 inline const ContentRedaction& GetContentRedaction() const { return m_contentRedaction; }
318 inline bool ContentRedactionHasBeenSet() const { return m_contentRedactionHasBeenSet; }
319 template<typename ContentRedactionT = ContentRedaction>
320 void SetContentRedaction(ContentRedactionT&& value) { m_contentRedactionHasBeenSet = true; m_contentRedaction = std::forward<ContentRedactionT>(value); }
321 template<typename ContentRedactionT = ContentRedaction>
322 StartTranscriptionJobRequest& WithContentRedaction(ContentRedactionT&& value) { SetContentRedaction(std::forward<ContentRedactionT>(value)); return *this;}
324
326
346 inline bool GetIdentifyLanguage() const { return m_identifyLanguage; }
347 inline bool IdentifyLanguageHasBeenSet() const { return m_identifyLanguageHasBeenSet; }
348 inline void SetIdentifyLanguage(bool value) { m_identifyLanguageHasBeenSet = true; m_identifyLanguage = value; }
349 inline StartTranscriptionJobRequest& WithIdentifyLanguage(bool value) { SetIdentifyLanguage(value); return *this;}
351
353
372 inline bool GetIdentifyMultipleLanguages() const { return m_identifyMultipleLanguages; }
373 inline bool IdentifyMultipleLanguagesHasBeenSet() const { return m_identifyMultipleLanguagesHasBeenSet; }
374 inline void SetIdentifyMultipleLanguages(bool value) { m_identifyMultipleLanguagesHasBeenSet = true; m_identifyMultipleLanguages = value; }
377
379
392 inline const Aws::Vector<LanguageCode>& GetLanguageOptions() const { return m_languageOptions; }
393 inline bool LanguageOptionsHasBeenSet() const { return m_languageOptionsHasBeenSet; }
394 template<typename LanguageOptionsT = Aws::Vector<LanguageCode>>
395 void SetLanguageOptions(LanguageOptionsT&& value) { m_languageOptionsHasBeenSet = true; m_languageOptions = std::forward<LanguageOptionsT>(value); }
396 template<typename LanguageOptionsT = Aws::Vector<LanguageCode>>
397 StartTranscriptionJobRequest& WithLanguageOptions(LanguageOptionsT&& value) { SetLanguageOptions(std::forward<LanguageOptionsT>(value)); return *this;}
398 inline StartTranscriptionJobRequest& AddLanguageOptions(LanguageCode value) { m_languageOptionsHasBeenSet = true; m_languageOptions.push_back(value); return *this; }
400
402
406 inline const Subtitles& GetSubtitles() const { return m_subtitles; }
407 inline bool SubtitlesHasBeenSet() const { return m_subtitlesHasBeenSet; }
408 template<typename SubtitlesT = Subtitles>
409 void SetSubtitles(SubtitlesT&& value) { m_subtitlesHasBeenSet = true; m_subtitles = std::forward<SubtitlesT>(value); }
410 template<typename SubtitlesT = Subtitles>
411 StartTranscriptionJobRequest& WithSubtitles(SubtitlesT&& value) { SetSubtitles(std::forward<SubtitlesT>(value)); return *this;}
413
415
422 inline const Aws::Vector<Tag>& GetTags() const { return m_tags; }
423 inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; }
424 template<typename TagsT = Aws::Vector<Tag>>
425 void SetTags(TagsT&& value) { m_tagsHasBeenSet = true; m_tags = std::forward<TagsT>(value); }
426 template<typename TagsT = Aws::Vector<Tag>>
427 StartTranscriptionJobRequest& WithTags(TagsT&& value) { SetTags(std::forward<TagsT>(value)); return *this;}
428 template<typename TagsT = Tag>
429 StartTranscriptionJobRequest& AddTags(TagsT&& value) { m_tagsHasBeenSet = true; m_tags.emplace_back(std::forward<TagsT>(value)); return *this; }
431
433
461 inline const Aws::Map<LanguageCode, LanguageIdSettings>& GetLanguageIdSettings() const { return m_languageIdSettings; }
462 inline bool LanguageIdSettingsHasBeenSet() const { return m_languageIdSettingsHasBeenSet; }
463 template<typename LanguageIdSettingsT = Aws::Map<LanguageCode, LanguageIdSettings>>
464 void SetLanguageIdSettings(LanguageIdSettingsT&& value) { m_languageIdSettingsHasBeenSet = true; m_languageIdSettings = std::forward<LanguageIdSettingsT>(value); }
465 template<typename LanguageIdSettingsT = Aws::Map<LanguageCode, LanguageIdSettings>>
466 StartTranscriptionJobRequest& WithLanguageIdSettings(LanguageIdSettingsT&& value) { SetLanguageIdSettings(std::forward<LanguageIdSettingsT>(value)); return *this;}
468 m_languageIdSettingsHasBeenSet = true; m_languageIdSettings.emplace(key, value); return *this;
469 }
471
473
481 inline const Aws::Vector<ToxicityDetectionSettings>& GetToxicityDetection() const { return m_toxicityDetection; }
482 inline bool ToxicityDetectionHasBeenSet() const { return m_toxicityDetectionHasBeenSet; }
483 template<typename ToxicityDetectionT = Aws::Vector<ToxicityDetectionSettings>>
484 void SetToxicityDetection(ToxicityDetectionT&& value) { m_toxicityDetectionHasBeenSet = true; m_toxicityDetection = std::forward<ToxicityDetectionT>(value); }
485 template<typename ToxicityDetectionT = Aws::Vector<ToxicityDetectionSettings>>
486 StartTranscriptionJobRequest& WithToxicityDetection(ToxicityDetectionT&& value) { SetToxicityDetection(std::forward<ToxicityDetectionT>(value)); return *this;}
487 template<typename ToxicityDetectionT = ToxicityDetectionSettings>
488 StartTranscriptionJobRequest& AddToxicityDetection(ToxicityDetectionT&& value) { m_toxicityDetectionHasBeenSet = true; m_toxicityDetection.emplace_back(std::forward<ToxicityDetectionT>(value)); return *this; }
490 private:
491
492 Aws::String m_transcriptionJobName;
493 bool m_transcriptionJobNameHasBeenSet = false;
494
495 LanguageCode m_languageCode{LanguageCode::NOT_SET};
496 bool m_languageCodeHasBeenSet = false;
497
498 int m_mediaSampleRateHertz{0};
499 bool m_mediaSampleRateHertzHasBeenSet = false;
500
501 MediaFormat m_mediaFormat{MediaFormat::NOT_SET};
502 bool m_mediaFormatHasBeenSet = false;
503
504 Media m_media;
505 bool m_mediaHasBeenSet = false;
506
507 Aws::String m_outputBucketName;
508 bool m_outputBucketNameHasBeenSet = false;
509
510 Aws::String m_outputKey;
511 bool m_outputKeyHasBeenSet = false;
512
513 Aws::String m_outputEncryptionKMSKeyId;
514 bool m_outputEncryptionKMSKeyIdHasBeenSet = false;
515
516 Aws::Map<Aws::String, Aws::String> m_kMSEncryptionContext;
517 bool m_kMSEncryptionContextHasBeenSet = false;
518
519 Settings m_settings;
520 bool m_settingsHasBeenSet = false;
521
522 ModelSettings m_modelSettings;
523 bool m_modelSettingsHasBeenSet = false;
524
525 JobExecutionSettings m_jobExecutionSettings;
526 bool m_jobExecutionSettingsHasBeenSet = false;
527
528 ContentRedaction m_contentRedaction;
529 bool m_contentRedactionHasBeenSet = false;
530
531 bool m_identifyLanguage{false};
532 bool m_identifyLanguageHasBeenSet = false;
533
534 bool m_identifyMultipleLanguages{false};
535 bool m_identifyMultipleLanguagesHasBeenSet = false;
536
537 Aws::Vector<LanguageCode> m_languageOptions;
538 bool m_languageOptionsHasBeenSet = false;
539
540 Subtitles m_subtitles;
541 bool m_subtitlesHasBeenSet = false;
542
543 Aws::Vector<Tag> m_tags;
544 bool m_tagsHasBeenSet = false;
545
547 bool m_languageIdSettingsHasBeenSet = false;
548
549 Aws::Vector<ToxicityDetectionSettings> m_toxicityDetection;
550 bool m_toxicityDetectionHasBeenSet = false;
551 };
552
553} // namespace Model
554} // namespace TranscribeService
555} // namespace Aws
StartTranscriptionJobRequest & AddLanguageIdSettings(LanguageCode key, LanguageIdSettings value)
StartTranscriptionJobRequest & WithJobExecutionSettings(JobExecutionSettingsT &&value)
StartTranscriptionJobRequest & WithMediaFormat(MediaFormat value)
StartTranscriptionJobRequest & WithLanguageOptions(LanguageOptionsT &&value)
StartTranscriptionJobRequest & WithTranscriptionJobName(TranscriptionJobNameT &&value)
const Aws::Vector< ToxicityDetectionSettings > & GetToxicityDetection() const
StartTranscriptionJobRequest & AddToxicityDetection(ToxicityDetectionT &&value)
StartTranscriptionJobRequest & WithOutputBucketName(OutputBucketNameT &&value)
StartTranscriptionJobRequest & WithOutputEncryptionKMSKeyId(OutputEncryptionKMSKeyIdT &&value)
AWS_TRANSCRIBESERVICE_API Aws::String SerializePayload() const override
StartTranscriptionJobRequest & WithSubtitles(SubtitlesT &&value)
AWS_TRANSCRIBESERVICE_API StartTranscriptionJobRequest()=default
StartTranscriptionJobRequest & WithLanguageCode(LanguageCode value)
AWS_TRANSCRIBESERVICE_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override
StartTranscriptionJobRequest & WithIdentifyMultipleLanguages(bool value)
StartTranscriptionJobRequest & WithToxicityDetection(ToxicityDetectionT &&value)
StartTranscriptionJobRequest & WithLanguageIdSettings(LanguageIdSettingsT &&value)
StartTranscriptionJobRequest & WithSettings(SettingsT &&value)
const Aws::Map< LanguageCode, LanguageIdSettings > & GetLanguageIdSettings() const
StartTranscriptionJobRequest & WithModelSettings(ModelSettingsT &&value)
const Aws::Map< Aws::String, Aws::String > & GetKMSEncryptionContext() const
StartTranscriptionJobRequest & AddKMSEncryptionContext(KMSEncryptionContextKeyT &&key, KMSEncryptionContextValueT &&value)
StartTranscriptionJobRequest & WithKMSEncryptionContext(KMSEncryptionContextT &&value)
StartTranscriptionJobRequest & AddLanguageOptions(LanguageCode value)
StartTranscriptionJobRequest & WithOutputKey(OutputKeyT &&value)
StartTranscriptionJobRequest & WithContentRedaction(ContentRedactionT &&value)
Aws::Map< Aws::String, Aws::String > HeaderValueCollection
std::map< K, V, std::less< K >, Aws::Allocator< std::pair< const K, V > > > Map
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
std::vector< T, Aws::Allocator< T > > Vector