AWS SDK for C++

AWS SDK for C++ Version 1.11.757

Loading...
Searching...
No Matches
TranscriptionJob.h
1
6#pragma once
7#include <aws/core/utils/DateTime.h>
8#include <aws/core/utils/memory/stl/AWSMap.h>
9#include <aws/core/utils/memory/stl/AWSString.h>
10#include <aws/core/utils/memory/stl/AWSVector.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/LanguageCodeItem.h>
16#include <aws/transcribe/model/LanguageIdSettings.h>
17#include <aws/transcribe/model/Media.h>
18#include <aws/transcribe/model/MediaFormat.h>
19#include <aws/transcribe/model/ModelSettings.h>
20#include <aws/transcribe/model/Settings.h>
21#include <aws/transcribe/model/SubtitlesOutput.h>
22#include <aws/transcribe/model/Tag.h>
23#include <aws/transcribe/model/ToxicityDetectionSettings.h>
24#include <aws/transcribe/model/Transcript.h>
25#include <aws/transcribe/model/TranscriptionJobStatus.h>
26
27#include <utility>
28
29namespace Aws {
30namespace Utils {
31namespace Json {
32class JsonValue;
33class JsonView;
34} // namespace Json
35} // namespace Utils
36namespace TranscribeService {
37namespace Model {
38
53 public:
54 AWS_TRANSCRIBESERVICE_API TranscriptionJob() = default;
55 AWS_TRANSCRIBESERVICE_API TranscriptionJob(Aws::Utils::Json::JsonView jsonValue);
56 AWS_TRANSCRIBESERVICE_API TranscriptionJob& operator=(Aws::Utils::Json::JsonView jsonValue);
57 AWS_TRANSCRIBESERVICE_API Aws::Utils::Json::JsonValue Jsonize() const;
58
60
64 inline const Aws::String& GetTranscriptionJobName() const { return m_transcriptionJobName; }
65 inline bool TranscriptionJobNameHasBeenSet() const { return m_transcriptionJobNameHasBeenSet; }
66 template <typename TranscriptionJobNameT = Aws::String>
67 void SetTranscriptionJobName(TranscriptionJobNameT&& value) {
68 m_transcriptionJobNameHasBeenSet = true;
69 m_transcriptionJobName = std::forward<TranscriptionJobNameT>(value);
70 }
71 template <typename TranscriptionJobNameT = Aws::String>
72 TranscriptionJob& WithTranscriptionJobName(TranscriptionJobNameT&& value) {
73 SetTranscriptionJobName(std::forward<TranscriptionJobNameT>(value));
74 return *this;
75 }
77
79
87 inline TranscriptionJobStatus GetTranscriptionJobStatus() const { return m_transcriptionJobStatus; }
88 inline bool TranscriptionJobStatusHasBeenSet() const { return m_transcriptionJobStatusHasBeenSet; }
90 m_transcriptionJobStatusHasBeenSet = true;
91 m_transcriptionJobStatus = value;
92 }
95 return *this;
96 }
98
100
106 inline LanguageCode GetLanguageCode() const { return m_languageCode; }
107 inline bool LanguageCodeHasBeenSet() const { return m_languageCodeHasBeenSet; }
108 inline void SetLanguageCode(LanguageCode value) {
109 m_languageCodeHasBeenSet = true;
110 m_languageCode = value;
111 }
113 SetLanguageCode(value);
114 return *this;
115 }
117
119
122 inline int GetMediaSampleRateHertz() const { return m_mediaSampleRateHertz; }
123 inline bool MediaSampleRateHertzHasBeenSet() const { return m_mediaSampleRateHertzHasBeenSet; }
124 inline void SetMediaSampleRateHertz(int value) {
125 m_mediaSampleRateHertzHasBeenSet = true;
126 m_mediaSampleRateHertz = value;
127 }
130 return *this;
131 }
133
135
138 inline MediaFormat GetMediaFormat() const { return m_mediaFormat; }
139 inline bool MediaFormatHasBeenSet() const { return m_mediaFormatHasBeenSet; }
140 inline void SetMediaFormat(MediaFormat value) {
141 m_mediaFormatHasBeenSet = true;
142 m_mediaFormat = value;
143 }
145 SetMediaFormat(value);
146 return *this;
147 }
149
151
155 inline const Media& GetMedia() const { return m_media; }
156 inline bool MediaHasBeenSet() const { return m_mediaHasBeenSet; }
157 template <typename MediaT = Media>
158 void SetMedia(MediaT&& value) {
159 m_mediaHasBeenSet = true;
160 m_media = std::forward<MediaT>(value);
161 }
162 template <typename MediaT = Media>
163 TranscriptionJob& WithMedia(MediaT&& value) {
164 SetMedia(std::forward<MediaT>(value));
165 return *this;
166 }
168
170
174 inline const Transcript& GetTranscript() const { return m_transcript; }
175 inline bool TranscriptHasBeenSet() const { return m_transcriptHasBeenSet; }
176 template <typename TranscriptT = Transcript>
177 void SetTranscript(TranscriptT&& value) {
178 m_transcriptHasBeenSet = true;
179 m_transcript = std::forward<TranscriptT>(value);
180 }
181 template <typename TranscriptT = Transcript>
182 TranscriptionJob& WithTranscript(TranscriptT&& value) {
183 SetTranscript(std::forward<TranscriptT>(value));
184 return *this;
185 }
187
189
195 inline const Aws::Utils::DateTime& GetStartTime() const { return m_startTime; }
196 inline bool StartTimeHasBeenSet() const { return m_startTimeHasBeenSet; }
197 template <typename StartTimeT = Aws::Utils::DateTime>
198 void SetStartTime(StartTimeT&& value) {
199 m_startTimeHasBeenSet = true;
200 m_startTime = std::forward<StartTimeT>(value);
201 }
202 template <typename StartTimeT = Aws::Utils::DateTime>
203 TranscriptionJob& WithStartTime(StartTimeT&& value) {
204 SetStartTime(std::forward<StartTimeT>(value));
205 return *this;
206 }
208
210
216 inline const Aws::Utils::DateTime& GetCreationTime() const { return m_creationTime; }
217 inline bool CreationTimeHasBeenSet() const { return m_creationTimeHasBeenSet; }
218 template <typename CreationTimeT = Aws::Utils::DateTime>
219 void SetCreationTime(CreationTimeT&& value) {
220 m_creationTimeHasBeenSet = true;
221 m_creationTime = std::forward<CreationTimeT>(value);
222 }
223 template <typename CreationTimeT = Aws::Utils::DateTime>
224 TranscriptionJob& WithCreationTime(CreationTimeT&& value) {
225 SetCreationTime(std::forward<CreationTimeT>(value));
226 return *this;
227 }
229
231
237 inline const Aws::Utils::DateTime& GetCompletionTime() const { return m_completionTime; }
238 inline bool CompletionTimeHasBeenSet() const { return m_completionTimeHasBeenSet; }
239 template <typename CompletionTimeT = Aws::Utils::DateTime>
240 void SetCompletionTime(CompletionTimeT&& value) {
241 m_completionTimeHasBeenSet = true;
242 m_completionTime = std::forward<CompletionTimeT>(value);
243 }
244 template <typename CompletionTimeT = Aws::Utils::DateTime>
245 TranscriptionJob& WithCompletionTime(CompletionTimeT&& value) {
246 SetCompletionTime(std::forward<CompletionTimeT>(value));
247 return *this;
248 }
250
252
279 inline const Aws::String& GetFailureReason() const { return m_failureReason; }
280 inline bool FailureReasonHasBeenSet() const { return m_failureReasonHasBeenSet; }
281 template <typename FailureReasonT = Aws::String>
282 void SetFailureReason(FailureReasonT&& value) {
283 m_failureReasonHasBeenSet = true;
284 m_failureReason = std::forward<FailureReasonT>(value);
285 }
286 template <typename FailureReasonT = Aws::String>
287 TranscriptionJob& WithFailureReason(FailureReasonT&& value) {
288 SetFailureReason(std::forward<FailureReasonT>(value));
289 return *this;
290 }
292
294
300 inline const Settings& GetSettings() const { return m_settings; }
301 inline bool SettingsHasBeenSet() const { return m_settingsHasBeenSet; }
302 template <typename SettingsT = Settings>
303 void SetSettings(SettingsT&& value) {
304 m_settingsHasBeenSet = true;
305 m_settings = std::forward<SettingsT>(value);
306 }
307 template <typename SettingsT = Settings>
308 TranscriptionJob& WithSettings(SettingsT&& value) {
309 SetSettings(std::forward<SettingsT>(value));
310 return *this;
311 }
313
315
319 inline const ModelSettings& GetModelSettings() const { return m_modelSettings; }
320 inline bool ModelSettingsHasBeenSet() const { return m_modelSettingsHasBeenSet; }
321 template <typename ModelSettingsT = ModelSettings>
322 void SetModelSettings(ModelSettingsT&& value) {
323 m_modelSettingsHasBeenSet = true;
324 m_modelSettings = std::forward<ModelSettingsT>(value);
325 }
326 template <typename ModelSettingsT = ModelSettings>
327 TranscriptionJob& WithModelSettings(ModelSettingsT&& value) {
328 SetModelSettings(std::forward<ModelSettingsT>(value));
329 return *this;
330 }
332
334
339 inline const JobExecutionSettings& GetJobExecutionSettings() const { return m_jobExecutionSettings; }
340 inline bool JobExecutionSettingsHasBeenSet() const { return m_jobExecutionSettingsHasBeenSet; }
341 template <typename JobExecutionSettingsT = JobExecutionSettings>
342 void SetJobExecutionSettings(JobExecutionSettingsT&& value) {
343 m_jobExecutionSettingsHasBeenSet = true;
344 m_jobExecutionSettings = std::forward<JobExecutionSettingsT>(value);
345 }
346 template <typename JobExecutionSettingsT = JobExecutionSettings>
347 TranscriptionJob& WithJobExecutionSettings(JobExecutionSettingsT&& value) {
348 SetJobExecutionSettings(std::forward<JobExecutionSettingsT>(value));
349 return *this;
350 }
352
354
357 inline const ContentRedaction& GetContentRedaction() const { return m_contentRedaction; }
358 inline bool ContentRedactionHasBeenSet() const { return m_contentRedactionHasBeenSet; }
359 template <typename ContentRedactionT = ContentRedaction>
360 void SetContentRedaction(ContentRedactionT&& value) {
361 m_contentRedactionHasBeenSet = true;
362 m_contentRedaction = std::forward<ContentRedactionT>(value);
363 }
364 template <typename ContentRedactionT = ContentRedaction>
365 TranscriptionJob& WithContentRedaction(ContentRedactionT&& value) {
366 SetContentRedaction(std::forward<ContentRedactionT>(value));
367 return *this;
368 }
370
372
376 inline bool GetIdentifyLanguage() const { return m_identifyLanguage; }
377 inline bool IdentifyLanguageHasBeenSet() const { return m_identifyLanguageHasBeenSet; }
378 inline void SetIdentifyLanguage(bool value) {
379 m_identifyLanguageHasBeenSet = true;
380 m_identifyLanguage = value;
381 }
383 SetIdentifyLanguage(value);
384 return *this;
385 }
387
389
393 inline bool GetIdentifyMultipleLanguages() const { return m_identifyMultipleLanguages; }
394 inline bool IdentifyMultipleLanguagesHasBeenSet() const { return m_identifyMultipleLanguagesHasBeenSet; }
395 inline void SetIdentifyMultipleLanguages(bool value) {
396 m_identifyMultipleLanguagesHasBeenSet = true;
397 m_identifyMultipleLanguages = value;
398 }
401 return *this;
402 }
404
406
409 inline const Aws::Vector<LanguageCode>& GetLanguageOptions() const { return m_languageOptions; }
410 inline bool LanguageOptionsHasBeenSet() const { return m_languageOptionsHasBeenSet; }
411 template <typename LanguageOptionsT = Aws::Vector<LanguageCode>>
412 void SetLanguageOptions(LanguageOptionsT&& value) {
413 m_languageOptionsHasBeenSet = true;
414 m_languageOptions = std::forward<LanguageOptionsT>(value);
415 }
416 template <typename LanguageOptionsT = Aws::Vector<LanguageCode>>
417 TranscriptionJob& WithLanguageOptions(LanguageOptionsT&& value) {
418 SetLanguageOptions(std::forward<LanguageOptionsT>(value));
419 return *this;
420 }
422 m_languageOptionsHasBeenSet = true;
423 m_languageOptions.push_back(value);
424 return *this;
425 }
427
429
435 inline double GetIdentifiedLanguageScore() const { return m_identifiedLanguageScore; }
436 inline bool IdentifiedLanguageScoreHasBeenSet() const { return m_identifiedLanguageScoreHasBeenSet; }
437 inline void SetIdentifiedLanguageScore(double value) {
438 m_identifiedLanguageScoreHasBeenSet = true;
439 m_identifiedLanguageScore = value;
440 }
443 return *this;
444 }
446
448
454 inline const Aws::Vector<LanguageCodeItem>& GetLanguageCodes() const { return m_languageCodes; }
455 inline bool LanguageCodesHasBeenSet() const { return m_languageCodesHasBeenSet; }
456 template <typename LanguageCodesT = Aws::Vector<LanguageCodeItem>>
457 void SetLanguageCodes(LanguageCodesT&& value) {
458 m_languageCodesHasBeenSet = true;
459 m_languageCodes = std::forward<LanguageCodesT>(value);
460 }
461 template <typename LanguageCodesT = Aws::Vector<LanguageCodeItem>>
462 TranscriptionJob& WithLanguageCodes(LanguageCodesT&& value) {
463 SetLanguageCodes(std::forward<LanguageCodesT>(value));
464 return *this;
465 }
466 template <typename LanguageCodesT = LanguageCodeItem>
467 TranscriptionJob& AddLanguageCodes(LanguageCodesT&& value) {
468 m_languageCodesHasBeenSet = true;
469 m_languageCodes.emplace_back(std::forward<LanguageCodesT>(value));
470 return *this;
471 }
473
475
479 inline const Aws::Vector<Tag>& GetTags() const { return m_tags; }
480 inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; }
481 template <typename TagsT = Aws::Vector<Tag>>
482 void SetTags(TagsT&& value) {
483 m_tagsHasBeenSet = true;
484 m_tags = std::forward<TagsT>(value);
485 }
486 template <typename TagsT = Aws::Vector<Tag>>
487 TranscriptionJob& WithTags(TagsT&& value) {
488 SetTags(std::forward<TagsT>(value));
489 return *this;
490 }
491 template <typename TagsT = Tag>
492 TranscriptionJob& AddTags(TagsT&& value) {
493 m_tagsHasBeenSet = true;
494 m_tags.emplace_back(std::forward<TagsT>(value));
495 return *this;
496 }
498
500
503 inline const SubtitlesOutput& GetSubtitles() const { return m_subtitles; }
504 inline bool SubtitlesHasBeenSet() const { return m_subtitlesHasBeenSet; }
505 template <typename SubtitlesT = SubtitlesOutput>
506 void SetSubtitles(SubtitlesT&& value) {
507 m_subtitlesHasBeenSet = true;
508 m_subtitles = std::forward<SubtitlesT>(value);
509 }
510 template <typename SubtitlesT = SubtitlesOutput>
511 TranscriptionJob& WithSubtitles(SubtitlesT&& value) {
512 SetSubtitles(std::forward<SubtitlesT>(value));
513 return *this;
514 }
516
518
523 inline const Aws::Map<LanguageCode, LanguageIdSettings>& GetLanguageIdSettings() const { return m_languageIdSettings; }
524 inline bool LanguageIdSettingsHasBeenSet() const { return m_languageIdSettingsHasBeenSet; }
525 template <typename LanguageIdSettingsT = Aws::Map<LanguageCode, LanguageIdSettings>>
526 void SetLanguageIdSettings(LanguageIdSettingsT&& value) {
527 m_languageIdSettingsHasBeenSet = true;
528 m_languageIdSettings = std::forward<LanguageIdSettingsT>(value);
529 }
530 template <typename LanguageIdSettingsT = Aws::Map<LanguageCode, LanguageIdSettings>>
531 TranscriptionJob& WithLanguageIdSettings(LanguageIdSettingsT&& value) {
532 SetLanguageIdSettings(std::forward<LanguageIdSettingsT>(value));
533 return *this;
534 }
536 m_languageIdSettingsHasBeenSet = true;
537 m_languageIdSettings.emplace(key, value);
538 return *this;
539 }
541
543
547 inline const Aws::Vector<ToxicityDetectionSettings>& GetToxicityDetection() const { return m_toxicityDetection; }
548 inline bool ToxicityDetectionHasBeenSet() const { return m_toxicityDetectionHasBeenSet; }
549 template <typename ToxicityDetectionT = Aws::Vector<ToxicityDetectionSettings>>
550 void SetToxicityDetection(ToxicityDetectionT&& value) {
551 m_toxicityDetectionHasBeenSet = true;
552 m_toxicityDetection = std::forward<ToxicityDetectionT>(value);
553 }
554 template <typename ToxicityDetectionT = Aws::Vector<ToxicityDetectionSettings>>
555 TranscriptionJob& WithToxicityDetection(ToxicityDetectionT&& value) {
556 SetToxicityDetection(std::forward<ToxicityDetectionT>(value));
557 return *this;
558 }
559 template <typename ToxicityDetectionT = ToxicityDetectionSettings>
560 TranscriptionJob& AddToxicityDetection(ToxicityDetectionT&& value) {
561 m_toxicityDetectionHasBeenSet = true;
562 m_toxicityDetection.emplace_back(std::forward<ToxicityDetectionT>(value));
563 return *this;
564 }
566 private:
567 Aws::String m_transcriptionJobName;
568
570
571 LanguageCode m_languageCode{LanguageCode::NOT_SET};
572
573 int m_mediaSampleRateHertz{0};
574
575 MediaFormat m_mediaFormat{MediaFormat::NOT_SET};
576
577 Media m_media;
578
579 Transcript m_transcript;
580
581 Aws::Utils::DateTime m_startTime{};
582
583 Aws::Utils::DateTime m_creationTime{};
584
585 Aws::Utils::DateTime m_completionTime{};
586
587 Aws::String m_failureReason;
588
589 Settings m_settings;
590
591 ModelSettings m_modelSettings;
592
593 JobExecutionSettings m_jobExecutionSettings;
594
595 ContentRedaction m_contentRedaction;
596
597 bool m_identifyLanguage{false};
598
599 bool m_identifyMultipleLanguages{false};
600
601 Aws::Vector<LanguageCode> m_languageOptions;
602
603 double m_identifiedLanguageScore{0.0};
604
605 Aws::Vector<LanguageCodeItem> m_languageCodes;
606
607 Aws::Vector<Tag> m_tags;
608
609 SubtitlesOutput m_subtitles;
610
612
613 Aws::Vector<ToxicityDetectionSettings> m_toxicityDetection;
614 bool m_transcriptionJobNameHasBeenSet = false;
615 bool m_transcriptionJobStatusHasBeenSet = false;
616 bool m_languageCodeHasBeenSet = false;
617 bool m_mediaSampleRateHertzHasBeenSet = false;
618 bool m_mediaFormatHasBeenSet = false;
619 bool m_mediaHasBeenSet = false;
620 bool m_transcriptHasBeenSet = false;
621 bool m_startTimeHasBeenSet = false;
622 bool m_creationTimeHasBeenSet = false;
623 bool m_completionTimeHasBeenSet = false;
624 bool m_failureReasonHasBeenSet = false;
625 bool m_settingsHasBeenSet = false;
626 bool m_modelSettingsHasBeenSet = false;
627 bool m_jobExecutionSettingsHasBeenSet = false;
628 bool m_contentRedactionHasBeenSet = false;
629 bool m_identifyLanguageHasBeenSet = false;
630 bool m_identifyMultipleLanguagesHasBeenSet = false;
631 bool m_languageOptionsHasBeenSet = false;
632 bool m_identifiedLanguageScoreHasBeenSet = false;
633 bool m_languageCodesHasBeenSet = false;
634 bool m_tagsHasBeenSet = false;
635 bool m_subtitlesHasBeenSet = false;
636 bool m_languageIdSettingsHasBeenSet = false;
637 bool m_toxicityDetectionHasBeenSet = false;
638};
639
640} // namespace Model
641} // namespace TranscribeService
642} // namespace Aws
TranscriptionJob & AddLanguageOptions(LanguageCode value)
void SetLanguageOptions(LanguageOptionsT &&value)
TranscriptionJob & WithJobExecutionSettings(JobExecutionSettingsT &&value)
TranscriptionJob & WithIdentifyLanguage(bool value)
TranscriptionJob & WithTranscriptionJobStatus(TranscriptionJobStatus value)
const ContentRedaction & GetContentRedaction() const
TranscriptionJob & WithMediaFormat(MediaFormat value)
void SetTranscriptionJobStatus(TranscriptionJobStatus value)
TranscriptionJob & AddTags(TagsT &&value)
TranscriptionJob & WithMedia(MediaT &&value)
TranscriptionJob & WithMediaSampleRateHertz(int value)
const JobExecutionSettings & GetJobExecutionSettings() const
TranscriptionJob & WithLanguageOptions(LanguageOptionsT &&value)
TranscriptionJob & WithStartTime(StartTimeT &&value)
TranscriptionJob & WithToxicityDetection(ToxicityDetectionT &&value)
void SetJobExecutionSettings(JobExecutionSettingsT &&value)
const Aws::Utils::DateTime & GetCreationTime() const
const Aws::Utils::DateTime & GetCompletionTime() const
TranscriptionJob & WithSubtitles(SubtitlesT &&value)
TranscriptionJob & WithIdentifyMultipleLanguages(bool value)
TranscriptionJob & WithCreationTime(CreationTimeT &&value)
TranscriptionJob & WithLanguageIdSettings(LanguageIdSettingsT &&value)
void SetLanguageIdSettings(LanguageIdSettingsT &&value)
void SetTranscriptionJobName(TranscriptionJobNameT &&value)
const Aws::Vector< ToxicityDetectionSettings > & GetToxicityDetection() const
const Aws::Map< LanguageCode, LanguageIdSettings > & GetLanguageIdSettings() const
TranscriptionJob & WithTranscriptionJobName(TranscriptionJobNameT &&value)
TranscriptionJob & WithIdentifiedLanguageScore(double value)
const Aws::Vector< LanguageCodeItem > & GetLanguageCodes() const
TranscriptionJobStatus GetTranscriptionJobStatus() const
TranscriptionJob & WithLanguageCode(LanguageCode value)
TranscriptionJob & AddLanguageIdSettings(LanguageCode key, LanguageIdSettings value)
AWS_TRANSCRIBESERVICE_API TranscriptionJob()=default
TranscriptionJob & WithSettings(SettingsT &&value)
const Aws::Utils::DateTime & GetStartTime() const
const Aws::Vector< LanguageCode > & GetLanguageOptions() const
TranscriptionJob & WithLanguageCodes(LanguageCodesT &&value)
void SetToxicityDetection(ToxicityDetectionT &&value)
TranscriptionJob & AddLanguageCodes(LanguageCodesT &&value)
TranscriptionJob & WithFailureReason(FailureReasonT &&value)
TranscriptionJob & WithCompletionTime(CompletionTimeT &&value)
TranscriptionJob & WithTranscript(TranscriptT &&value)
AWS_TRANSCRIBESERVICE_API TranscriptionJob & operator=(Aws::Utils::Json::JsonView jsonValue)
const Aws::Vector< Tag > & GetTags() const
AWS_TRANSCRIBESERVICE_API TranscriptionJob(Aws::Utils::Json::JsonView jsonValue)
TranscriptionJob & WithModelSettings(ModelSettingsT &&value)
TranscriptionJob & AddToxicityDetection(ToxicityDetectionT &&value)
const Aws::String & GetTranscriptionJobName() const
AWS_TRANSCRIBESERVICE_API Aws::Utils::Json::JsonValue Jsonize() const
TranscriptionJob & WithContentRedaction(ContentRedactionT &&value)
void SetContentRedaction(ContentRedactionT &&value)
TranscriptionJob & WithTags(TagsT &&value)
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
Aws::Utils::Json::JsonValue JsonValue