@Generated(value="software.amazon.awssdk:codegen") public final class MedicalTranscriptionJob extends Object implements SdkPojo, Serializable, ToCopyableBuilder<MedicalTranscriptionJob.Builder,MedicalTranscriptionJob>
The data structure that contains the information for a medical transcription job.
Modifier and Type | Class and Description |
---|---|
static interface |
MedicalTranscriptionJob.Builder |
Modifier and Type | Method and Description |
---|---|
static MedicalTranscriptionJob.Builder |
builder() |
Instant |
completionTime()
A timestamp that shows when the job was completed.
|
Instant |
creationTime()
A timestamp that shows when the job was created.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
String |
failureReason()
If the
TranscriptionJobStatus field is FAILED , this field contains information about
why the job failed. |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
LanguageCode |
languageCode()
The language code for the language spoken in the source audio file.
|
String |
languageCodeAsString()
The language code for the language spoken in the source audio file.
|
Media |
media()
Returns the value of the Media property for this object.
|
MediaFormat |
mediaFormat()
The format of the input media file.
|
String |
mediaFormatAsString()
The format of the input media file.
|
Integer |
mediaSampleRateHertz()
The sample rate, in Hertz, of the source audio containing medical information.
|
String |
medicalTranscriptionJobName()
The name for a given medical transcription job.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends MedicalTranscriptionJob.Builder> |
serializableBuilderClass() |
MedicalTranscriptionSetting |
settings()
Object that contains object.
|
Specialty |
specialty()
The medical specialty of any clinicians providing a dictation or having a conversation.
|
String |
specialtyAsString()
The medical specialty of any clinicians providing a dictation or having a conversation.
|
Instant |
startTime()
A timestamp that shows when the job started processing.
|
MedicalTranscriptionJob.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
MedicalTranscript |
transcript()
An object that contains the
MedicalTranscript . |
TranscriptionJobStatus |
transcriptionJobStatus()
The completion status of a medical transcription job.
|
String |
transcriptionJobStatusAsString()
The completion status of a medical transcription job.
|
Type |
type()
The type of speech in the transcription job.
|
String |
typeAsString()
The type of speech in the transcription job.
|
copy
public final String medicalTranscriptionJobName()
The name for a given medical transcription job.
public final TranscriptionJobStatus transcriptionJobStatus()
The completion status of a medical transcription job.
If the service returns an enum value that is not available in the current SDK version,
transcriptionJobStatus
will return TranscriptionJobStatus.UNKNOWN_TO_SDK_VERSION
. The raw value
returned by the service is available from transcriptionJobStatusAsString()
.
TranscriptionJobStatus
public final String transcriptionJobStatusAsString()
The completion status of a medical transcription job.
If the service returns an enum value that is not available in the current SDK version,
transcriptionJobStatus
will return TranscriptionJobStatus.UNKNOWN_TO_SDK_VERSION
. The raw value
returned by the service is available from transcriptionJobStatusAsString()
.
TranscriptionJobStatus
public final 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.
If the service returns an enum value that is not available in the current SDK version, languageCode
will
return LanguageCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
languageCodeAsString()
.
BadRequestException
error.LanguageCode
public final String languageCodeAsString()
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.
If the service returns an enum value that is not available in the current SDK version, languageCode
will
return LanguageCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
languageCodeAsString()
.
BadRequestException
error.LanguageCode
public final 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.
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 final MediaFormat mediaFormat()
The format of the input media file.
If the service returns an enum value that is not available in the current SDK version, mediaFormat
will
return MediaFormat.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
mediaFormatAsString()
.
MediaFormat
public final String mediaFormatAsString()
The format of the input media file.
If the service returns an enum value that is not available in the current SDK version, mediaFormat
will
return MediaFormat.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
mediaFormatAsString()
.
MediaFormat
public final Media media()
public final MedicalTranscript transcript()
An object that contains the MedicalTranscript
. The MedicalTranscript
contains the
TranscriptFileUri
.
MedicalTranscript
. The MedicalTranscript
contains
the TranscriptFileUri
.public final Instant startTime()
A timestamp that shows when the job started processing.
public final Instant creationTime()
A timestamp that shows when the job was created.
public final Instant completionTime()
A timestamp that shows when the job was completed.
public final 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
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 final MedicalTranscriptionSetting settings()
Object that contains object.
public final 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
If the service returns an enum value that is not available in the current SDK version, specialty
will
return Specialty.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
specialtyAsString()
.
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 final String specialtyAsString()
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
If the service returns an enum value that is not available in the current SDK version, specialty
will
return Specialty.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
specialtyAsString()
.
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 final 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
If the service returns an enum value that is not available in the current SDK version, type
will return
Type.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
typeAsString()
.
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 final String typeAsString()
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
If the service returns an enum value that is not available in the current SDK version, type
will return
Type.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
typeAsString()
.
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.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<MedicalTranscriptionJob.Builder,MedicalTranscriptionJob>
public static MedicalTranscriptionJob.Builder builder()
public static Class<? extends MedicalTranscriptionJob.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()