AWS SDK for C++

AWS SDK for C++ Version 1.11.607

Loading...
Searching...
No Matches
TranscriptionJob.h
1
6#pragma once
7#include <aws/transcribe/TranscribeService_EXPORTS.h>
8#include <aws/core/utils/memory/stl/AWSString.h>
9#include <aws/transcribe/model/TranscriptionJobStatus.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/transcribe/model/Transcript.h>
14#include <aws/core/utils/DateTime.h>
15#include <aws/transcribe/model/Settings.h>
16#include <aws/transcribe/model/ModelSettings.h>
17#include <aws/transcribe/model/JobExecutionSettings.h>
18#include <aws/transcribe/model/ContentRedaction.h>
19#include <aws/core/utils/memory/stl/AWSVector.h>
20#include <aws/transcribe/model/SubtitlesOutput.h>
21#include <aws/core/utils/memory/stl/AWSMap.h>
22#include <aws/transcribe/model/LanguageCodeItem.h>
23#include <aws/transcribe/model/Tag.h>
24#include <aws/transcribe/model/LanguageIdSettings.h>
25#include <aws/transcribe/model/ToxicityDetectionSettings.h>
26#include <utility>
27
28namespace Aws
29{
30namespace Utils
31{
32namespace Json
33{
34 class JsonValue;
35 class JsonView;
36} // namespace Json
37} // namespace Utils
38namespace TranscribeService
39{
40namespace Model
41{
42
57 {
58 public:
59 AWS_TRANSCRIBESERVICE_API TranscriptionJob() = default;
60 AWS_TRANSCRIBESERVICE_API TranscriptionJob(Aws::Utils::Json::JsonView jsonValue);
61 AWS_TRANSCRIBESERVICE_API TranscriptionJob& operator=(Aws::Utils::Json::JsonView jsonValue);
62 AWS_TRANSCRIBESERVICE_API Aws::Utils::Json::JsonValue Jsonize() const;
63
64
66
70 inline const Aws::String& GetTranscriptionJobName() const { return m_transcriptionJobName; }
71 inline bool TranscriptionJobNameHasBeenSet() const { return m_transcriptionJobNameHasBeenSet; }
72 template<typename TranscriptionJobNameT = Aws::String>
73 void SetTranscriptionJobName(TranscriptionJobNameT&& value) { m_transcriptionJobNameHasBeenSet = true; m_transcriptionJobName = std::forward<TranscriptionJobNameT>(value); }
74 template<typename TranscriptionJobNameT = Aws::String>
75 TranscriptionJob& WithTranscriptionJobName(TranscriptionJobNameT&& value) { SetTranscriptionJobName(std::forward<TranscriptionJobNameT>(value)); return *this;}
77
79
87 inline TranscriptionJobStatus GetTranscriptionJobStatus() const { return m_transcriptionJobStatus; }
88 inline bool TranscriptionJobStatusHasBeenSet() const { return m_transcriptionJobStatusHasBeenSet; }
89 inline void SetTranscriptionJobStatus(TranscriptionJobStatus value) { m_transcriptionJobStatusHasBeenSet = true; m_transcriptionJobStatus = value; }
92
94
100 inline LanguageCode GetLanguageCode() const { return m_languageCode; }
101 inline bool LanguageCodeHasBeenSet() const { return m_languageCodeHasBeenSet; }
102 inline void SetLanguageCode(LanguageCode value) { m_languageCodeHasBeenSet = true; m_languageCode = value; }
103 inline TranscriptionJob& WithLanguageCode(LanguageCode value) { SetLanguageCode(value); return *this;}
105
107
110 inline int GetMediaSampleRateHertz() const { return m_mediaSampleRateHertz; }
111 inline bool MediaSampleRateHertzHasBeenSet() const { return m_mediaSampleRateHertzHasBeenSet; }
112 inline void SetMediaSampleRateHertz(int value) { m_mediaSampleRateHertzHasBeenSet = true; m_mediaSampleRateHertz = value; }
113 inline TranscriptionJob& WithMediaSampleRateHertz(int value) { SetMediaSampleRateHertz(value); return *this;}
115
117
120 inline MediaFormat GetMediaFormat() const { return m_mediaFormat; }
121 inline bool MediaFormatHasBeenSet() const { return m_mediaFormatHasBeenSet; }
122 inline void SetMediaFormat(MediaFormat value) { m_mediaFormatHasBeenSet = true; m_mediaFormat = value; }
123 inline TranscriptionJob& WithMediaFormat(MediaFormat value) { SetMediaFormat(value); return *this;}
125
127
131 inline const Media& GetMedia() const { return m_media; }
132 inline bool MediaHasBeenSet() const { return m_mediaHasBeenSet; }
133 template<typename MediaT = Media>
134 void SetMedia(MediaT&& value) { m_mediaHasBeenSet = true; m_media = std::forward<MediaT>(value); }
135 template<typename MediaT = Media>
136 TranscriptionJob& WithMedia(MediaT&& value) { SetMedia(std::forward<MediaT>(value)); return *this;}
138
140
144 inline const Transcript& GetTranscript() const { return m_transcript; }
145 inline bool TranscriptHasBeenSet() const { return m_transcriptHasBeenSet; }
146 template<typename TranscriptT = Transcript>
147 void SetTranscript(TranscriptT&& value) { m_transcriptHasBeenSet = true; m_transcript = std::forward<TranscriptT>(value); }
148 template<typename TranscriptT = Transcript>
149 TranscriptionJob& WithTranscript(TranscriptT&& value) { SetTranscript(std::forward<TranscriptT>(value)); return *this;}
151
153
159 inline const Aws::Utils::DateTime& GetStartTime() const { return m_startTime; }
160 inline bool StartTimeHasBeenSet() const { return m_startTimeHasBeenSet; }
161 template<typename StartTimeT = Aws::Utils::DateTime>
162 void SetStartTime(StartTimeT&& value) { m_startTimeHasBeenSet = true; m_startTime = std::forward<StartTimeT>(value); }
163 template<typename StartTimeT = Aws::Utils::DateTime>
164 TranscriptionJob& WithStartTime(StartTimeT&& value) { SetStartTime(std::forward<StartTimeT>(value)); return *this;}
166
168
174 inline const Aws::Utils::DateTime& GetCreationTime() const { return m_creationTime; }
175 inline bool CreationTimeHasBeenSet() const { return m_creationTimeHasBeenSet; }
176 template<typename CreationTimeT = Aws::Utils::DateTime>
177 void SetCreationTime(CreationTimeT&& value) { m_creationTimeHasBeenSet = true; m_creationTime = std::forward<CreationTimeT>(value); }
178 template<typename CreationTimeT = Aws::Utils::DateTime>
179 TranscriptionJob& WithCreationTime(CreationTimeT&& value) { SetCreationTime(std::forward<CreationTimeT>(value)); return *this;}
181
183
189 inline const Aws::Utils::DateTime& GetCompletionTime() const { return m_completionTime; }
190 inline bool CompletionTimeHasBeenSet() const { return m_completionTimeHasBeenSet; }
191 template<typename CompletionTimeT = Aws::Utils::DateTime>
192 void SetCompletionTime(CompletionTimeT&& value) { m_completionTimeHasBeenSet = true; m_completionTime = std::forward<CompletionTimeT>(value); }
193 template<typename CompletionTimeT = Aws::Utils::DateTime>
194 TranscriptionJob& WithCompletionTime(CompletionTimeT&& value) { SetCompletionTime(std::forward<CompletionTimeT>(value)); return *this;}
196
198
225 inline const Aws::String& GetFailureReason() const { return m_failureReason; }
226 inline bool FailureReasonHasBeenSet() const { return m_failureReasonHasBeenSet; }
227 template<typename FailureReasonT = Aws::String>
228 void SetFailureReason(FailureReasonT&& value) { m_failureReasonHasBeenSet = true; m_failureReason = std::forward<FailureReasonT>(value); }
229 template<typename FailureReasonT = Aws::String>
230 TranscriptionJob& WithFailureReason(FailureReasonT&& value) { SetFailureReason(std::forward<FailureReasonT>(value)); return *this;}
232
234
240 inline const Settings& GetSettings() const { return m_settings; }
241 inline bool SettingsHasBeenSet() const { return m_settingsHasBeenSet; }
242 template<typename SettingsT = Settings>
243 void SetSettings(SettingsT&& value) { m_settingsHasBeenSet = true; m_settings = std::forward<SettingsT>(value); }
244 template<typename SettingsT = Settings>
245 TranscriptionJob& WithSettings(SettingsT&& value) { SetSettings(std::forward<SettingsT>(value)); return *this;}
247
249
253 inline const ModelSettings& GetModelSettings() const { return m_modelSettings; }
254 inline bool ModelSettingsHasBeenSet() const { return m_modelSettingsHasBeenSet; }
255 template<typename ModelSettingsT = ModelSettings>
256 void SetModelSettings(ModelSettingsT&& value) { m_modelSettingsHasBeenSet = true; m_modelSettings = std::forward<ModelSettingsT>(value); }
257 template<typename ModelSettingsT = ModelSettings>
258 TranscriptionJob& WithModelSettings(ModelSettingsT&& value) { SetModelSettings(std::forward<ModelSettingsT>(value)); return *this;}
260
262
267 inline const JobExecutionSettings& GetJobExecutionSettings() const { return m_jobExecutionSettings; }
268 inline bool JobExecutionSettingsHasBeenSet() const { return m_jobExecutionSettingsHasBeenSet; }
269 template<typename JobExecutionSettingsT = JobExecutionSettings>
270 void SetJobExecutionSettings(JobExecutionSettingsT&& value) { m_jobExecutionSettingsHasBeenSet = true; m_jobExecutionSettings = std::forward<JobExecutionSettingsT>(value); }
271 template<typename JobExecutionSettingsT = JobExecutionSettings>
272 TranscriptionJob& WithJobExecutionSettings(JobExecutionSettingsT&& value) { SetJobExecutionSettings(std::forward<JobExecutionSettingsT>(value)); return *this;}
274
276
279 inline const ContentRedaction& GetContentRedaction() const { return m_contentRedaction; }
280 inline bool ContentRedactionHasBeenSet() const { return m_contentRedactionHasBeenSet; }
281 template<typename ContentRedactionT = ContentRedaction>
282 void SetContentRedaction(ContentRedactionT&& value) { m_contentRedactionHasBeenSet = true; m_contentRedaction = std::forward<ContentRedactionT>(value); }
283 template<typename ContentRedactionT = ContentRedaction>
284 TranscriptionJob& WithContentRedaction(ContentRedactionT&& value) { SetContentRedaction(std::forward<ContentRedactionT>(value)); return *this;}
286
288
292 inline bool GetIdentifyLanguage() const { return m_identifyLanguage; }
293 inline bool IdentifyLanguageHasBeenSet() const { return m_identifyLanguageHasBeenSet; }
294 inline void SetIdentifyLanguage(bool value) { m_identifyLanguageHasBeenSet = true; m_identifyLanguage = value; }
295 inline TranscriptionJob& WithIdentifyLanguage(bool value) { SetIdentifyLanguage(value); return *this;}
297
299
303 inline bool GetIdentifyMultipleLanguages() const { return m_identifyMultipleLanguages; }
304 inline bool IdentifyMultipleLanguagesHasBeenSet() const { return m_identifyMultipleLanguagesHasBeenSet; }
305 inline void SetIdentifyMultipleLanguages(bool value) { m_identifyMultipleLanguagesHasBeenSet = true; m_identifyMultipleLanguages = value; }
308
310
313 inline const Aws::Vector<LanguageCode>& GetLanguageOptions() const { return m_languageOptions; }
314 inline bool LanguageOptionsHasBeenSet() const { return m_languageOptionsHasBeenSet; }
315 template<typename LanguageOptionsT = Aws::Vector<LanguageCode>>
316 void SetLanguageOptions(LanguageOptionsT&& value) { m_languageOptionsHasBeenSet = true; m_languageOptions = std::forward<LanguageOptionsT>(value); }
317 template<typename LanguageOptionsT = Aws::Vector<LanguageCode>>
318 TranscriptionJob& WithLanguageOptions(LanguageOptionsT&& value) { SetLanguageOptions(std::forward<LanguageOptionsT>(value)); return *this;}
319 inline TranscriptionJob& AddLanguageOptions(LanguageCode value) { m_languageOptionsHasBeenSet = true; m_languageOptions.push_back(value); return *this; }
321
323
329 inline double GetIdentifiedLanguageScore() const { return m_identifiedLanguageScore; }
330 inline bool IdentifiedLanguageScoreHasBeenSet() const { return m_identifiedLanguageScoreHasBeenSet; }
331 inline void SetIdentifiedLanguageScore(double value) { m_identifiedLanguageScoreHasBeenSet = true; m_identifiedLanguageScore = value; }
332 inline TranscriptionJob& WithIdentifiedLanguageScore(double value) { SetIdentifiedLanguageScore(value); return *this;}
334
336
342 inline const Aws::Vector<LanguageCodeItem>& GetLanguageCodes() const { return m_languageCodes; }
343 inline bool LanguageCodesHasBeenSet() const { return m_languageCodesHasBeenSet; }
344 template<typename LanguageCodesT = Aws::Vector<LanguageCodeItem>>
345 void SetLanguageCodes(LanguageCodesT&& value) { m_languageCodesHasBeenSet = true; m_languageCodes = std::forward<LanguageCodesT>(value); }
346 template<typename LanguageCodesT = Aws::Vector<LanguageCodeItem>>
347 TranscriptionJob& WithLanguageCodes(LanguageCodesT&& value) { SetLanguageCodes(std::forward<LanguageCodesT>(value)); return *this;}
348 template<typename LanguageCodesT = LanguageCodeItem>
349 TranscriptionJob& AddLanguageCodes(LanguageCodesT&& value) { m_languageCodesHasBeenSet = true; m_languageCodes.emplace_back(std::forward<LanguageCodesT>(value)); return *this; }
351
353
357 inline const Aws::Vector<Tag>& GetTags() const { return m_tags; }
358 inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; }
359 template<typename TagsT = Aws::Vector<Tag>>
360 void SetTags(TagsT&& value) { m_tagsHasBeenSet = true; m_tags = std::forward<TagsT>(value); }
361 template<typename TagsT = Aws::Vector<Tag>>
362 TranscriptionJob& WithTags(TagsT&& value) { SetTags(std::forward<TagsT>(value)); return *this;}
363 template<typename TagsT = Tag>
364 TranscriptionJob& AddTags(TagsT&& value) { m_tagsHasBeenSet = true; m_tags.emplace_back(std::forward<TagsT>(value)); return *this; }
366
368
371 inline const SubtitlesOutput& GetSubtitles() const { return m_subtitles; }
372 inline bool SubtitlesHasBeenSet() const { return m_subtitlesHasBeenSet; }
373 template<typename SubtitlesT = SubtitlesOutput>
374 void SetSubtitles(SubtitlesT&& value) { m_subtitlesHasBeenSet = true; m_subtitles = std::forward<SubtitlesT>(value); }
375 template<typename SubtitlesT = SubtitlesOutput>
376 TranscriptionJob& WithSubtitles(SubtitlesT&& value) { SetSubtitles(std::forward<SubtitlesT>(value)); return *this;}
378
380
385 inline const Aws::Map<LanguageCode, LanguageIdSettings>& GetLanguageIdSettings() const { return m_languageIdSettings; }
386 inline bool LanguageIdSettingsHasBeenSet() const { return m_languageIdSettingsHasBeenSet; }
387 template<typename LanguageIdSettingsT = Aws::Map<LanguageCode, LanguageIdSettings>>
388 void SetLanguageIdSettings(LanguageIdSettingsT&& value) { m_languageIdSettingsHasBeenSet = true; m_languageIdSettings = std::forward<LanguageIdSettingsT>(value); }
389 template<typename LanguageIdSettingsT = Aws::Map<LanguageCode, LanguageIdSettings>>
390 TranscriptionJob& WithLanguageIdSettings(LanguageIdSettingsT&& value) { SetLanguageIdSettings(std::forward<LanguageIdSettingsT>(value)); return *this;}
392 m_languageIdSettingsHasBeenSet = true; m_languageIdSettings.emplace(key, value); return *this;
393 }
395
397
401 inline const Aws::Vector<ToxicityDetectionSettings>& GetToxicityDetection() const { return m_toxicityDetection; }
402 inline bool ToxicityDetectionHasBeenSet() const { return m_toxicityDetectionHasBeenSet; }
403 template<typename ToxicityDetectionT = Aws::Vector<ToxicityDetectionSettings>>
404 void SetToxicityDetection(ToxicityDetectionT&& value) { m_toxicityDetectionHasBeenSet = true; m_toxicityDetection = std::forward<ToxicityDetectionT>(value); }
405 template<typename ToxicityDetectionT = Aws::Vector<ToxicityDetectionSettings>>
406 TranscriptionJob& WithToxicityDetection(ToxicityDetectionT&& value) { SetToxicityDetection(std::forward<ToxicityDetectionT>(value)); return *this;}
407 template<typename ToxicityDetectionT = ToxicityDetectionSettings>
408 TranscriptionJob& AddToxicityDetection(ToxicityDetectionT&& value) { m_toxicityDetectionHasBeenSet = true; m_toxicityDetection.emplace_back(std::forward<ToxicityDetectionT>(value)); return *this; }
410 private:
411
412 Aws::String m_transcriptionJobName;
413 bool m_transcriptionJobNameHasBeenSet = false;
414
416 bool m_transcriptionJobStatusHasBeenSet = false;
417
418 LanguageCode m_languageCode{LanguageCode::NOT_SET};
419 bool m_languageCodeHasBeenSet = false;
420
421 int m_mediaSampleRateHertz{0};
422 bool m_mediaSampleRateHertzHasBeenSet = false;
423
424 MediaFormat m_mediaFormat{MediaFormat::NOT_SET};
425 bool m_mediaFormatHasBeenSet = false;
426
427 Media m_media;
428 bool m_mediaHasBeenSet = false;
429
430 Transcript m_transcript;
431 bool m_transcriptHasBeenSet = false;
432
433 Aws::Utils::DateTime m_startTime{};
434 bool m_startTimeHasBeenSet = false;
435
436 Aws::Utils::DateTime m_creationTime{};
437 bool m_creationTimeHasBeenSet = false;
438
439 Aws::Utils::DateTime m_completionTime{};
440 bool m_completionTimeHasBeenSet = false;
441
442 Aws::String m_failureReason;
443 bool m_failureReasonHasBeenSet = false;
444
445 Settings m_settings;
446 bool m_settingsHasBeenSet = false;
447
448 ModelSettings m_modelSettings;
449 bool m_modelSettingsHasBeenSet = false;
450
451 JobExecutionSettings m_jobExecutionSettings;
452 bool m_jobExecutionSettingsHasBeenSet = false;
453
454 ContentRedaction m_contentRedaction;
455 bool m_contentRedactionHasBeenSet = false;
456
457 bool m_identifyLanguage{false};
458 bool m_identifyLanguageHasBeenSet = false;
459
460 bool m_identifyMultipleLanguages{false};
461 bool m_identifyMultipleLanguagesHasBeenSet = false;
462
463 Aws::Vector<LanguageCode> m_languageOptions;
464 bool m_languageOptionsHasBeenSet = false;
465
466 double m_identifiedLanguageScore{0.0};
467 bool m_identifiedLanguageScoreHasBeenSet = false;
468
469 Aws::Vector<LanguageCodeItem> m_languageCodes;
470 bool m_languageCodesHasBeenSet = false;
471
472 Aws::Vector<Tag> m_tags;
473 bool m_tagsHasBeenSet = false;
474
475 SubtitlesOutput m_subtitles;
476 bool m_subtitlesHasBeenSet = false;
477
479 bool m_languageIdSettingsHasBeenSet = false;
480
481 Aws::Vector<ToxicityDetectionSettings> m_toxicityDetection;
482 bool m_toxicityDetectionHasBeenSet = false;
483 };
484
485} // namespace Model
486} // namespace TranscribeService
487} // 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