/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace TranscribeService { namespace Model { /** *

Provides a summary of information about a transcription job.

See * Also:

AWS * API Reference

*/ class AWS_TRANSCRIBESERVICE_API TranscriptionJobSummary { public: TranscriptionJobSummary(); TranscriptionJobSummary(Aws::Utils::Json::JsonView jsonValue); TranscriptionJobSummary& operator=(Aws::Utils::Json::JsonView jsonValue); Aws::Utils::Json::JsonValue Jsonize() const; /** *

The name of the transcription job.

*/ inline const Aws::String& GetTranscriptionJobName() const{ return m_transcriptionJobName; } /** *

The name of the transcription job.

*/ inline bool TranscriptionJobNameHasBeenSet() const { return m_transcriptionJobNameHasBeenSet; } /** *

The name of the transcription job.

*/ inline void SetTranscriptionJobName(const Aws::String& value) { m_transcriptionJobNameHasBeenSet = true; m_transcriptionJobName = value; } /** *

The name of the transcription job.

*/ inline void SetTranscriptionJobName(Aws::String&& value) { m_transcriptionJobNameHasBeenSet = true; m_transcriptionJobName = std::move(value); } /** *

The name of the transcription job.

*/ inline void SetTranscriptionJobName(const char* value) { m_transcriptionJobNameHasBeenSet = true; m_transcriptionJobName.assign(value); } /** *

The name of the transcription job.

*/ inline TranscriptionJobSummary& WithTranscriptionJobName(const Aws::String& value) { SetTranscriptionJobName(value); return *this;} /** *

The name of the transcription job.

*/ inline TranscriptionJobSummary& WithTranscriptionJobName(Aws::String&& value) { SetTranscriptionJobName(std::move(value)); return *this;} /** *

The name of the transcription job.

*/ inline TranscriptionJobSummary& WithTranscriptionJobName(const char* value) { SetTranscriptionJobName(value); return *this;} /** *

A timestamp that shows when the job was created.

*/ inline const Aws::Utils::DateTime& GetCreationTime() const{ return m_creationTime; } /** *

A timestamp that shows when the job was created.

*/ inline bool CreationTimeHasBeenSet() const { return m_creationTimeHasBeenSet; } /** *

A timestamp that shows when the job was created.

*/ inline void SetCreationTime(const Aws::Utils::DateTime& value) { m_creationTimeHasBeenSet = true; m_creationTime = value; } /** *

A timestamp that shows when the job was created.

*/ inline void SetCreationTime(Aws::Utils::DateTime&& value) { m_creationTimeHasBeenSet = true; m_creationTime = std::move(value); } /** *

A timestamp that shows when the job was created.

*/ inline TranscriptionJobSummary& WithCreationTime(const Aws::Utils::DateTime& value) { SetCreationTime(value); return *this;} /** *

A timestamp that shows when the job was created.

*/ inline TranscriptionJobSummary& WithCreationTime(Aws::Utils::DateTime&& value) { SetCreationTime(std::move(value)); return *this;} /** *

A timestamp that shows when the job started processing.

*/ inline const Aws::Utils::DateTime& GetStartTime() const{ return m_startTime; } /** *

A timestamp that shows when the job started processing.

*/ inline bool StartTimeHasBeenSet() const { return m_startTimeHasBeenSet; } /** *

A timestamp that shows when the job started processing.

*/ inline void SetStartTime(const Aws::Utils::DateTime& value) { m_startTimeHasBeenSet = true; m_startTime = value; } /** *

A timestamp that shows when the job started processing.

*/ inline void SetStartTime(Aws::Utils::DateTime&& value) { m_startTimeHasBeenSet = true; m_startTime = std::move(value); } /** *

A timestamp that shows when the job started processing.

*/ inline TranscriptionJobSummary& WithStartTime(const Aws::Utils::DateTime& value) { SetStartTime(value); return *this;} /** *

A timestamp that shows when the job started processing.

*/ inline TranscriptionJobSummary& WithStartTime(Aws::Utils::DateTime&& value) { SetStartTime(std::move(value)); return *this;} /** *

A timestamp that shows when the job was completed.

*/ inline const Aws::Utils::DateTime& GetCompletionTime() const{ return m_completionTime; } /** *

A timestamp that shows when the job was completed.

*/ inline bool CompletionTimeHasBeenSet() const { return m_completionTimeHasBeenSet; } /** *

A timestamp that shows when the job was completed.

*/ inline void SetCompletionTime(const Aws::Utils::DateTime& value) { m_completionTimeHasBeenSet = true; m_completionTime = value; } /** *

A timestamp that shows when the job was completed.

*/ inline void SetCompletionTime(Aws::Utils::DateTime&& value) { m_completionTimeHasBeenSet = true; m_completionTime = std::move(value); } /** *

A timestamp that shows when the job was completed.

*/ inline TranscriptionJobSummary& WithCompletionTime(const Aws::Utils::DateTime& value) { SetCompletionTime(value); return *this;} /** *

A timestamp that shows when the job was completed.

*/ inline TranscriptionJobSummary& WithCompletionTime(Aws::Utils::DateTime&& value) { SetCompletionTime(std::move(value)); return *this;} /** *

The language code for the input speech.

*/ inline const LanguageCode& GetLanguageCode() const{ return m_languageCode; } /** *

The language code for the input speech.

*/ inline bool LanguageCodeHasBeenSet() const { return m_languageCodeHasBeenSet; } /** *

The language code for the input speech.

*/ inline void SetLanguageCode(const LanguageCode& value) { m_languageCodeHasBeenSet = true; m_languageCode = value; } /** *

The language code for the input speech.

*/ inline void SetLanguageCode(LanguageCode&& value) { m_languageCodeHasBeenSet = true; m_languageCode = std::move(value); } /** *

The language code for the input speech.

*/ inline TranscriptionJobSummary& WithLanguageCode(const LanguageCode& value) { SetLanguageCode(value); return *this;} /** *

The language code for the input speech.

*/ inline TranscriptionJobSummary& WithLanguageCode(LanguageCode&& value) { SetLanguageCode(std::move(value)); return *this;} /** *

The status of the transcription job. When the status is * COMPLETED, use the GetTranscriptionJob operation to * get the results of the transcription.

*/ inline const TranscriptionJobStatus& GetTranscriptionJobStatus() const{ return m_transcriptionJobStatus; } /** *

The status of the transcription job. When the status is * COMPLETED, use the GetTranscriptionJob operation to * get the results of the transcription.

*/ inline bool TranscriptionJobStatusHasBeenSet() const { return m_transcriptionJobStatusHasBeenSet; } /** *

The status of the transcription job. When the status is * COMPLETED, use the GetTranscriptionJob operation to * get the results of the transcription.

*/ inline void SetTranscriptionJobStatus(const TranscriptionJobStatus& value) { m_transcriptionJobStatusHasBeenSet = true; m_transcriptionJobStatus = value; } /** *

The status of the transcription job. When the status is * COMPLETED, use the GetTranscriptionJob operation to * get the results of the transcription.

*/ inline void SetTranscriptionJobStatus(TranscriptionJobStatus&& value) { m_transcriptionJobStatusHasBeenSet = true; m_transcriptionJobStatus = std::move(value); } /** *

The status of the transcription job. When the status is * COMPLETED, use the GetTranscriptionJob operation to * get the results of the transcription.

*/ inline TranscriptionJobSummary& WithTranscriptionJobStatus(const TranscriptionJobStatus& value) { SetTranscriptionJobStatus(value); return *this;} /** *

The status of the transcription job. When the status is * COMPLETED, use the GetTranscriptionJob operation to * get the results of the transcription.

*/ inline TranscriptionJobSummary& WithTranscriptionJobStatus(TranscriptionJobStatus&& value) { SetTranscriptionJobStatus(std::move(value)); return *this;} /** *

If the TranscriptionJobStatus field is FAILED, a * description of the error.

*/ inline const Aws::String& GetFailureReason() const{ return m_failureReason; } /** *

If the TranscriptionJobStatus field is FAILED, a * description of the error.

*/ inline bool FailureReasonHasBeenSet() const { return m_failureReasonHasBeenSet; } /** *

If the TranscriptionJobStatus field is FAILED, a * description of the error.

*/ inline void SetFailureReason(const Aws::String& value) { m_failureReasonHasBeenSet = true; m_failureReason = value; } /** *

If the TranscriptionJobStatus field is FAILED, a * description of the error.

*/ inline void SetFailureReason(Aws::String&& value) { m_failureReasonHasBeenSet = true; m_failureReason = std::move(value); } /** *

If the TranscriptionJobStatus field is FAILED, a * description of the error.

*/ inline void SetFailureReason(const char* value) { m_failureReasonHasBeenSet = true; m_failureReason.assign(value); } /** *

If the TranscriptionJobStatus field is FAILED, a * description of the error.

*/ inline TranscriptionJobSummary& WithFailureReason(const Aws::String& value) { SetFailureReason(value); return *this;} /** *

If the TranscriptionJobStatus field is FAILED, a * description of the error.

*/ inline TranscriptionJobSummary& WithFailureReason(Aws::String&& value) { SetFailureReason(std::move(value)); return *this;} /** *

If the TranscriptionJobStatus field is FAILED, a * description of the error.

*/ inline TranscriptionJobSummary& WithFailureReason(const char* value) { SetFailureReason(value); return *this;} /** *

Indicates the location of the output of the transcription job.

If the * value is CUSTOMER_BUCKET then the location is the S3 bucket * specified in the outputBucketName field when the transcription job * was started with the StartTranscriptionJob operation.

If the * value is SERVICE_BUCKET then the output is stored by Amazon * Transcribe and can be retrieved using the URI in the * GetTranscriptionJob response's TranscriptFileUri * field.

*/ inline const OutputLocationType& GetOutputLocationType() const{ return m_outputLocationType; } /** *

Indicates the location of the output of the transcription job.

If the * value is CUSTOMER_BUCKET then the location is the S3 bucket * specified in the outputBucketName field when the transcription job * was started with the StartTranscriptionJob operation.

If the * value is SERVICE_BUCKET then the output is stored by Amazon * Transcribe and can be retrieved using the URI in the * GetTranscriptionJob response's TranscriptFileUri * field.

*/ inline bool OutputLocationTypeHasBeenSet() const { return m_outputLocationTypeHasBeenSet; } /** *

Indicates the location of the output of the transcription job.

If the * value is CUSTOMER_BUCKET then the location is the S3 bucket * specified in the outputBucketName field when the transcription job * was started with the StartTranscriptionJob operation.

If the * value is SERVICE_BUCKET then the output is stored by Amazon * Transcribe and can be retrieved using the URI in the * GetTranscriptionJob response's TranscriptFileUri * field.

*/ inline void SetOutputLocationType(const OutputLocationType& value) { m_outputLocationTypeHasBeenSet = true; m_outputLocationType = value; } /** *

Indicates the location of the output of the transcription job.

If the * value is CUSTOMER_BUCKET then the location is the S3 bucket * specified in the outputBucketName field when the transcription job * was started with the StartTranscriptionJob operation.

If the * value is SERVICE_BUCKET then the output is stored by Amazon * Transcribe and can be retrieved using the URI in the * GetTranscriptionJob response's TranscriptFileUri * field.

*/ inline void SetOutputLocationType(OutputLocationType&& value) { m_outputLocationTypeHasBeenSet = true; m_outputLocationType = std::move(value); } /** *

Indicates the location of the output of the transcription job.

If the * value is CUSTOMER_BUCKET then the location is the S3 bucket * specified in the outputBucketName field when the transcription job * was started with the StartTranscriptionJob operation.

If the * value is SERVICE_BUCKET then the output is stored by Amazon * Transcribe and can be retrieved using the URI in the * GetTranscriptionJob response's TranscriptFileUri * field.

*/ inline TranscriptionJobSummary& WithOutputLocationType(const OutputLocationType& value) { SetOutputLocationType(value); return *this;} /** *

Indicates the location of the output of the transcription job.

If the * value is CUSTOMER_BUCKET then the location is the S3 bucket * specified in the outputBucketName field when the transcription job * was started with the StartTranscriptionJob operation.

If the * value is SERVICE_BUCKET then the output is stored by Amazon * Transcribe and can be retrieved using the URI in the * GetTranscriptionJob response's TranscriptFileUri * field.

*/ inline TranscriptionJobSummary& WithOutputLocationType(OutputLocationType&& value) { SetOutputLocationType(std::move(value)); return *this;} /** *

The content redaction settings of the transcription job.

*/ inline const ContentRedaction& GetContentRedaction() const{ return m_contentRedaction; } /** *

The content redaction settings of the transcription job.

*/ inline bool ContentRedactionHasBeenSet() const { return m_contentRedactionHasBeenSet; } /** *

The content redaction settings of the transcription job.

*/ inline void SetContentRedaction(const ContentRedaction& value) { m_contentRedactionHasBeenSet = true; m_contentRedaction = value; } /** *

The content redaction settings of the transcription job.

*/ inline void SetContentRedaction(ContentRedaction&& value) { m_contentRedactionHasBeenSet = true; m_contentRedaction = std::move(value); } /** *

The content redaction settings of the transcription job.

*/ inline TranscriptionJobSummary& WithContentRedaction(const ContentRedaction& value) { SetContentRedaction(value); return *this;} /** *

The content redaction settings of the transcription job.

*/ inline TranscriptionJobSummary& WithContentRedaction(ContentRedaction&& value) { SetContentRedaction(std::move(value)); return *this;} inline const ModelSettings& GetModelSettings() const{ return m_modelSettings; } inline bool ModelSettingsHasBeenSet() const { return m_modelSettingsHasBeenSet; } inline void SetModelSettings(const ModelSettings& value) { m_modelSettingsHasBeenSet = true; m_modelSettings = value; } inline void SetModelSettings(ModelSettings&& value) { m_modelSettingsHasBeenSet = true; m_modelSettings = std::move(value); } inline TranscriptionJobSummary& WithModelSettings(const ModelSettings& value) { SetModelSettings(value); return *this;} inline TranscriptionJobSummary& WithModelSettings(ModelSettings&& value) { SetModelSettings(std::move(value)); return *this;} private: Aws::String m_transcriptionJobName; bool m_transcriptionJobNameHasBeenSet; Aws::Utils::DateTime m_creationTime; bool m_creationTimeHasBeenSet; Aws::Utils::DateTime m_startTime; bool m_startTimeHasBeenSet; Aws::Utils::DateTime m_completionTime; bool m_completionTimeHasBeenSet; LanguageCode m_languageCode; bool m_languageCodeHasBeenSet; TranscriptionJobStatus m_transcriptionJobStatus; bool m_transcriptionJobStatusHasBeenSet; Aws::String m_failureReason; bool m_failureReasonHasBeenSet; OutputLocationType m_outputLocationType; bool m_outputLocationTypeHasBeenSet; ContentRedaction m_contentRedaction; bool m_contentRedactionHasBeenSet; ModelSettings m_modelSettings; bool m_modelSettingsHasBeenSet; }; } // namespace Model } // namespace TranscribeService } // namespace Aws