/* * 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.
*
* 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.
*
* The language code used to create your medical transcription job. US English (en-US
) is the only
* supported language for medical transcriptions.
*
* 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.
*
* 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.
*
* 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.
*
* 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 MediaFormat 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 Guidelines and 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 Guidelines and quotas. *
** 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.
*
* The tags, each in the form of a key:value pair, assigned to the specified medical transcription job. *
*/ private java.util.List* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
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.
*
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.
*
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.
*
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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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 MediaFormat 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 Guidelines and 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 Guidelines and quotas. *
*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 MediaFormat 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 Guidelines and * 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 Guidelines and * quotas. *
*
* 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 MediaFormat 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 Guidelines and 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 Guidelines and quotas. *
*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 MediaFormat 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 Guidelines and * 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 Guidelines * and quotas. *
*
* 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 MediaFormat 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 Guidelines and 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 Guidelines and quotas. *
*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 MediaFormat 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 Guidelines and * 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 Guidelines and * quotas. *
** 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.
*
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.
*
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.
*
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.
*
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* 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* 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* 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