@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class MedicalTranscriptionJob extends Object implements Serializable, Cloneable, StructuredPojo
The data structure that contains the information for a medical transcription job.
Constructor and Description |
---|
MedicalTranscriptionJob() |
Modifier and Type | Method and Description |
---|---|
MedicalTranscriptionJob |
clone() |
boolean |
equals(Object obj) |
Date |
getCompletionTime()
A timestamp that shows when the job was completed.
|
Date |
getCreationTime()
A timestamp that shows when the job was created.
|
String |
getFailureReason()
If the
TranscriptionJobStatus field is FAILED , this field contains information about
why the job failed. |
String |
getLanguageCode()
The language code for the language spoken in the source audio file.
|
Media |
getMedia() |
String |
getMediaFormat()
The format of the input media file.
|
Integer |
getMediaSampleRateHertz()
The sample rate, in Hertz, of the source audio containing medical information.
|
String |
getMedicalTranscriptionJobName()
The name for a given medical transcription job.
|
MedicalTranscriptionSetting |
getSettings()
Object that contains object.
|
String |
getSpecialty()
The medical specialty of any clinicians providing a dictation or having a conversation.
|
Date |
getStartTime()
A timestamp that shows when the job started processing.
|
MedicalTranscript |
getTranscript()
An object that contains the
MedicalTranscript . |
String |
getTranscriptionJobStatus()
The completion status of a medical transcription job.
|
String |
getType()
The type of speech in the transcription job.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setCompletionTime(Date completionTime)
A timestamp that shows when the job was completed.
|
void |
setCreationTime(Date creationTime)
A timestamp that shows when the job was created.
|
void |
setFailureReason(String failureReason)
If the
TranscriptionJobStatus field is FAILED , this field contains information about
why the job failed. |
void |
setLanguageCode(String languageCode)
The language code for the language spoken in the source audio file.
|
void |
setMedia(Media media) |
void |
setMediaFormat(String mediaFormat)
The format of the input media file.
|
void |
setMediaSampleRateHertz(Integer mediaSampleRateHertz)
The sample rate, in Hertz, of the source audio containing medical information.
|
void |
setMedicalTranscriptionJobName(String medicalTranscriptionJobName)
The name for a given medical transcription job.
|
void |
setSettings(MedicalTranscriptionSetting settings)
Object that contains object.
|
void |
setSpecialty(String specialty)
The medical specialty of any clinicians providing a dictation or having a conversation.
|
void |
setStartTime(Date startTime)
A timestamp that shows when the job started processing.
|
void |
setTranscript(MedicalTranscript transcript)
An object that contains the
MedicalTranscript . |
void |
setTranscriptionJobStatus(String transcriptionJobStatus)
The completion status of a medical transcription job.
|
void |
setType(String type)
The type of speech in the transcription job.
|
String |
toString()
Returns a string representation of this object.
|
MedicalTranscriptionJob |
withCompletionTime(Date completionTime)
A timestamp that shows when the job was completed.
|
MedicalTranscriptionJob |
withCreationTime(Date creationTime)
A timestamp that shows when the job was created.
|
MedicalTranscriptionJob |
withFailureReason(String failureReason)
If the
TranscriptionJobStatus field is FAILED , this field contains information about
why the job failed. |
MedicalTranscriptionJob |
withLanguageCode(LanguageCode languageCode)
The language code for the language spoken in the source audio file.
|
MedicalTranscriptionJob |
withLanguageCode(String languageCode)
The language code for the language spoken in the source audio file.
|
MedicalTranscriptionJob |
withMedia(Media media) |
MedicalTranscriptionJob |
withMediaFormat(MediaFormat mediaFormat)
The format of the input media file.
|
MedicalTranscriptionJob |
withMediaFormat(String mediaFormat)
The format of the input media file.
|
MedicalTranscriptionJob |
withMediaSampleRateHertz(Integer mediaSampleRateHertz)
The sample rate, in Hertz, of the source audio containing medical information.
|
MedicalTranscriptionJob |
withMedicalTranscriptionJobName(String medicalTranscriptionJobName)
The name for a given medical transcription job.
|
MedicalTranscriptionJob |
withSettings(MedicalTranscriptionSetting settings)
Object that contains object.
|
MedicalTranscriptionJob |
withSpecialty(Specialty specialty)
The medical specialty of any clinicians providing a dictation or having a conversation.
|
MedicalTranscriptionJob |
withSpecialty(String specialty)
The medical specialty of any clinicians providing a dictation or having a conversation.
|
MedicalTranscriptionJob |
withStartTime(Date startTime)
A timestamp that shows when the job started processing.
|
MedicalTranscriptionJob |
withTranscript(MedicalTranscript transcript)
An object that contains the
MedicalTranscript . |
MedicalTranscriptionJob |
withTranscriptionJobStatus(String transcriptionJobStatus)
The completion status of a medical transcription job.
|
MedicalTranscriptionJob |
withTranscriptionJobStatus(TranscriptionJobStatus transcriptionJobStatus)
The completion status of a medical transcription job.
|
MedicalTranscriptionJob |
withType(String type)
The type of speech in the transcription job.
|
MedicalTranscriptionJob |
withType(Type type)
The type of speech in the transcription job.
|
public void setMedicalTranscriptionJobName(String medicalTranscriptionJobName)
The name for a given medical transcription job.
medicalTranscriptionJobName
- The name for a given medical transcription job.public String getMedicalTranscriptionJobName()
The name for a given medical transcription job.
public MedicalTranscriptionJob withMedicalTranscriptionJobName(String medicalTranscriptionJobName)
The name for a given medical transcription job.
medicalTranscriptionJobName
- The name for a given medical transcription job.public void setTranscriptionJobStatus(String transcriptionJobStatus)
The completion status of a medical transcription job.
transcriptionJobStatus
- The completion status of a medical transcription job.TranscriptionJobStatus
public String getTranscriptionJobStatus()
The completion status of a medical transcription job.
TranscriptionJobStatus
public MedicalTranscriptionJob withTranscriptionJobStatus(String transcriptionJobStatus)
The completion status of a medical transcription job.
transcriptionJobStatus
- The completion status of a medical transcription job.TranscriptionJobStatus
public MedicalTranscriptionJob withTranscriptionJobStatus(TranscriptionJobStatus transcriptionJobStatus)
The completion status of a medical transcription job.
transcriptionJobStatus
- The completion status of a medical transcription job.TranscriptionJobStatus
public void setLanguageCode(String languageCode)
The language code for the language spoken in the source audio file. US English (en-US) is the only supported
language for medical transcriptions. Any other value you enter for language code results in a
BadRequestException
error.
languageCode
- The language code for the language spoken in the source audio file. US English (en-US) is the only
supported language for medical transcriptions. Any other value you enter for language code results in a
BadRequestException
error.LanguageCode
public String getLanguageCode()
The language code for the language spoken in the source audio file. US English (en-US) is the only supported
language for medical transcriptions. Any other value you enter for language code results in a
BadRequestException
error.
BadRequestException
error.LanguageCode
public MedicalTranscriptionJob withLanguageCode(String languageCode)
The language code for the language spoken in the source audio file. US English (en-US) is the only supported
language for medical transcriptions. Any other value you enter for language code results in a
BadRequestException
error.
languageCode
- The language code for the language spoken in the source audio file. US English (en-US) is the only
supported language for medical transcriptions. Any other value you enter for language code results in a
BadRequestException
error.LanguageCode
public MedicalTranscriptionJob withLanguageCode(LanguageCode languageCode)
The language code for the language spoken in the source audio file. US English (en-US) is the only supported
language for medical transcriptions. Any other value you enter for language code results in a
BadRequestException
error.
languageCode
- The language code for the language spoken in the source audio file. US English (en-US) is the only
supported language for medical transcriptions. Any other value you enter for language code results in a
BadRequestException
error.LanguageCode
public void setMediaSampleRateHertz(Integer mediaSampleRateHertz)
The sample rate, in Hertz, of the source audio containing medical information.
If you don't specify the sample rate, Amazon Transcribe Medical determines it for you. If you choose to specify
the sample rate, it must match the rate detected by Amazon Transcribe Medical. In most cases, you should leave
the MediaSampleHertz
blank and let Amazon Transcribe Medical determine the sample rate.
mediaSampleRateHertz
- The sample rate, in Hertz, of the source audio containing medical information.
If you don't specify the sample rate, Amazon Transcribe Medical determines it for you. If you choose to
specify the sample rate, it must match the rate detected by Amazon Transcribe Medical. In most cases, you
should leave the MediaSampleHertz
blank and let Amazon Transcribe Medical determine the
sample rate.
public Integer getMediaSampleRateHertz()
The sample rate, in Hertz, of the source audio containing medical information.
If you don't specify the sample rate, Amazon Transcribe Medical determines it for you. If you choose to specify
the sample rate, it must match the rate detected by Amazon Transcribe Medical. In most cases, you should leave
the MediaSampleHertz
blank and let Amazon Transcribe Medical determine the sample rate.
If you don't specify the sample rate, Amazon Transcribe Medical determines it for you. If you choose to
specify the sample rate, it must match the rate detected by Amazon Transcribe Medical. In most cases, you
should leave the MediaSampleHertz
blank and let Amazon Transcribe Medical determine the
sample rate.
public MedicalTranscriptionJob withMediaSampleRateHertz(Integer mediaSampleRateHertz)
The sample rate, in Hertz, of the source audio containing medical information.
If you don't specify the sample rate, Amazon Transcribe Medical determines it for you. If you choose to specify
the sample rate, it must match the rate detected by Amazon Transcribe Medical. In most cases, you should leave
the MediaSampleHertz
blank and let Amazon Transcribe Medical determine the sample rate.
mediaSampleRateHertz
- The sample rate, in Hertz, of the source audio containing medical information.
If you don't specify the sample rate, Amazon Transcribe Medical determines it for you. If you choose to
specify the sample rate, it must match the rate detected by Amazon Transcribe Medical. In most cases, you
should leave the MediaSampleHertz
blank and let Amazon Transcribe Medical determine the
sample rate.
public void setMediaFormat(String mediaFormat)
The format of the input media file.
mediaFormat
- The format of the input media file.MediaFormat
public String getMediaFormat()
The format of the input media file.
MediaFormat
public MedicalTranscriptionJob withMediaFormat(String mediaFormat)
The format of the input media file.
mediaFormat
- The format of the input media file.MediaFormat
public MedicalTranscriptionJob withMediaFormat(MediaFormat mediaFormat)
The format of the input media file.
mediaFormat
- The format of the input media file.MediaFormat
public void setMedia(Media media)
media
- public Media getMedia()
public MedicalTranscriptionJob withMedia(Media media)
media
- public void setTranscript(MedicalTranscript transcript)
An object that contains the MedicalTranscript
. The MedicalTranscript
contains the
TranscriptFileUri
.
transcript
- An object that contains the MedicalTranscript
. The MedicalTranscript
contains
the TranscriptFileUri
.public MedicalTranscript getTranscript()
An object that contains the MedicalTranscript
. The MedicalTranscript
contains the
TranscriptFileUri
.
MedicalTranscript
. The MedicalTranscript
contains
the TranscriptFileUri
.public MedicalTranscriptionJob withTranscript(MedicalTranscript transcript)
An object that contains the MedicalTranscript
. The MedicalTranscript
contains the
TranscriptFileUri
.
transcript
- An object that contains the MedicalTranscript
. The MedicalTranscript
contains
the TranscriptFileUri
.public void setStartTime(Date startTime)
A timestamp that shows when the job started processing.
startTime
- A timestamp that shows when the job started processing.public Date getStartTime()
A timestamp that shows when the job started processing.
public MedicalTranscriptionJob withStartTime(Date startTime)
A timestamp that shows when the job started processing.
startTime
- A timestamp that shows when the job started processing.public void setCreationTime(Date creationTime)
A timestamp that shows when the job was created.
creationTime
- A timestamp that shows when the job was created.public Date getCreationTime()
A timestamp that shows when the job was created.
public MedicalTranscriptionJob withCreationTime(Date creationTime)
A timestamp that shows when the job was created.
creationTime
- A timestamp that shows when the job was created.public void setCompletionTime(Date completionTime)
A timestamp that shows when the job was completed.
completionTime
- A timestamp that shows when the job was completed.public Date getCompletionTime()
A timestamp that shows when the job was completed.
public MedicalTranscriptionJob withCompletionTime(Date completionTime)
A timestamp that shows when the job was completed.
completionTime
- A timestamp that shows when the job was completed.public void setFailureReason(String failureReason)
If the TranscriptionJobStatus
field is FAILED
, this field contains information about
why the job failed.
The FailureReason
field contains one of the following values:
Unsupported media format
- The media format specified in the MediaFormat
field of the
request isn't valid. See the description of the MediaFormat
field for a list of valid values.
The media format provided does not match the detected media format
- The media format of the audio
file doesn't match the format specified in the MediaFormat
field in the request. Check the media
format of your media file and make sure the two values match.
Invalid sample rate for audio file
- The sample rate specified in the
MediaSampleRateHertz
of the request isn't valid. The sample rate must be between 8000 and 48000
Hertz.
The sample rate provided does not match the detected sample rate
- The sample rate in the audio file
doesn't match the sample rate specified in the MediaSampleRateHertz
field in the request. Check the
sample rate of your media file and make sure that the two values match.
Invalid file size: file size too large
- The size of your audio file is larger than what Amazon
Transcribe Medical can process. For more information, see Guidelines and Quotas
in the Amazon Transcribe Medical Guide
Invalid number of channels: number of channels too large
- Your audio contains more channels than
Amazon Transcribe Medical is configured to process. To request additional channels, see Amazon Transcribe Medical Endpoints
and Quotas in the Amazon Web Services General Reference
failureReason
- If the TranscriptionJobStatus
field is FAILED
, this field contains information
about why the job failed.
The FailureReason
field contains one of the following values:
Unsupported media format
- The media format specified in the MediaFormat
field of
the request isn't valid. See the description of the MediaFormat
field for a list of valid
values.
The media format provided does not match the detected media format
- The media format of the
audio file doesn't match the format specified in the MediaFormat
field in the request. Check
the media format of your media file and make sure the two values match.
Invalid sample rate for audio file
- The sample rate specified in the
MediaSampleRateHertz
of the request isn't valid. The sample rate must be between 8000 and
48000 Hertz.
The sample rate provided does not match the detected sample rate
- The sample rate in the
audio file doesn't match the sample rate specified in the MediaSampleRateHertz
field in the
request. Check the sample rate of your media file and make sure that the two values match.
Invalid file size: file size too large
- The size of your audio file is larger than what
Amazon Transcribe Medical can process. For more information, see Guidelines and
Quotas in the Amazon Transcribe Medical Guide
Invalid number of channels: number of channels too large
- Your audio contains more channels
than Amazon Transcribe Medical is configured to process. To request additional channels, see Amazon Transcribe Medical
Endpoints and Quotas in the Amazon Web Services General Reference
public String getFailureReason()
If the TranscriptionJobStatus
field is FAILED
, this field contains information about
why the job failed.
The FailureReason
field contains one of the following values:
Unsupported media format
- The media format specified in the MediaFormat
field of the
request isn't valid. See the description of the MediaFormat
field for a list of valid values.
The media format provided does not match the detected media format
- The media format of the audio
file doesn't match the format specified in the MediaFormat
field in the request. Check the media
format of your media file and make sure the two values match.
Invalid sample rate for audio file
- The sample rate specified in the
MediaSampleRateHertz
of the request isn't valid. The sample rate must be between 8000 and 48000
Hertz.
The sample rate provided does not match the detected sample rate
- The sample rate in the audio file
doesn't match the sample rate specified in the MediaSampleRateHertz
field in the request. Check the
sample rate of your media file and make sure that the two values match.
Invalid file size: file size too large
- The size of your audio file is larger than what Amazon
Transcribe Medical can process. For more information, see Guidelines and Quotas
in the Amazon Transcribe Medical Guide
Invalid number of channels: number of channels too large
- Your audio contains more channels than
Amazon Transcribe Medical is configured to process. To request additional channels, see Amazon Transcribe Medical Endpoints
and Quotas in the Amazon Web Services General Reference
TranscriptionJobStatus
field is FAILED
, this field contains information
about why the job failed.
The FailureReason
field contains one of the following values:
Unsupported media format
- The media format specified in the MediaFormat
field
of the request isn't valid. See the description of the MediaFormat
field for a list of valid
values.
The media format provided does not match the detected media format
- The media format of the
audio file doesn't match the format specified in the MediaFormat
field in the request. Check
the media format of your media file and make sure the two values match.
Invalid sample rate for audio file
- The sample rate specified in the
MediaSampleRateHertz
of the request isn't valid. The sample rate must be between 8000 and
48000 Hertz.
The sample rate provided does not match the detected sample rate
- The sample rate in the
audio file doesn't match the sample rate specified in the MediaSampleRateHertz
field in the
request. Check the sample rate of your media file and make sure that the two values match.
Invalid file size: file size too large
- The size of your audio file is larger than what
Amazon Transcribe Medical can process. For more information, see Guidelines and
Quotas in the Amazon Transcribe Medical Guide
Invalid number of channels: number of channels too large
- Your audio contains more channels
than Amazon Transcribe Medical is configured to process. To request additional channels, see Amazon Transcribe Medical
Endpoints and Quotas in the Amazon Web Services General Reference
public MedicalTranscriptionJob withFailureReason(String failureReason)
If the TranscriptionJobStatus
field is FAILED
, this field contains information about
why the job failed.
The FailureReason
field contains one of the following values:
Unsupported media format
- The media format specified in the MediaFormat
field of the
request isn't valid. See the description of the MediaFormat
field for a list of valid values.
The media format provided does not match the detected media format
- The media format of the audio
file doesn't match the format specified in the MediaFormat
field in the request. Check the media
format of your media file and make sure the two values match.
Invalid sample rate for audio file
- The sample rate specified in the
MediaSampleRateHertz
of the request isn't valid. The sample rate must be between 8000 and 48000
Hertz.
The sample rate provided does not match the detected sample rate
- The sample rate in the audio file
doesn't match the sample rate specified in the MediaSampleRateHertz
field in the request. Check the
sample rate of your media file and make sure that the two values match.
Invalid file size: file size too large
- The size of your audio file is larger than what Amazon
Transcribe Medical can process. For more information, see Guidelines and Quotas
in the Amazon Transcribe Medical Guide
Invalid number of channels: number of channels too large
- Your audio contains more channels than
Amazon Transcribe Medical is configured to process. To request additional channels, see Amazon Transcribe Medical Endpoints
and Quotas in the Amazon Web Services General Reference
failureReason
- If the TranscriptionJobStatus
field is FAILED
, this field contains information
about why the job failed.
The FailureReason
field contains one of the following values:
Unsupported media format
- The media format specified in the MediaFormat
field of
the request isn't valid. See the description of the MediaFormat
field for a list of valid
values.
The media format provided does not match the detected media format
- The media format of the
audio file doesn't match the format specified in the MediaFormat
field in the request. Check
the media format of your media file and make sure the two values match.
Invalid sample rate for audio file
- The sample rate specified in the
MediaSampleRateHertz
of the request isn't valid. The sample rate must be between 8000 and
48000 Hertz.
The sample rate provided does not match the detected sample rate
- The sample rate in the
audio file doesn't match the sample rate specified in the MediaSampleRateHertz
field in the
request. Check the sample rate of your media file and make sure that the two values match.
Invalid file size: file size too large
- The size of your audio file is larger than what
Amazon Transcribe Medical can process. For more information, see Guidelines and
Quotas in the Amazon Transcribe Medical Guide
Invalid number of channels: number of channels too large
- Your audio contains more channels
than Amazon Transcribe Medical is configured to process. To request additional channels, see Amazon Transcribe Medical
Endpoints and Quotas in the Amazon Web Services General Reference
public void setSettings(MedicalTranscriptionSetting settings)
Object that contains object.
settings
- Object that contains object.public MedicalTranscriptionSetting getSettings()
Object that contains object.
public MedicalTranscriptionJob withSettings(MedicalTranscriptionSetting settings)
Object that contains object.
settings
- Object that contains object.public void setSpecialty(String specialty)
The medical specialty of any clinicians providing a dictation or having a conversation. PRIMARYCARE
is the only available setting for this object. This specialty enables you to generate transcriptions for the
following medical fields:
Family Medicine
specialty
- The medical specialty of any clinicians providing a dictation or having a conversation.
PRIMARYCARE
is the only available setting for this object. This specialty enables you to
generate transcriptions for the following medical fields:
Family Medicine
Specialty
public String getSpecialty()
The medical specialty of any clinicians providing a dictation or having a conversation. PRIMARYCARE
is the only available setting for this object. This specialty enables you to generate transcriptions for the
following medical fields:
Family Medicine
PRIMARYCARE
is the only available setting for this object. This specialty enables you to
generate transcriptions for the following medical fields:
Family Medicine
Specialty
public MedicalTranscriptionJob withSpecialty(String specialty)
The medical specialty of any clinicians providing a dictation or having a conversation. PRIMARYCARE
is the only available setting for this object. This specialty enables you to generate transcriptions for the
following medical fields:
Family Medicine
specialty
- The medical specialty of any clinicians providing a dictation or having a conversation.
PRIMARYCARE
is the only available setting for this object. This specialty enables you to
generate transcriptions for the following medical fields:
Family Medicine
Specialty
public MedicalTranscriptionJob withSpecialty(Specialty specialty)
The medical specialty of any clinicians providing a dictation or having a conversation. PRIMARYCARE
is the only available setting for this object. This specialty enables you to generate transcriptions for the
following medical fields:
Family Medicine
specialty
- The medical specialty of any clinicians providing a dictation or having a conversation.
PRIMARYCARE
is the only available setting for this object. This specialty enables you to
generate transcriptions for the following medical fields:
Family Medicine
Specialty
public void setType(String type)
The type of speech in the transcription job. CONVERSATION
is generally used for patient-physician
dialogues. DICTATION
is the setting for physicians speaking their notes after seeing a patient. For
more information, see how-it-works-med
type
- The type of speech in the transcription job. CONVERSATION
is generally used for
patient-physician dialogues. DICTATION
is the setting for physicians speaking their notes
after seeing a patient. For more information, see how-it-works-medType
public String getType()
The type of speech in the transcription job. CONVERSATION
is generally used for patient-physician
dialogues. DICTATION
is the setting for physicians speaking their notes after seeing a patient. For
more information, see how-it-works-med
CONVERSATION
is generally used for
patient-physician dialogues. DICTATION
is the setting for physicians speaking their notes
after seeing a patient. For more information, see how-it-works-medType
public MedicalTranscriptionJob withType(String type)
The type of speech in the transcription job. CONVERSATION
is generally used for patient-physician
dialogues. DICTATION
is the setting for physicians speaking their notes after seeing a patient. For
more information, see how-it-works-med
type
- The type of speech in the transcription job. CONVERSATION
is generally used for
patient-physician dialogues. DICTATION
is the setting for physicians speaking their notes
after seeing a patient. For more information, see how-it-works-medType
public MedicalTranscriptionJob withType(Type type)
The type of speech in the transcription job. CONVERSATION
is generally used for patient-physician
dialogues. DICTATION
is the setting for physicians speaking their notes after seeing a patient. For
more information, see how-it-works-med
type
- The type of speech in the transcription job. CONVERSATION
is generally used for
patient-physician dialogues. DICTATION
is the setting for physicians speaking their notes
after seeing a patient. For more information, see how-it-works-medType
public String toString()
toString
in class Object
Object.toString()
public MedicalTranscriptionJob clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.