/* * Copyright 2010-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; /** *
* 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. *
*
* Constraints:
* Length: 1 - 200
* Pattern: ^[0-9a-zA-Z._-]+
*/
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.
*
* Constraints:
* Allowed Values: QUEUED, IN_PROGRESS, FAILED, COMPLETED
*/
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.
*
* Constraints:
* Allowed Values: af-ZA, ar-AE, ar-SA, da-DK, de-CH, de-DE, en-AB,
* en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA,
* fr-FR, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR,
* pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ,
* vi-VN, sv-SE
*/
private String languageCode;
/**
*
* The sample rate, in hertz, of the audio track in your input media file. *
*
* Constraints:
* Range: 16000 - 48000
*/
private Integer mediaSampleRateHertz;
/**
*
* The format of the input media file. *
*
* Constraints:
* Allowed Values: mp3, mp4, wav, flac, ogg, amr, webm
*/
private String mediaFormat;
/**
*
* Describes the Amazon S3 location of the media file you want to use in * your request. *
** For information on supported media formats, refer to the MediaFormat parameter or the Media formats section in the Amazon S3 Developer Guide. *
*/ 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. *
*
* Constraints:
* Allowed Values: PHI
*/
private String contentIdentificationType;
/**
*
* Describes the medical specialty represented in your media. *
*
* Constraints:
* Allowed Values: PRIMARYCARE
*/
private String specialty;
/**
*
* Indicates whether the input media is a dictation or a conversation, as
* specified in the StartMedicalTranscriptionJob
request.
*
* Constraints:
* Allowed Values: CONVERSATION, DICTATION
*/
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* The name of the medical transcription job. Job names are case sensitive * and must be unique within an Amazon Web Services account. *
*
* Constraints:
* Length: 1 - 200
* Pattern: ^[0-9a-zA-Z._-]+
*
* @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 medicalTranscriptionJobName; } /** ** The name of the medical transcription job. Job names are case sensitive * and must be unique within an Amazon Web Services account. *
*
* Constraints:
* Length: 1 - 200
* Pattern: ^[0-9a-zA-Z._-]+
*
* @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. *
** Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Length: 1 - 200
* Pattern: ^[0-9a-zA-Z._-]+
*
* @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 A reference to this updated object so that method calls can be * chained together. */ public MedicalTranscriptionJob withMedicalTranscriptionJobName( String medicalTranscriptionJobName) { this.medicalTranscriptionJobName = 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.
*
* Constraints:
* Allowed Values: QUEUED, IN_PROGRESS, FAILED, COMPLETED
*
* @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.
*
* 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.
*
* Constraints:
* Allowed Values: QUEUED, IN_PROGRESS, FAILED, COMPLETED
*
* @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.
*
* 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.
*
* Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Allowed Values: QUEUED, IN_PROGRESS, FAILED, COMPLETED
*
* @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.
*
* 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.
*
* Constraints:
* Allowed Values: QUEUED, IN_PROGRESS, FAILED, COMPLETED
*
* @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.
*
* 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.
*
* Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Allowed Values: QUEUED, IN_PROGRESS, FAILED, COMPLETED
*
* @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.
*
* The language code used to create your medical transcription job. US
* English (en-US
) is the only supported language for medical
* transcriptions.
*
* Constraints:
* Allowed Values: af-ZA, ar-AE, ar-SA, da-DK, de-CH, de-DE, en-AB,
* en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA,
* fr-FR, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR,
* pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ,
* vi-VN, sv-SE
*
* @return
* The language code used to create your medical transcription job.
* US English (en-US
) is the only supported language
* for medical transcriptions.
*
* The language code used to create your medical transcription job. US
* English (en-US
) is the only supported language for medical
* transcriptions.
*
* Constraints:
* Allowed Values: af-ZA, ar-AE, ar-SA, da-DK, de-CH, de-DE, en-AB,
* en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA,
* fr-FR, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR,
* pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ,
* vi-VN, sv-SE
*
* @param languageCode
* The language code used to create your medical transcription
* job. US English (en-US
) is the only supported
* language for medical transcriptions.
*
* The language code used to create your medical transcription job. US
* English (en-US
) is the only supported language for medical
* transcriptions.
*
* Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Allowed Values: af-ZA, ar-AE, ar-SA, da-DK, de-CH, de-DE, en-AB,
* en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA,
* fr-FR, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR,
* pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ,
* vi-VN, sv-SE
*
* @param languageCode
* The language code used to create your medical transcription
* job. US English (en-US
) is the only supported
* language for medical transcriptions.
*
* The language code used to create your medical transcription job. US
* English (en-US
) is the only supported language for medical
* transcriptions.
*
* Constraints:
* Allowed Values: af-ZA, ar-AE, ar-SA, da-DK, de-CH, de-DE, en-AB,
* en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA,
* fr-FR, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR,
* pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ,
* vi-VN, sv-SE
*
* @param languageCode
* The language code used to create your medical transcription
* job. US English (en-US
) is the only supported
* language for medical transcriptions.
*
* The language code used to create your medical transcription job. US
* English (en-US
) is the only supported language for medical
* transcriptions.
*
* Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Allowed Values: af-ZA, ar-AE, ar-SA, da-DK, de-CH, de-DE, en-AB,
* en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA,
* fr-FR, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR,
* pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ,
* vi-VN, sv-SE
*
* @param languageCode
* 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. *
*
* Constraints:
* Range: 16000 - 48000
*
* @return
* The sample rate, in hertz, of the audio track in your input media * file. *
*/ public Integer getMediaSampleRateHertz() { return mediaSampleRateHertz; } /** ** The sample rate, in hertz, of the audio track in your input media file. *
*
* Constraints:
* Range: 16000 - 48000
*
* @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. *
** Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Range: 16000 - 48000
*
* @param mediaSampleRateHertz
* The sample rate, in hertz, of the audio track in your input * media file. *
* @return A reference to this updated object so that method calls can be * chained together. */ public MedicalTranscriptionJob withMediaSampleRateHertz(Integer mediaSampleRateHertz) { this.mediaSampleRateHertz = mediaSampleRateHertz; return this; } /** ** The format of the input media file. *
*
* Constraints:
* Allowed Values: mp3, mp4, wav, flac, ogg, amr, webm
*
* @return
* The format of the input media file. *
* @see MediaFormat */ public String getMediaFormat() { return mediaFormat; } /** ** The format of the input media file. *
*
* Constraints:
* Allowed Values: mp3, mp4, wav, flac, ogg, amr, webm
*
* @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. *
** Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Allowed Values: mp3, mp4, wav, flac, ogg, amr, webm
*
* @param mediaFormat
* The format of the input media file. *
* @return A reference to this updated object so that method calls can be * chained together. * @see MediaFormat */ public MedicalTranscriptionJob withMediaFormat(String mediaFormat) { this.mediaFormat = mediaFormat; return this; } /** ** The format of the input media file. *
*
* Constraints:
* Allowed Values: mp3, mp4, wav, flac, ogg, amr, webm
*
* @param mediaFormat
* The format of the input media file. *
* @see MediaFormat */ public void setMediaFormat(MediaFormat mediaFormat) { this.mediaFormat = mediaFormat.toString(); } /** ** The format of the input media file. *
** Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Allowed Values: mp3, mp4, wav, flac, ogg, amr, webm
*
* @param mediaFormat
* The format of the input media file. *
* @return A reference to this updated object so that method calls can be * chained together. * @see MediaFormat */ public MedicalTranscriptionJob withMediaFormat(MediaFormat mediaFormat) { this.mediaFormat = mediaFormat.toString(); return this; } /** ** Describes the Amazon S3 location of the media file you want to use in * your request. *
** For information on supported media formats, refer to the MediaFormat parameter or the Media formats section in the Amazon S3 Developer Guide. *
* * @return* Describes the Amazon S3 location of the media file you want to * use in your request. *
** For information on supported media formats, refer to the MediaFormat parameter or the Media formats section in the Amazon S3 Developer Guide. *
*/ public Media getMedia() { return media; } /** ** Describes the Amazon S3 location of the media file you want to use in * your request. *
** For information on supported media formats, refer to the MediaFormat parameter or the Media formats section in the Amazon S3 Developer Guide. *
* * @param media* Describes the Amazon S3 location of the media file you want to * use in your request. *
** For information on supported media formats, refer to the MediaFormat parameter or the Media formats section in the Amazon S3 Developer Guide. *
*/ public void setMedia(Media media) { this.media = media; } /** ** Describes the Amazon S3 location of the media file you want to use in * your request. *
** For information on supported media formats, refer to the MediaFormat parameter or the Media formats section in the Amazon S3 Developer Guide. *
** Returns a reference to this object so that method calls can be chained * together. * * @param media
* Describes the Amazon S3 location of the media file you want to * use in your request. *
** For information on supported media formats, refer to the MediaFormat parameter or the Media formats section in the Amazon S3 Developer Guide. *
* @return A reference to this updated object so that method calls can be * chained together. */ public MedicalTranscriptionJob withMedia(Media media) { this.media = media; return this; } /** ** 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 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. *
*/ public void setTranscript(MedicalTranscript transcript) { this.transcript = transcript; } /** ** Provides you with the Amazon S3 URI you can use to access your * transcript. *
** Returns a reference to this object so that method calls can be chained * together. * * @param transcript
* Provides you with the Amazon S3 URI you can use to access your * transcript. *
* @return A reference to this updated object so that method calls can be * chained together. */ public MedicalTranscriptionJob withTranscript(MedicalTranscript transcript) { this.transcript = 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.
*
* 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 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 * 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 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.
*
* Returns a reference to this object so that method calls can be chained * together. * * @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.
*
* 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 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 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 * 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 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.
*
* Returns a reference to this object so that method calls can be chained * together. * * @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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* Returns a reference to this object so that method calls can be chained * together. * * @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.
*
* 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. *
*
* 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. *
*
* 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. *
*
* 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. *
*
* 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. *
** Returns a reference to this object so that method calls can be chained * together. * * @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 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. *
* * @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 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. *
*/ 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. *
** Returns a reference to this object so that method calls can be chained * together. * * @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 A reference to this updated object so that method calls can be * chained together. */ public MedicalTranscriptionJob withSettings(MedicalTranscriptionSetting settings) { this.settings = settings; return this; } /** ** Indicates whether content identification was enabled for your * transcription request. *
*
* Constraints:
* Allowed Values: PHI
*
* @return
* Indicates whether content identification was enabled for your * transcription request. *
* @see MedicalContentIdentificationType */ public String getContentIdentificationType() { return contentIdentificationType; } /** ** Indicates whether content identification was enabled for your * transcription request. *
*
* Constraints:
* Allowed Values: PHI
*
* @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. *
** Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Allowed Values: PHI
*
* @param contentIdentificationType
* Indicates whether content identification was enabled for your * transcription request. *
* @return A reference to this updated object so that method calls can be * chained together. * @see MedicalContentIdentificationType */ public MedicalTranscriptionJob withContentIdentificationType(String contentIdentificationType) { this.contentIdentificationType = contentIdentificationType; return this; } /** ** Indicates whether content identification was enabled for your * transcription request. *
*
* Constraints:
* Allowed Values: PHI
*
* @param contentIdentificationType
* Indicates whether content identification was enabled for your * transcription request. *
* @see MedicalContentIdentificationType */ public void setContentIdentificationType( MedicalContentIdentificationType contentIdentificationType) { this.contentIdentificationType = contentIdentificationType.toString(); } /** ** Indicates whether content identification was enabled for your * transcription request. *
** Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Allowed Values: PHI
*
* @param contentIdentificationType
* Indicates whether content identification was enabled for your * transcription request. *
* @return A reference to this updated 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. *
*
* Constraints:
* Allowed Values: PRIMARYCARE
*
* @return
* Describes the medical specialty represented in your media. *
* @see Specialty */ public String getSpecialty() { return specialty; } /** ** Describes the medical specialty represented in your media. *
*
* Constraints:
* Allowed Values: PRIMARYCARE
*
* @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. *
** Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Allowed Values: PRIMARYCARE
*
* @param specialty
* Describes the medical specialty represented in your media. *
* @return A reference to this updated object so that method calls can be * chained together. * @see Specialty */ public MedicalTranscriptionJob withSpecialty(String specialty) { this.specialty = specialty; return this; } /** ** Describes the medical specialty represented in your media. *
*
* Constraints:
* Allowed Values: PRIMARYCARE
*
* @param specialty
* Describes the medical specialty represented in your media. *
* @see Specialty */ public void setSpecialty(Specialty specialty) { this.specialty = specialty.toString(); } /** ** Describes the medical specialty represented in your media. *
** Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Allowed Values: PRIMARYCARE
*
* @param specialty
* Describes the medical specialty represented in your media. *
* @return A reference to this updated 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.
*
* Constraints:
* Allowed Values: CONVERSATION, DICTATION
*
* @return
* Indicates whether the input media is a dictation or a
* conversation, as specified in the
* StartMedicalTranscriptionJob
request.
*
* Indicates whether the input media is a dictation or a conversation, as
* specified in the StartMedicalTranscriptionJob
request.
*
* Constraints:
* Allowed Values: CONVERSATION, DICTATION
*
* @param type
* Indicates whether the input media is a dictation or a
* conversation, as specified in the
* StartMedicalTranscriptionJob
request.
*
* Indicates whether the input media is a dictation or a conversation, as
* specified in the StartMedicalTranscriptionJob
request.
*
* Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Allowed Values: CONVERSATION, DICTATION
*
* @param type
* Indicates whether the input media is a dictation or a
* conversation, as specified in the
* StartMedicalTranscriptionJob
request.
*
* Indicates whether the input media is a dictation or a conversation, as
* specified in the StartMedicalTranscriptionJob
request.
*
* Constraints:
* Allowed Values: CONVERSATION, DICTATION
*
* @param type
* Indicates whether the input media is a dictation or a
* conversation, as specified in the
* StartMedicalTranscriptionJob
request.
*
* Indicates whether the input media is a dictation or a conversation, as
* specified in the StartMedicalTranscriptionJob
request.
*
* Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Allowed Values: CONVERSATION, DICTATION
*
* @param type
* 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. *
* * @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. *
** Returns a reference to this object so that method calls can be chained * together. * * @param tags
* The tags, each in the form of a key:value pair, assigned to * the specified medical transcription job. *
* @return A reference to this updated object so that method calls can be * chained together. */ public MedicalTranscriptionJob withTags(Tag... tags) { if (getTags() == null) { this.tags = new java.util.ArrayList* The tags, each in the form of a key:value pair, assigned to the specified * medical transcription job. *
** Returns a reference to this object so that method calls can be chained * together. * * @param tags
* The tags, each in the form of a key:value pair, assigned to * the specified medical transcription job. *
* @return A reference to this updated object so that method calls can be * chained together. */ public MedicalTranscriptionJob withTags(java.util.Collection