AWS SDK for C++

AWS SDK for C++ Version 1.11.755

Loading...
Searching...
No Matches
StartTranscriptionJobRequest.h
1
6#pragma once
7#include <aws/core/utils/memory/stl/AWSMap.h>
8#include <aws/core/utils/memory/stl/AWSString.h>
9#include <aws/core/utils/memory/stl/AWSVector.h>
10#include <aws/transcribe/TranscribeServiceRequest.h>
11#include <aws/transcribe/TranscribeService_EXPORTS.h>
12#include <aws/transcribe/model/ContentRedaction.h>
13#include <aws/transcribe/model/JobExecutionSettings.h>
14#include <aws/transcribe/model/LanguageCode.h>
15#include <aws/transcribe/model/LanguageIdSettings.h>
16#include <aws/transcribe/model/Media.h>
17#include <aws/transcribe/model/MediaFormat.h>
18#include <aws/transcribe/model/ModelSettings.h>
19#include <aws/transcribe/model/Settings.h>
20#include <aws/transcribe/model/Subtitles.h>
21#include <aws/transcribe/model/Tag.h>
22#include <aws/transcribe/model/ToxicityDetectionSettings.h>
23
24#include <utility>
25
26namespace Aws {
27namespace TranscribeService {
28namespace Model {
29
33 public:
34 AWS_TRANSCRIBESERVICE_API StartTranscriptionJobRequest() = default;
35
36 // Service request name is the Operation name which will send this request out,
37 // each operation should has unique request name, so that we can get operation's name from this request.
38 // Note: this is not true for response, multiple operations may have the same response name,
39 // so we can not get operation's name from response.
40 inline virtual const char* GetServiceRequestName() const override { return "StartTranscriptionJob"; }
41
42 AWS_TRANSCRIBESERVICE_API Aws::String SerializePayload() const override;
43
44 AWS_TRANSCRIBESERVICE_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override;
45
47
56 inline const Aws::String& GetTranscriptionJobName() const { return m_transcriptionJobName; }
57 inline bool TranscriptionJobNameHasBeenSet() const { return m_transcriptionJobNameHasBeenSet; }
58 template <typename TranscriptionJobNameT = Aws::String>
59 void SetTranscriptionJobName(TranscriptionJobNameT&& value) {
60 m_transcriptionJobNameHasBeenSet = true;
61 m_transcriptionJobName = std::forward<TranscriptionJobNameT>(value);
62 }
63 template <typename TranscriptionJobNameT = Aws::String>
65 SetTranscriptionJobName(std::forward<TranscriptionJobNameT>(value));
66 return *this;
67 }
69
71
88 inline LanguageCode GetLanguageCode() const { return m_languageCode; }
89 inline bool LanguageCodeHasBeenSet() const { return m_languageCodeHasBeenSet; }
90 inline void SetLanguageCode(LanguageCode value) {
91 m_languageCodeHasBeenSet = true;
92 m_languageCode = value;
93 }
95 SetLanguageCode(value);
96 return *this;
97 }
99
101
110 inline int GetMediaSampleRateHertz() const { return m_mediaSampleRateHertz; }
111 inline bool MediaSampleRateHertzHasBeenSet() const { return m_mediaSampleRateHertzHasBeenSet; }
112 inline void SetMediaSampleRateHertz(int value) {
113 m_mediaSampleRateHertzHasBeenSet = true;
114 m_mediaSampleRateHertz = value;
115 }
118 return *this;
119 }
121
123
126 inline MediaFormat GetMediaFormat() const { return m_mediaFormat; }
127 inline bool MediaFormatHasBeenSet() const { return m_mediaFormatHasBeenSet; }
128 inline void SetMediaFormat(MediaFormat value) {
129 m_mediaFormatHasBeenSet = true;
130 m_mediaFormat = value;
131 }
133 SetMediaFormat(value);
134 return *this;
135 }
137
139
143 inline const Media& GetMedia() const { return m_media; }
144 inline bool MediaHasBeenSet() const { return m_mediaHasBeenSet; }
145 template <typename MediaT = Media>
146 void SetMedia(MediaT&& value) {
147 m_mediaHasBeenSet = true;
148 m_media = std::forward<MediaT>(value);
149 }
150 template <typename MediaT = Media>
152 SetMedia(std::forward<MediaT>(value));
153 return *this;
154 }
156
158
179 inline const Aws::String& GetOutputBucketName() const { return m_outputBucketName; }
180 inline bool OutputBucketNameHasBeenSet() const { return m_outputBucketNameHasBeenSet; }
181 template <typename OutputBucketNameT = Aws::String>
182 void SetOutputBucketName(OutputBucketNameT&& value) {
183 m_outputBucketNameHasBeenSet = true;
184 m_outputBucketName = std::forward<OutputBucketNameT>(value);
185 }
186 template <typename OutputBucketNameT = Aws::String>
188 SetOutputBucketName(std::forward<OutputBucketNameT>(value));
189 return *this;
190 }
192
194
220 inline const Aws::String& GetOutputKey() const { return m_outputKey; }
221 inline bool OutputKeyHasBeenSet() const { return m_outputKeyHasBeenSet; }
222 template <typename OutputKeyT = Aws::String>
223 void SetOutputKey(OutputKeyT&& value) {
224 m_outputKeyHasBeenSet = true;
225 m_outputKey = std::forward<OutputKeyT>(value);
226 }
227 template <typename OutputKeyT = Aws::String>
229 SetOutputKey(std::forward<OutputKeyT>(value));
230 return *this;
231 }
233
235
248 inline const Aws::String& GetOutputEncryptionKMSKeyId() const { return m_outputEncryptionKMSKeyId; }
249 inline bool OutputEncryptionKMSKeyIdHasBeenSet() const { return m_outputEncryptionKMSKeyIdHasBeenSet; }
250 template <typename OutputEncryptionKMSKeyIdT = Aws::String>
251 void SetOutputEncryptionKMSKeyId(OutputEncryptionKMSKeyIdT&& value) {
252 m_outputEncryptionKMSKeyIdHasBeenSet = true;
253 m_outputEncryptionKMSKeyId = std::forward<OutputEncryptionKMSKeyIdT>(value);
254 }
255 template <typename OutputEncryptionKMSKeyIdT = Aws::String>
256 StartTranscriptionJobRequest& WithOutputEncryptionKMSKeyId(OutputEncryptionKMSKeyIdT&& value) {
257 SetOutputEncryptionKMSKeyId(std::forward<OutputEncryptionKMSKeyIdT>(value));
258 return *this;
259 }
261
263
272 inline const Aws::Map<Aws::String, Aws::String>& GetKMSEncryptionContext() const { return m_kMSEncryptionContext; }
273 inline bool KMSEncryptionContextHasBeenSet() const { return m_kMSEncryptionContextHasBeenSet; }
274 template <typename KMSEncryptionContextT = Aws::Map<Aws::String, Aws::String>>
275 void SetKMSEncryptionContext(KMSEncryptionContextT&& value) {
276 m_kMSEncryptionContextHasBeenSet = true;
277 m_kMSEncryptionContext = std::forward<KMSEncryptionContextT>(value);
278 }
279 template <typename KMSEncryptionContextT = Aws::Map<Aws::String, Aws::String>>
281 SetKMSEncryptionContext(std::forward<KMSEncryptionContextT>(value));
282 return *this;
283 }
284 template <typename KMSEncryptionContextKeyT = Aws::String, typename KMSEncryptionContextValueT = Aws::String>
285 StartTranscriptionJobRequest& AddKMSEncryptionContext(KMSEncryptionContextKeyT&& key, KMSEncryptionContextValueT&& value) {
286 m_kMSEncryptionContextHasBeenSet = true;
287 m_kMSEncryptionContext.emplace(std::forward<KMSEncryptionContextKeyT>(key), std::forward<KMSEncryptionContextValueT>(value));
288 return *this;
289 }
291
293
307 inline const Settings& GetSettings() const { return m_settings; }
308 inline bool SettingsHasBeenSet() const { return m_settingsHasBeenSet; }
309 template <typename SettingsT = Settings>
310 void SetSettings(SettingsT&& value) {
311 m_settingsHasBeenSet = true;
312 m_settings = std::forward<SettingsT>(value);
313 }
314 template <typename SettingsT = Settings>
316 SetSettings(std::forward<SettingsT>(value));
317 return *this;
318 }
320
322
330 inline const ModelSettings& GetModelSettings() const { return m_modelSettings; }
331 inline bool ModelSettingsHasBeenSet() const { return m_modelSettingsHasBeenSet; }
332 template <typename ModelSettingsT = ModelSettings>
333 void SetModelSettings(ModelSettingsT&& value) {
334 m_modelSettingsHasBeenSet = true;
335 m_modelSettings = std::forward<ModelSettingsT>(value);
336 }
337 template <typename ModelSettingsT = ModelSettings>
339 SetModelSettings(std::forward<ModelSettingsT>(value));
340 return *this;
341 }
343
345
353 inline const JobExecutionSettings& GetJobExecutionSettings() const { return m_jobExecutionSettings; }
354 inline bool JobExecutionSettingsHasBeenSet() const { return m_jobExecutionSettingsHasBeenSet; }
355 template <typename JobExecutionSettingsT = JobExecutionSettings>
356 void SetJobExecutionSettings(JobExecutionSettingsT&& value) {
357 m_jobExecutionSettingsHasBeenSet = true;
358 m_jobExecutionSettings = std::forward<JobExecutionSettingsT>(value);
359 }
360 template <typename JobExecutionSettingsT = JobExecutionSettings>
362 SetJobExecutionSettings(std::forward<JobExecutionSettingsT>(value));
363 return *this;
364 }
366
368
377 inline const ContentRedaction& GetContentRedaction() const { return m_contentRedaction; }
378 inline bool ContentRedactionHasBeenSet() const { return m_contentRedactionHasBeenSet; }
379 template <typename ContentRedactionT = ContentRedaction>
380 void SetContentRedaction(ContentRedactionT&& value) {
381 m_contentRedactionHasBeenSet = true;
382 m_contentRedaction = std::forward<ContentRedactionT>(value);
383 }
384 template <typename ContentRedactionT = ContentRedaction>
386 SetContentRedaction(std::forward<ContentRedactionT>(value));
387 return *this;
388 }
390
392
412 inline bool GetIdentifyLanguage() const { return m_identifyLanguage; }
413 inline bool IdentifyLanguageHasBeenSet() const { return m_identifyLanguageHasBeenSet; }
414 inline void SetIdentifyLanguage(bool value) {
415 m_identifyLanguageHasBeenSet = true;
416 m_identifyLanguage = value;
417 }
419 SetIdentifyLanguage(value);
420 return *this;
421 }
423
425
444 inline bool GetIdentifyMultipleLanguages() const { return m_identifyMultipleLanguages; }
445 inline bool IdentifyMultipleLanguagesHasBeenSet() const { return m_identifyMultipleLanguagesHasBeenSet; }
446 inline void SetIdentifyMultipleLanguages(bool value) {
447 m_identifyMultipleLanguagesHasBeenSet = true;
448 m_identifyMultipleLanguages = value;
449 }
452 return *this;
453 }
455
457
470 inline const Aws::Vector<LanguageCode>& GetLanguageOptions() const { return m_languageOptions; }
471 inline bool LanguageOptionsHasBeenSet() const { return m_languageOptionsHasBeenSet; }
472 template <typename LanguageOptionsT = Aws::Vector<LanguageCode>>
473 void SetLanguageOptions(LanguageOptionsT&& value) {
474 m_languageOptionsHasBeenSet = true;
475 m_languageOptions = std::forward<LanguageOptionsT>(value);
476 }
477 template <typename LanguageOptionsT = Aws::Vector<LanguageCode>>
479 SetLanguageOptions(std::forward<LanguageOptionsT>(value));
480 return *this;
481 }
483 m_languageOptionsHasBeenSet = true;
484 m_languageOptions.push_back(value);
485 return *this;
486 }
488
490
494 inline const Subtitles& GetSubtitles() const { return m_subtitles; }
495 inline bool SubtitlesHasBeenSet() const { return m_subtitlesHasBeenSet; }
496 template <typename SubtitlesT = Subtitles>
497 void SetSubtitles(SubtitlesT&& value) {
498 m_subtitlesHasBeenSet = true;
499 m_subtitles = std::forward<SubtitlesT>(value);
500 }
501 template <typename SubtitlesT = Subtitles>
503 SetSubtitles(std::forward<SubtitlesT>(value));
504 return *this;
505 }
507
509
516 inline const Aws::Vector<Tag>& GetTags() const { return m_tags; }
517 inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; }
518 template <typename TagsT = Aws::Vector<Tag>>
519 void SetTags(TagsT&& value) {
520 m_tagsHasBeenSet = true;
521 m_tags = std::forward<TagsT>(value);
522 }
523 template <typename TagsT = Aws::Vector<Tag>>
525 SetTags(std::forward<TagsT>(value));
526 return *this;
527 }
528 template <typename TagsT = Tag>
530 m_tagsHasBeenSet = true;
531 m_tags.emplace_back(std::forward<TagsT>(value));
532 return *this;
533 }
535
537
565 inline const Aws::Map<LanguageCode, LanguageIdSettings>& GetLanguageIdSettings() const { return m_languageIdSettings; }
566 inline bool LanguageIdSettingsHasBeenSet() const { return m_languageIdSettingsHasBeenSet; }
567 template <typename LanguageIdSettingsT = Aws::Map<LanguageCode, LanguageIdSettings>>
568 void SetLanguageIdSettings(LanguageIdSettingsT&& value) {
569 m_languageIdSettingsHasBeenSet = true;
570 m_languageIdSettings = std::forward<LanguageIdSettingsT>(value);
571 }
572 template <typename LanguageIdSettingsT = Aws::Map<LanguageCode, LanguageIdSettings>>
574 SetLanguageIdSettings(std::forward<LanguageIdSettingsT>(value));
575 return *this;
576 }
578 m_languageIdSettingsHasBeenSet = true;
579 m_languageIdSettings.emplace(key, value);
580 return *this;
581 }
583
585
593 inline const Aws::Vector<ToxicityDetectionSettings>& GetToxicityDetection() const { return m_toxicityDetection; }
594 inline bool ToxicityDetectionHasBeenSet() const { return m_toxicityDetectionHasBeenSet; }
595 template <typename ToxicityDetectionT = Aws::Vector<ToxicityDetectionSettings>>
596 void SetToxicityDetection(ToxicityDetectionT&& value) {
597 m_toxicityDetectionHasBeenSet = true;
598 m_toxicityDetection = std::forward<ToxicityDetectionT>(value);
599 }
600 template <typename ToxicityDetectionT = Aws::Vector<ToxicityDetectionSettings>>
602 SetToxicityDetection(std::forward<ToxicityDetectionT>(value));
603 return *this;
604 }
605 template <typename ToxicityDetectionT = ToxicityDetectionSettings>
607 m_toxicityDetectionHasBeenSet = true;
608 m_toxicityDetection.emplace_back(std::forward<ToxicityDetectionT>(value));
609 return *this;
610 }
612 private:
613 Aws::String m_transcriptionJobName;
614
615 LanguageCode m_languageCode{LanguageCode::NOT_SET};
616
617 int m_mediaSampleRateHertz{0};
618
619 MediaFormat m_mediaFormat{MediaFormat::NOT_SET};
620
621 Media m_media;
622
623 Aws::String m_outputBucketName;
624
625 Aws::String m_outputKey;
626
627 Aws::String m_outputEncryptionKMSKeyId;
628
629 Aws::Map<Aws::String, Aws::String> m_kMSEncryptionContext;
630
631 Settings m_settings;
632
633 ModelSettings m_modelSettings;
634
635 JobExecutionSettings m_jobExecutionSettings;
636
637 ContentRedaction m_contentRedaction;
638
639 bool m_identifyLanguage{false};
640
641 bool m_identifyMultipleLanguages{false};
642
643 Aws::Vector<LanguageCode> m_languageOptions;
644
645 Subtitles m_subtitles;
646
647 Aws::Vector<Tag> m_tags;
648
650
651 Aws::Vector<ToxicityDetectionSettings> m_toxicityDetection;
652 bool m_transcriptionJobNameHasBeenSet = false;
653 bool m_languageCodeHasBeenSet = false;
654 bool m_mediaSampleRateHertzHasBeenSet = false;
655 bool m_mediaFormatHasBeenSet = false;
656 bool m_mediaHasBeenSet = false;
657 bool m_outputBucketNameHasBeenSet = false;
658 bool m_outputKeyHasBeenSet = false;
659 bool m_outputEncryptionKMSKeyIdHasBeenSet = false;
660 bool m_kMSEncryptionContextHasBeenSet = false;
661 bool m_settingsHasBeenSet = false;
662 bool m_modelSettingsHasBeenSet = false;
663 bool m_jobExecutionSettingsHasBeenSet = false;
664 bool m_contentRedactionHasBeenSet = false;
665 bool m_identifyLanguageHasBeenSet = false;
666 bool m_identifyMultipleLanguagesHasBeenSet = false;
667 bool m_languageOptionsHasBeenSet = false;
668 bool m_subtitlesHasBeenSet = false;
669 bool m_tagsHasBeenSet = false;
670 bool m_languageIdSettingsHasBeenSet = false;
671 bool m_toxicityDetectionHasBeenSet = false;
672};
673
674} // namespace Model
675} // namespace TranscribeService
676} // 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