com.amazonaws.services.transcribe.model.MedicalTranscriptionJob Maven / Gradle / Ivy
/*
* Copyright 2019-2024 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:
*
*
* -
*
* Unsupported media format.
*
*
* The media format specified in MediaFormat isn't valid. Refer to refer to the
* MediaFormat parameter for a list of supported formats.
*
*
* -
*
* The media format provided does not match the detected media format.
*
*
* The media format specified in MediaFormat doesn't match the format of the input file. Check the
* media format of your media file and correct the specified value.
*
*
* -
*
* Invalid sample rate for audio file.
*
*
* The sample rate specified in MediaSampleRateHertz isn't valid. The sample rate must be between
* 16,000 and 48,000 hertz.
*
*
* -
*
* The sample rate provided does not match the detected sample rate.
*
*
* The sample rate specified in MediaSampleRateHertz doesn't match the sample rate detected in your
* input media file. Check the sample rate of your media file and correct the specified value.
*
*
* -
*
* Invalid file size: file size too large.
*
*
* The size of your media file is larger than what Amazon Transcribe can process. For more information, refer to Service quotas.
*
*
* -
*
* Invalid number of channels: number of channels too large.
*
*
* Your audio contains more channels than Amazon Transcribe is able to process. For more information, refer to Service quotas.
*
*
*
*/
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:
*
*
* -
*
* Unsupported media format.
*
*
* The media format specified in MediaFormat isn't valid. Refer to refer to the
* MediaFormat parameter for a list of supported formats.
*
*
* -
*
* The media format provided does not match the detected media format.
*
*
* The media format specified in MediaFormat doesn't match the format of the input file. Check the
* media format of your media file and correct the specified value.
*
*
* -
*
* Invalid sample rate for audio file.
*
*
* The sample rate specified in MediaSampleRateHertz isn't valid. The sample rate must be between
* 16,000 and 48,000 hertz.
*
*
* -
*
* The sample rate provided does not match the detected sample rate.
*
*
* The sample rate specified in MediaSampleRateHertz doesn't match the sample rate detected in your
* input media file. Check the sample rate of your media file and correct the specified value.
*
*
* -
*
* Invalid file size: file size too large.
*
*
* The size of your media file is larger than what Amazon Transcribe can process. For more information, refer to Service quotas.
*
*
* -
*
* Invalid number of channels: number of channels too large.
*
*
* Your audio contains more channels than Amazon Transcribe is able to process. For more information, refer to Service quotas.
*
*
*
*
* @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:
*
*
* -
*
* Unsupported media format.
*
*
* The media format specified in MediaFormat isn't valid. Refer to refer to the
* MediaFormat parameter for a list of supported formats.
*
*
* -
*
* The media format provided does not match the detected media format.
*
*
* The media format specified in MediaFormat doesn't match the format of the input file. Check
* the media format of your media file and correct the specified value.
*
*
* -
*
* Invalid sample rate for audio file.
*
*
* The sample rate specified in MediaSampleRateHertz isn't valid. The sample rate must be
* between 16,000 and 48,000 hertz.
*
*
* -
*
* The sample rate provided does not match the detected sample rate.
*
*
* The sample rate specified in MediaSampleRateHertz doesn't match the sample rate detected in
* your input media file. Check the sample rate of your media file and correct the specified value.
*
*
* -
*
* Invalid file size: file size too large.
*
*
* The size of your media file is larger than what Amazon Transcribe can process. For more information, refer
* to Service
* quotas.
*
*
* -
*
* Invalid number of channels: number of channels too large.
*
*
* Your audio contains more channels than Amazon Transcribe is able to process. For more information, refer
* to Service
* quotas.
*
*
*/
public void setFailureReason(String failureReason) {
this.failureReason = failureReason;
}
/**
*
* If TranscriptionJobStatus is FAILED, FailureReason contains information
* about why the transcription job request failed.
*
*
* The FailureReason field contains one of the following values:
*
*
* -
*
* Unsupported media format.
*
*
* The media format specified in MediaFormat isn't valid. Refer to refer to the
* MediaFormat parameter for a list of supported formats.
*
*
* -
*
* The media format provided does not match the detected media format.
*
*
* The media format specified in MediaFormat doesn't match the format of the input file. Check the
* media format of your media file and correct the specified value.
*
*
* -
*
* Invalid sample rate for audio file.
*
*
* The sample rate specified in MediaSampleRateHertz isn't valid. The sample rate must be between
* 16,000 and 48,000 hertz.
*
*
* -
*
* The sample rate provided does not match the detected sample rate.
*
*
* The sample rate specified in MediaSampleRateHertz doesn't match the sample rate detected in your
* input media file. Check the sample rate of your media file and correct the specified value.
*
*
* -
*
* Invalid file size: file size too large.
*
*
* The size of your media file is larger than what Amazon Transcribe can process. For more information, refer to Service quotas.
*
*
* -
*
* Invalid number of channels: number of channels too large.
*
*
* Your audio contains more channels than Amazon Transcribe is able to process. For more information, refer to Service quotas.
*
*
*
*
* @return If TranscriptionJobStatus is FAILED, FailureReason contains
* information about why the transcription job request failed.
*
* The FailureReason field contains one of the following values:
*
*
* -
*
* Unsupported media format.
*
*
* The media format specified in MediaFormat isn't valid. Refer to refer to the
* MediaFormat parameter for a list of supported formats.
*
*
* -
*
* The media format provided does not match the detected media format.
*
*
* The media format specified in MediaFormat doesn't match the format of the input file. Check
* the media format of your media file and correct the specified value.
*
*
* -
*
* Invalid sample rate for audio file.
*
*
* The sample rate specified in MediaSampleRateHertz isn't valid. The sample rate must be
* between 16,000 and 48,000 hertz.
*
*
* -
*
* The sample rate provided does not match the detected sample rate.
*
*
* The sample rate specified in MediaSampleRateHertz doesn't match the sample rate detected in
* your input media file. Check the sample rate of your media file and correct the specified value.
*
*
* -
*
* Invalid file size: file size too large.
*
*
* The size of your media file is larger than what Amazon Transcribe can process. For more information,
* refer to Service
* quotas.
*
*
* -
*
* Invalid number of channels: number of channels too large.
*
*
* Your audio contains more channels than Amazon Transcribe is able to process. For more information, refer
* to Service
* quotas.
*
*
*/
public String getFailureReason() {
return this.failureReason;
}
/**
*
* If TranscriptionJobStatus is FAILED, FailureReason contains information
* about why the transcription job request failed.
*
*
* The FailureReason field contains one of the following values:
*
*
* -
*
* Unsupported media format.
*
*
* The media format specified in MediaFormat isn't valid. Refer to refer to the
* MediaFormat parameter for a list of supported formats.
*
*
* -
*
* The media format provided does not match the detected media format.
*
*
* The media format specified in MediaFormat doesn't match the format of the input file. Check the
* media format of your media file and correct the specified value.
*
*
* -
*
* Invalid sample rate for audio file.
*
*
* The sample rate specified in MediaSampleRateHertz isn't valid. The sample rate must be between
* 16,000 and 48,000 hertz.
*
*
* -
*
* The sample rate provided does not match the detected sample rate.
*
*
* The sample rate specified in MediaSampleRateHertz doesn't match the sample rate detected in your
* input media file. Check the sample rate of your media file and correct the specified value.
*
*
* -
*
* Invalid file size: file size too large.
*
*
* The size of your media file is larger than what Amazon Transcribe can process. For more information, refer to Service quotas.
*
*
* -
*
* Invalid number of channels: number of channels too large.
*
*
* Your audio contains more channels than Amazon Transcribe is able to process. For more information, refer to Service quotas.
*
*
*
*
* @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:
*
*
* -
*
* Unsupported media format.
*
*
* The media format specified in MediaFormat isn't valid. Refer to refer to the
* MediaFormat parameter for a list of supported formats.
*
*
* -
*
* The media format provided does not match the detected media format.
*
*
* The media format specified in MediaFormat doesn't match the format of the input file. Check
* the media format of your media file and correct the specified value.
*
*
* -
*
* Invalid sample rate for audio file.
*
*
* The sample rate specified in MediaSampleRateHertz isn't valid. The sample rate must be
* between 16,000 and 48,000 hertz.
*
*
* -
*
* The sample rate provided does not match the detected sample rate.
*
*
* The sample rate specified in MediaSampleRateHertz doesn't match the sample rate detected in
* your input media file. Check the sample rate of your media file and correct the specified value.
*
*
* -
*
* Invalid file size: file size too large.
*
*
* The size of your media file is larger than what Amazon Transcribe can process. For more information, refer
* to Service
* quotas.
*
*
* -
*
* Invalid number of channels: number of channels too large.
*
*
* Your audio contains more channels than Amazon Transcribe is able to process. For more information, refer
* to Service
* quotas.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public MedicalTranscriptionJob withFailureReason(String failureReason) {
setFailureReason(failureReason);
return this;
}
/**
*
* 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.
*
*
* @param settings
* 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.
*/
public void setSettings(MedicalTranscriptionSetting settings) {
this.settings = settings;
}
/**
*
* 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.
*
*
* @return 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.
*/
public MedicalTranscriptionSetting getSettings() {
return this.settings;
}
/**
*
* 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.
*
*
* @param settings
* 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public MedicalTranscriptionJob withSettings(MedicalTranscriptionSetting settings) {
setSettings(settings);
return this;
}
/**
*
* Indicates whether content identification was enabled for your transcription request.
*
*
* @param contentIdentificationType
* Indicates whether content identification was enabled for your transcription request.
* @see MedicalContentIdentificationType
*/
public void setContentIdentificationType(String contentIdentificationType) {
this.contentIdentificationType = contentIdentificationType;
}
/**
*
* Indicates whether content identification was enabled for your transcription request.
*
*
* @return Indicates whether content identification was enabled for your transcription request.
* @see MedicalContentIdentificationType
*/
public String getContentIdentificationType() {
return this.contentIdentificationType;
}
/**
*
* Indicates whether content identification was enabled for your transcription request.
*
*
* @param contentIdentificationType
* Indicates whether content identification was enabled for your transcription request.
* @return Returns a reference to this object so that method calls can be chained together.
* @see MedicalContentIdentificationType
*/
public MedicalTranscriptionJob withContentIdentificationType(String contentIdentificationType) {
setContentIdentificationType(contentIdentificationType);
return this;
}
/**
*
* Indicates whether content identification was enabled for your transcription request.
*
*
* @param contentIdentificationType
* Indicates whether content identification was enabled for your transcription request.
* @return Returns a reference to this object so that method calls can be chained together.
* @see MedicalContentIdentificationType
*/
public MedicalTranscriptionJob withContentIdentificationType(MedicalContentIdentificationType contentIdentificationType) {
this.contentIdentificationType = contentIdentificationType.toString();
return this;
}
/**
*
* Describes the medical specialty represented in your media.
*
*
* @param specialty
* Describes the medical specialty represented in your media.
* @see Specialty
*/
public void setSpecialty(String specialty) {
this.specialty = specialty;
}
/**
*
* Describes the medical specialty represented in your media.
*
*
* @return Describes the medical specialty represented in your media.
* @see Specialty
*/
public String getSpecialty() {
return this.specialty;
}
/**
*
* Describes the medical specialty represented in your media.
*
*
* @param specialty
* Describes the medical specialty represented in your media.
* @return Returns a reference to this object so that method calls can be chained together.
* @see Specialty
*/
public MedicalTranscriptionJob withSpecialty(String specialty) {
setSpecialty(specialty);
return this;
}
/**
*
* Describes the medical specialty represented in your media.
*
*
* @param specialty
* Describes the medical specialty represented in your media.
* @return Returns a reference to this object so that method calls can be chained together.
* @see Specialty
*/
public MedicalTranscriptionJob withSpecialty(Specialty specialty) {
this.specialty = specialty.toString();
return this;
}
/**
*
* Indicates whether the input media is a dictation or a conversation, as specified in the
* StartMedicalTranscriptionJob request.
*
*
* @param type
* Indicates whether the input media is a dictation or a conversation, as specified in the
* StartMedicalTranscriptionJob request.
* @see Type
*/
public void setType(String type) {
this.type = type;
}
/**
*
* Indicates whether the input media is a dictation or a conversation, as specified in the
* StartMedicalTranscriptionJob request.
*
*
* @return Indicates whether the input media is a dictation or a conversation, as specified in the
* StartMedicalTranscriptionJob request.
* @see Type
*/
public String getType() {
return this.type;
}
/**
*
* Indicates whether the input media is a dictation or a conversation, as specified in the
* StartMedicalTranscriptionJob request.
*
*
* @param type
* Indicates whether the input media is a dictation or a conversation, as specified in the
* StartMedicalTranscriptionJob request.
* @return Returns a reference to this object so that method calls can be chained together.
* @see Type
*/
public MedicalTranscriptionJob withType(String type) {
setType(type);
return this;
}
/**
*
* Indicates whether the input media is a dictation or a conversation, as specified in the
* StartMedicalTranscriptionJob request.
*
*
* @param type
* Indicates whether the input media is a dictation or a conversation, as specified in the
* StartMedicalTranscriptionJob request.
* @return Returns a reference to this object so that method calls can be chained together.
* @see Type
*/
public MedicalTranscriptionJob withType(Type type) {
this.type = type.toString();
return this;
}
/**
*
* The tags, each in the form of a key:value pair, assigned to the specified medical transcription job.
*
*
* @return The tags, each in the form of a key:value pair, assigned to the specified medical transcription job.
*/
public java.util.List getTags() {
return tags;
}
/**
*
* The tags, each in the form of a key:value pair, assigned to the specified medical transcription job.
*
*
* @param tags
* The tags, each in the form of a key:value pair, assigned to the specified medical transcription job.
*/
public void setTags(java.util.Collection tags) {
if (tags == null) {
this.tags = null;
return;
}
this.tags = new java.util.ArrayList(tags);
}
/**
*
* The tags, each in the form of a key:value pair, assigned to the specified medical transcription job.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param tags
* The tags, each in the form of a key:value pair, assigned to the specified medical transcription job.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public MedicalTranscriptionJob withTags(Tag... tags) {
if (this.tags == null) {
setTags(new java.util.ArrayList(tags.length));
}
for (Tag ele : tags) {
this.tags.add(ele);
}
return this;
}
/**
*
* The tags, each in the form of a key:value pair, assigned to the specified medical transcription job.
*
*
* @param tags
* The tags, each in the form of a key:value pair, assigned to the specified medical transcription job.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public MedicalTranscriptionJob withTags(java.util.Collection tags) {
setTags(tags);
return this;
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getMedicalTranscriptionJobName() != null)
sb.append("MedicalTranscriptionJobName: ").append(getMedicalTranscriptionJobName()).append(",");
if (getTranscriptionJobStatus() != null)
sb.append("TranscriptionJobStatus: ").append(getTranscriptionJobStatus()).append(",");
if (getLanguageCode() != null)
sb.append("LanguageCode: ").append(getLanguageCode()).append(",");
if (getMediaSampleRateHertz() != null)
sb.append("MediaSampleRateHertz: ").append(getMediaSampleRateHertz()).append(",");
if (getMediaFormat() != null)
sb.append("MediaFormat: ").append(getMediaFormat()).append(",");
if (getMedia() != null)
sb.append("Media: ").append(getMedia()).append(",");
if (getTranscript() != null)
sb.append("Transcript: ").append(getTranscript()).append(",");
if (getStartTime() != null)
sb.append("StartTime: ").append(getStartTime()).append(",");
if (getCreationTime() != null)
sb.append("CreationTime: ").append(getCreationTime()).append(",");
if (getCompletionTime() != null)
sb.append("CompletionTime: ").append(getCompletionTime()).append(",");
if (getFailureReason() != null)
sb.append("FailureReason: ").append(getFailureReason()).append(",");
if (getSettings() != null)
sb.append("Settings: ").append(getSettings()).append(",");
if (getContentIdentificationType() != null)
sb.append("ContentIdentificationType: ").append(getContentIdentificationType()).append(",");
if (getSpecialty() != null)
sb.append("Specialty: ").append(getSpecialty()).append(",");
if (getType() != null)
sb.append("Type: ").append(getType()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof MedicalTranscriptionJob == false)
return false;
MedicalTranscriptionJob other = (MedicalTranscriptionJob) obj;
if (other.getMedicalTranscriptionJobName() == null ^ this.getMedicalTranscriptionJobName() == null)
return false;
if (other.getMedicalTranscriptionJobName() != null && other.getMedicalTranscriptionJobName().equals(this.getMedicalTranscriptionJobName()) == false)
return false;
if (other.getTranscriptionJobStatus() == null ^ this.getTranscriptionJobStatus() == null)
return false;
if (other.getTranscriptionJobStatus() != null && other.getTranscriptionJobStatus().equals(this.getTranscriptionJobStatus()) == false)
return false;
if (other.getLanguageCode() == null ^ this.getLanguageCode() == null)
return false;
if (other.getLanguageCode() != null && other.getLanguageCode().equals(this.getLanguageCode()) == false)
return false;
if (other.getMediaSampleRateHertz() == null ^ this.getMediaSampleRateHertz() == null)
return false;
if (other.getMediaSampleRateHertz() != null && other.getMediaSampleRateHertz().equals(this.getMediaSampleRateHertz()) == false)
return false;
if (other.getMediaFormat() == null ^ this.getMediaFormat() == null)
return false;
if (other.getMediaFormat() != null && other.getMediaFormat().equals(this.getMediaFormat()) == false)
return false;
if (other.getMedia() == null ^ this.getMedia() == null)
return false;
if (other.getMedia() != null && other.getMedia().equals(this.getMedia()) == false)
return false;
if (other.getTranscript() == null ^ this.getTranscript() == null)
return false;
if (other.getTranscript() != null && other.getTranscript().equals(this.getTranscript()) == false)
return false;
if (other.getStartTime() == null ^ this.getStartTime() == null)
return false;
if (other.getStartTime() != null && other.getStartTime().equals(this.getStartTime()) == false)
return false;
if (other.getCreationTime() == null ^ this.getCreationTime() == null)
return false;
if (other.getCreationTime() != null && other.getCreationTime().equals(this.getCreationTime()) == false)
return false;
if (other.getCompletionTime() == null ^ this.getCompletionTime() == null)
return false;
if (other.getCompletionTime() != null && other.getCompletionTime().equals(this.getCompletionTime()) == false)
return false;
if (other.getFailureReason() == null ^ this.getFailureReason() == null)
return false;
if (other.getFailureReason() != null && other.getFailureReason().equals(this.getFailureReason()) == false)
return false;
if (other.getSettings() == null ^ this.getSettings() == null)
return false;
if (other.getSettings() != null && other.getSettings().equals(this.getSettings()) == false)
return false;
if (other.getContentIdentificationType() == null ^ this.getContentIdentificationType() == null)
return false;
if (other.getContentIdentificationType() != null && other.getContentIdentificationType().equals(this.getContentIdentificationType()) == false)
return false;
if (other.getSpecialty() == null ^ this.getSpecialty() == null)
return false;
if (other.getSpecialty() != null && other.getSpecialty().equals(this.getSpecialty()) == false)
return false;
if (other.getType() == null ^ this.getType() == null)
return false;
if (other.getType() != null && other.getType().equals(this.getType()) == false)
return false;
if (other.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getMedicalTranscriptionJobName() == null) ? 0 : getMedicalTranscriptionJobName().hashCode());
hashCode = prime * hashCode + ((getTranscriptionJobStatus() == null) ? 0 : getTranscriptionJobStatus().hashCode());
hashCode = prime * hashCode + ((getLanguageCode() == null) ? 0 : getLanguageCode().hashCode());
hashCode = prime * hashCode + ((getMediaSampleRateHertz() == null) ? 0 : getMediaSampleRateHertz().hashCode());
hashCode = prime * hashCode + ((getMediaFormat() == null) ? 0 : getMediaFormat().hashCode());
hashCode = prime * hashCode + ((getMedia() == null) ? 0 : getMedia().hashCode());
hashCode = prime * hashCode + ((getTranscript() == null) ? 0 : getTranscript().hashCode());
hashCode = prime * hashCode + ((getStartTime() == null) ? 0 : getStartTime().hashCode());
hashCode = prime * hashCode + ((getCreationTime() == null) ? 0 : getCreationTime().hashCode());
hashCode = prime * hashCode + ((getCompletionTime() == null) ? 0 : getCompletionTime().hashCode());
hashCode = prime * hashCode + ((getFailureReason() == null) ? 0 : getFailureReason().hashCode());
hashCode = prime * hashCode + ((getSettings() == null) ? 0 : getSettings().hashCode());
hashCode = prime * hashCode + ((getContentIdentificationType() == null) ? 0 : getContentIdentificationType().hashCode());
hashCode = prime * hashCode + ((getSpecialty() == null) ? 0 : getSpecialty().hashCode());
hashCode = prime * hashCode + ((getType() == null) ? 0 : getType().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
return hashCode;
}
@Override
public MedicalTranscriptionJob clone() {
try {
return (MedicalTranscriptionJob) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.transcribe.model.transform.MedicalTranscriptionJobMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}