MedicalTranscriptionJob (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.transcribe.model.MedicalTranscriptionJob

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<MedicalTranscriptionJob.Builder,MedicalTranscriptionJob>
```
@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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface MedicalTranscriptionJob.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`MedicalTranscriptionJob.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static MedicalTranscriptionJob.Builder`	`builder()`
`Instant`	`completionTime()` A timestamp that shows when the job was completed.
`MedicalContentIdentificationType`	`contentIdentificationType()` Shows the type of content that you've configured Amazon Transcribe Medical to identify in a transcription job.
`String`	`contentIdentificationTypeAsString()` Shows the type of content that you've configured Amazon Transcribe Medical to identify in a transcription job.
`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()`
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`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.
`List<Tag>`	`tags()` A key:value pair assigned to a given medical transcription job.
`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.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - medicalTranscriptionJobName
```
public final String medicalTranscriptionJobName()
```
    The name for a given medical transcription job.
    
    Returns:
    
    The name for a given medical transcription job.
  - transcriptionJobStatus
```
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().
    
    Returns:
    
    The completion status of a medical transcription job.
    
    See Also:
    
    TranscriptionJobStatus
  - transcriptionJobStatusAsString
```
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().
    
    Returns:
    
    The completion status of a medical transcription job.
    
    See Also:
    
    TranscriptionJobStatus
  - languageCode
```
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().
    
    Returns:
    
    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.
    
    See Also:
    
    LanguageCode
  - languageCodeAsString
```
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().
    
    Returns:
    
    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.
    
    See Also:
    
    LanguageCode
  - mediaSampleRateHertz
```
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 MedicalMediaSampleHertz blank and let Amazon Transcribe Medical determine the sample rate.
    
    Returns:
    
    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 MedicalMediaSampleHertz blank and let Amazon Transcribe Medical determine the sample rate.
  - mediaFormat
```
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().
    
    Returns:
    
    The format of the input media file.
    
    See Also:
    
    MediaFormat
  - mediaFormatAsString
```
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().
    
    Returns:
    
    The format of the input media file.
    
    See Also:
    
    MediaFormat
  - media
```
public final Media media()
```
    Returns the value of the Media property for this object.
    
    Returns:
    
    The value of the Media property for this object.
  - transcript
```
public final MedicalTranscript transcript()
```
    An object that contains the MedicalTranscript. The MedicalTranscript contains the TranscriptFileUri.
    
    Returns:
    
    An object that contains the MedicalTranscript. The MedicalTranscript contains the TranscriptFileUri.
  - startTime
```
public final Instant startTime()
```
    A timestamp that shows when the job started processing.
    
    Returns:
    
    A timestamp that shows when the job started processing.
  - creationTime
```
public final Instant creationTime()
```
    A timestamp that shows when the job was created.
    
    Returns:
    
    A timestamp that shows when the job was created.
  - completionTime
```
public final Instant completionTime()
```
    A timestamp that shows when the job was completed.
    
    Returns:
    
    A timestamp that shows when the job was completed.
  - failureReason
```
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 8,000 and 48,000 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
    Returns:
    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 8,000 and 48,000 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
  - settings
```
public final MedicalTranscriptionSetting settings()
```
    Object that contains object.
    
    Returns:
    
    Object that contains object.
  - contentIdentificationType
```
public final MedicalContentIdentificationType contentIdentificationType()
```
    Shows the type of content that you've configured Amazon Transcribe Medical to identify in a transcription job. If the value is PHI, you've configured the job to identify personal health information (PHI) in the transcription output.
    
    If the service returns an enum value that is not available in the current SDK version, contentIdentificationType will return MedicalContentIdentificationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from contentIdentificationTypeAsString().
    
    Returns:
    
    Shows the type of content that you've configured Amazon Transcribe Medical to identify in a transcription job. If the value is PHI, you've configured the job to identify personal health information (PHI) in the transcription output.
    
    See Also:
    
    MedicalContentIdentificationType
  - contentIdentificationTypeAsString
```
public final String contentIdentificationTypeAsString()
```
    Shows the type of content that you've configured Amazon Transcribe Medical to identify in a transcription job. If the value is PHI, you've configured the job to identify personal health information (PHI) in the transcription output.
    
    If the service returns an enum value that is not available in the current SDK version, contentIdentificationType will return MedicalContentIdentificationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from contentIdentificationTypeAsString().
    
    Returns:
    
    Shows the type of content that you've configured Amazon Transcribe Medical to identify in a transcription job. If the value is PHI, you've configured the job to identify personal health information (PHI) in the transcription output.
    
    See Also:
    
    MedicalContentIdentificationType
  - specialty
```
public final Specialty specialty()
```
    The medical specialty of any clinicians providing a dictation or having a conversation. Refer to Transcribing a medical conversationfor a list of supported specialties.
    
    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().
    
    Returns:
    
    The medical specialty of any clinicians providing a dictation or having a conversation. Refer to Transcribing a medical conversationfor a list of supported specialties.
    
    See Also:
    
    Specialty
  - specialtyAsString
```
public final String specialtyAsString()
```
    The medical specialty of any clinicians providing a dictation or having a conversation. Refer to Transcribing a medical conversationfor a list of supported specialties.
    
    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().
    
    Returns:
    
    The medical specialty of any clinicians providing a dictation or having a conversation. Refer to Transcribing a medical conversationfor a list of supported specialties.
    
    See Also:
    
    Specialty
  - type
```
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 What is Amazon Transcribe Medical?.
    
    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().
    
    Returns:
    
    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 What is Amazon Transcribe Medical?.
    
    See Also:
    
    Type
  - typeAsString
```
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 What is Amazon Transcribe Medical?.
    
    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().
    
    Returns:
    
    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 What is Amazon Transcribe Medical?.
    
    See Also:
    
    Type
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - tags
```
public final List<Tag> tags()
```
    A key:value pair assigned to a given medical transcription job.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.
    
    Returns:
    
    A key:value pair assigned to a given medical transcription job.
  - toBuilder
```
public MedicalTranscriptionJob.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<MedicalTranscriptionJob.Builder,MedicalTranscriptionJob>
    
    Returns:
    
    a builder for type T
  - builder
```
public static MedicalTranscriptionJob.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends MedicalTranscriptionJob.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Description copied from interface: SdkPojo
    
    Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an 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.
    
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
    
    Parameters:
    
    obj - the object to be compared with
    
    Returns:
    
    true if the other object equals to this object by sdk fields, false otherwise.
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

AWS SDK for Java API Reference - 2.17.61

Class MedicalTranscriptionJob

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

medicalTranscriptionJobName

transcriptionJobStatus

transcriptionJobStatusAsString

languageCode

languageCodeAsString

mediaSampleRateHertz

mediaFormat

mediaFormatAsString

media

transcript

startTime

creationTime

completionTime

failureReason

settings

contentIdentificationType

contentIdentificationTypeAsString

specialty

specialtyAsString

type

typeAsString

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields