/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.transcribe.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *

* Provides detailed information about a medical transcription job. *

*

* To view the status of the specified medical transcription job, check the TranscriptionJobStatus field. * If the status is COMPLETED, the job is finished and you can find the results at the location specified * in TranscriptFileUri. If the status is FAILED, FailureReason provides details * on why your transcription job failed. *

* * @see AWS * API Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class MedicalTranscriptionJob implements Serializable, Cloneable, StructuredPojo { /** *

* The name of the medical transcription job. Job names are case sensitive and must be unique within an Amazon Web * Services account. *

*/ private String medicalTranscriptionJobName; /** *

* Provides the status of the specified medical transcription job. *

*

* If the status is COMPLETED, the job is finished and you can find the results at the location * specified in TranscriptFileUri. If the status is FAILED, FailureReason * provides details on why your transcription job failed. *

*/ private String transcriptionJobStatus; /** *

* The language code used to create your medical transcription job. US English (en-US) is the only * supported language for medical transcriptions. *

*/ private String languageCode; /** *

* The sample rate, in hertz, of the audio track in your input media file. *

*/ private Integer mediaSampleRateHertz; /** *

* The format of the input media file. *

*/ private String mediaFormat; private Media media; /** *

* Provides you with the Amazon S3 URI you can use to access your transcript. *

*/ private MedicalTranscript transcript; /** *

* The date and time the specified medical transcription job began processing. *

*

* Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, * 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started processing at 12:32 PM * UTC-7 on May 4, 2022. *

*/ private java.util.Date startTime; /** *

* The date and time the specified medical transcription job request was made. *

*

* Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, * 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started processing at 12:32 PM * UTC-7 on May 4, 2022. *

*/ private java.util.Date creationTime; /** *

* The date and time the specified medical transcription job finished processing. *

*

* Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, * 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started processing at 12:33 PM * UTC-7 on May 4, 2022. *

*/ private java.util.Date completionTime; /** *

* If TranscriptionJobStatus is FAILED, FailureReason contains information * about why the transcription job request failed. *

*

* The FailureReason field contains one of the following values: *

* */ private String failureReason; /** *

* Provides information on any additional settings that were included in your request. Additional settings include * channel identification, alternative transcriptions, speaker partitioning, custom vocabularies, and custom * vocabulary filters. *

*/ private MedicalTranscriptionSetting settings; /** *

* Indicates whether content identification was enabled for your transcription request. *

*/ private String contentIdentificationType; /** *

* Describes the medical specialty represented in your media. *

*/ private String specialty; /** *

* Indicates whether the input media is a dictation or a conversation, as specified in the * StartMedicalTranscriptionJob request. *

*/ private String type; /** *

* The tags, each in the form of a key:value pair, assigned to the specified medical transcription job. *

*/ private java.util.List tags; /** *

* The name of the medical transcription job. Job names are case sensitive and must be unique within an Amazon Web * Services account. *

* * @param medicalTranscriptionJobName * The name of the medical transcription job. Job names are case sensitive and must be unique within an * Amazon Web Services account. */ public void setMedicalTranscriptionJobName(String medicalTranscriptionJobName) { this.medicalTranscriptionJobName = medicalTranscriptionJobName; } /** *

* The name of the medical transcription job. Job names are case sensitive and must be unique within an Amazon Web * Services account. *

* * @return The name of the medical transcription job. Job names are case sensitive and must be unique within an * Amazon Web Services account. */ public String getMedicalTranscriptionJobName() { return this.medicalTranscriptionJobName; } /** *

* The name of the medical transcription job. Job names are case sensitive and must be unique within an Amazon Web * Services account. *

* * @param medicalTranscriptionJobName * The name of the medical transcription job. Job names are case sensitive and must be unique within an * Amazon Web Services account. * @return Returns a reference to this object so that method calls can be chained together. */ public MedicalTranscriptionJob withMedicalTranscriptionJobName(String medicalTranscriptionJobName) { setMedicalTranscriptionJobName(medicalTranscriptionJobName); return this; } /** *

* Provides the status of the specified medical transcription job. *

*

* If the status is COMPLETED, the job is finished and you can find the results at the location * specified in TranscriptFileUri. If the status is FAILED, FailureReason * provides details on why your transcription job failed. *

* * @param transcriptionJobStatus * Provides the status of the specified medical transcription job.

*

* If the status is COMPLETED, the job is finished and you can find the results at the location * specified in TranscriptFileUri. If the status is FAILED, * FailureReason provides details on why your transcription job failed. * @see TranscriptionJobStatus */ public void setTranscriptionJobStatus(String transcriptionJobStatus) { this.transcriptionJobStatus = transcriptionJobStatus; } /** *

* Provides the status of the specified medical transcription job. *

*

* If the status is COMPLETED, the job is finished and you can find the results at the location * specified in TranscriptFileUri. If the status is FAILED, FailureReason * provides details on why your transcription job failed. *

* * @return Provides the status of the specified medical transcription job.

*

* If the status is COMPLETED, the job is finished and you can find the results at the location * specified in TranscriptFileUri. If the status is FAILED, * FailureReason provides details on why your transcription job failed. * @see TranscriptionJobStatus */ public String getTranscriptionJobStatus() { return this.transcriptionJobStatus; } /** *

* Provides the status of the specified medical transcription job. *

*

* If the status is COMPLETED, the job is finished and you can find the results at the location * specified in TranscriptFileUri. If the status is FAILED, FailureReason * provides details on why your transcription job failed. *

* * @param transcriptionJobStatus * Provides the status of the specified medical transcription job.

*

* If the status is COMPLETED, the job is finished and you can find the results at the location * specified in TranscriptFileUri. If the status is FAILED, * FailureReason provides details on why your transcription job failed. * @return Returns a reference to this object so that method calls can be chained together. * @see TranscriptionJobStatus */ public MedicalTranscriptionJob withTranscriptionJobStatus(String transcriptionJobStatus) { setTranscriptionJobStatus(transcriptionJobStatus); return this; } /** *

* Provides the status of the specified medical transcription job. *

*

* If the status is COMPLETED, the job is finished and you can find the results at the location * specified in TranscriptFileUri. If the status is FAILED, FailureReason * provides details on why your transcription job failed. *

* * @param transcriptionJobStatus * Provides the status of the specified medical transcription job.

*

* If the status is COMPLETED, the job is finished and you can find the results at the location * specified in TranscriptFileUri. If the status is FAILED, * FailureReason provides details on why your transcription job failed. * @return Returns a reference to this object so that method calls can be chained together. * @see TranscriptionJobStatus */ public MedicalTranscriptionJob withTranscriptionJobStatus(TranscriptionJobStatus transcriptionJobStatus) { this.transcriptionJobStatus = transcriptionJobStatus.toString(); return this; } /** *

* The language code used to create your medical transcription job. US English (en-US) is the only * supported language for medical transcriptions. *

* * @param languageCode * The language code used to create your medical transcription job. US English (en-US) is the * only supported language for medical transcriptions. * @see LanguageCode */ public void setLanguageCode(String languageCode) { this.languageCode = languageCode; } /** *

* The language code used to create your medical transcription job. US English (en-US) is the only * supported language for medical transcriptions. *

* * @return The language code used to create your medical transcription job. US English (en-US) is the * only supported language for medical transcriptions. * @see LanguageCode */ public String getLanguageCode() { return this.languageCode; } /** *

* The language code used to create your medical transcription job. US English (en-US) is the only * supported language for medical transcriptions. *

* * @param languageCode * The language code used to create your medical transcription job. US English (en-US) is the * only supported language for medical transcriptions. * @return Returns a reference to this object so that method calls can be chained together. * @see LanguageCode */ public MedicalTranscriptionJob withLanguageCode(String languageCode) { setLanguageCode(languageCode); return this; } /** *

* The language code used to create your medical transcription job. US English (en-US) is the only * supported language for medical transcriptions. *

* * @param languageCode * The language code used to create your medical transcription job. US English (en-US) is the * only supported language for medical transcriptions. * @return Returns a reference to this object so that method calls can be chained together. * @see LanguageCode */ public MedicalTranscriptionJob withLanguageCode(LanguageCode languageCode) { this.languageCode = languageCode.toString(); return this; } /** *

* The sample rate, in hertz, of the audio track in your input media file. *

* * @param mediaSampleRateHertz * The sample rate, in hertz, of the audio track in your input media file. */ public void setMediaSampleRateHertz(Integer mediaSampleRateHertz) { this.mediaSampleRateHertz = mediaSampleRateHertz; } /** *

* The sample rate, in hertz, of the audio track in your input media file. *

* * @return The sample rate, in hertz, of the audio track in your input media file. */ public Integer getMediaSampleRateHertz() { return this.mediaSampleRateHertz; } /** *

* The sample rate, in hertz, of the audio track in your input media file. *

* * @param mediaSampleRateHertz * The sample rate, in hertz, of the audio track in your input media file. * @return Returns a reference to this object so that method calls can be chained together. */ public MedicalTranscriptionJob withMediaSampleRateHertz(Integer mediaSampleRateHertz) { setMediaSampleRateHertz(mediaSampleRateHertz); return this; } /** *

* The format of the input media file. *

* * @param mediaFormat * The format of the input media file. * @see MediaFormat */ public void setMediaFormat(String mediaFormat) { this.mediaFormat = mediaFormat; } /** *

* The format of the input media file. *

* * @return The format of the input media file. * @see MediaFormat */ public String getMediaFormat() { return this.mediaFormat; } /** *

* The format of the input media file. *

* * @param mediaFormat * The format of the input media file. * @return Returns a reference to this object so that method calls can be chained together. * @see MediaFormat */ public MedicalTranscriptionJob withMediaFormat(String mediaFormat) { setMediaFormat(mediaFormat); return this; } /** *

* The format of the input media file. *

* * @param mediaFormat * The format of the input media file. * @return Returns a reference to this object so that method calls can be chained together. * @see MediaFormat */ public MedicalTranscriptionJob withMediaFormat(MediaFormat mediaFormat) { this.mediaFormat = mediaFormat.toString(); return this; } /** * @param media */ public void setMedia(Media media) { this.media = media; } /** * @return */ public Media getMedia() { return this.media; } /** * @param media * @return Returns a reference to this object so that method calls can be chained together. */ public MedicalTranscriptionJob withMedia(Media media) { setMedia(media); return this; } /** *

* Provides you with the Amazon S3 URI you can use to access your transcript. *

* * @param transcript * Provides you with the Amazon S3 URI you can use to access your transcript. */ public void setTranscript(MedicalTranscript transcript) { this.transcript = transcript; } /** *

* Provides you with the Amazon S3 URI you can use to access your transcript. *

* * @return Provides you with the Amazon S3 URI you can use to access your transcript. */ public MedicalTranscript getTranscript() { return this.transcript; } /** *

* Provides you with the Amazon S3 URI you can use to access your transcript. *

* * @param transcript * Provides you with the Amazon S3 URI you can use to access your transcript. * @return Returns a reference to this object so that method calls can be chained together. */ public MedicalTranscriptionJob withTranscript(MedicalTranscript transcript) { setTranscript(transcript); return this; } /** *

* The date and time the specified medical transcription job began processing. *

*

* Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, * 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started processing at 12:32 PM * UTC-7 on May 4, 2022. *

* * @param startTime * The date and time the specified medical transcription job began processing.

*

* Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, * 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started processing at * 12:32 PM UTC-7 on May 4, 2022. */ public void setStartTime(java.util.Date startTime) { this.startTime = startTime; } /** *

* The date and time the specified medical transcription job began processing. *

*

* Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, * 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started processing at 12:32 PM * UTC-7 on May 4, 2022. *

* * @return The date and time the specified medical transcription job began processing.

*

* Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, * 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started processing at * 12:32 PM UTC-7 on May 4, 2022. */ public java.util.Date getStartTime() { return this.startTime; } /** *

* The date and time the specified medical transcription job began processing. *

*

* Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, * 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started processing at 12:32 PM * UTC-7 on May 4, 2022. *

* * @param startTime * The date and time the specified medical transcription job began processing.

*

* Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, * 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started processing at * 12:32 PM UTC-7 on May 4, 2022. * @return Returns a reference to this object so that method calls can be chained together. */ public MedicalTranscriptionJob withStartTime(java.util.Date startTime) { setStartTime(startTime); return this; } /** *

* The date and time the specified medical transcription job request was made. *

*

* Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, * 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started processing at 12:32 PM * UTC-7 on May 4, 2022. *

* * @param creationTime * The date and time the specified medical transcription job request was made.

*

* Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, * 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started processing at * 12:32 PM UTC-7 on May 4, 2022. */ public void setCreationTime(java.util.Date creationTime) { this.creationTime = creationTime; } /** *

* The date and time the specified medical transcription job request was made. *

*

* Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, * 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started processing at 12:32 PM * UTC-7 on May 4, 2022. *

* * @return The date and time the specified medical transcription job request was made.

*

* Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, * 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started processing at * 12:32 PM UTC-7 on May 4, 2022. */ public java.util.Date getCreationTime() { return this.creationTime; } /** *

* The date and time the specified medical transcription job request was made. *

*

* Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, * 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started processing at 12:32 PM * UTC-7 on May 4, 2022. *

* * @param creationTime * The date and time the specified medical transcription job request was made.

*

* Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, * 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started processing at * 12:32 PM UTC-7 on May 4, 2022. * @return Returns a reference to this object so that method calls can be chained together. */ public MedicalTranscriptionJob withCreationTime(java.util.Date creationTime) { setCreationTime(creationTime); return this; } /** *

* The date and time the specified medical transcription job finished processing. *

*

* Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, * 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started processing at 12:33 PM * UTC-7 on May 4, 2022. *

* * @param completionTime * The date and time the specified medical transcription job finished processing.

*

* Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, * 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started processing at * 12:33 PM UTC-7 on May 4, 2022. */ public void setCompletionTime(java.util.Date completionTime) { this.completionTime = completionTime; } /** *

* The date and time the specified medical transcription job finished processing. *

*

* Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, * 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started processing at 12:33 PM * UTC-7 on May 4, 2022. *

* * @return The date and time the specified medical transcription job finished processing.

*

* Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, * 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started processing at * 12:33 PM UTC-7 on May 4, 2022. */ public java.util.Date getCompletionTime() { return this.completionTime; } /** *

* The date and time the specified medical transcription job finished processing. *

*

* Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, * 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started processing at 12:33 PM * UTC-7 on May 4, 2022. *

* * @param completionTime * The date and time the specified medical transcription job finished processing.

*

* Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, * 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started processing at * 12:33 PM UTC-7 on May 4, 2022. * @return Returns a reference to this object so that method calls can be chained together. */ public MedicalTranscriptionJob withCompletionTime(java.util.Date completionTime) { setCompletionTime(completionTime); return this; } /** *

* If TranscriptionJobStatus is FAILED, FailureReason contains information * about why the transcription job request failed. *

*

* The FailureReason field contains one of the following values: *

* * * @param failureReason * If TranscriptionJobStatus is FAILED, FailureReason contains * information about why the transcription job request failed.

*

* The FailureReason field contains one of the following values: *

*