software.amazon.awssdk.services.transcribe.model

Class MedicalTranscriptionJob

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>

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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MedicalTranscriptionJob.Builder

Method Summary

Modifier and Type	Method and Description
static MedicalTranscriptionJob.Builder	builder()
Instant	completionTime() The date and time the specified medical transcription job finished processing.
MedicalContentIdentificationType	contentIdentificationType() Labels all personal health information (PHI) identified in your transcript.
String	contentIdentificationTypeAsString() Labels all personal health information (PHI) identified in your transcript.
Instant	creationTime() The date and time the specified medical transcription job request was made.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	failureReason() If TranscriptionJobStatus is FAILED, FailureReason contains information about why the transcription job request 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 used to create your medical transcription job.
String	languageCodeAsString() The language code used to create your medical transcription job.
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 audio track in your input media file.
String	medicalTranscriptionJobName() The name of the medical transcription job.
List<SdkField<?>>	sdkFields()
static Class<? extends MedicalTranscriptionJob.Builder>	serializableBuilderClass()
MedicalTranscriptionSetting	settings() Specify additional optional settings in your request, including channel identification, alternative transcriptions, and speaker labeling; allows you to apply custom vocabularies to your medical transcription job.
Specialty	specialty() Describes the medical specialty represented in your media.
String	specialtyAsString() Describes the medical specialty represented in your media.
Instant	startTime() The date and time the specified medical transcription job began processing.
List<Tag>	tags() The tags, each in the form of a key:value pair, assigned to the specified medical transcription job.
MedicalTranscriptionJob.Builder	toBuilder()
String	toString() Returns a string representation of this object.
MedicalTranscript	transcript() Provides you with the Amazon S3 URI you can use to access your transcript.
TranscriptionJobStatus	transcriptionJobStatus() Provides the status of the specified medical transcription job.
String	transcriptionJobStatusAsString() Provides the status of the specified medical transcription job.
Type	type() Indicates whether the input media is a dictation or a conversation, as specified in the StartMedicalTranscriptionJob request.
String	typeAsString() Indicates whether the input media is a dictation or a conversation, as specified in the StartMedicalTranscriptionJob request.

Methods inherited from class java.lang.Object

clone, finalize, 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 of the medical transcription job. Job names are case sensitive and must be unique within an Amazon Web Services account.

Returns:

The name of the medical transcription job. Job names are case sensitive and must be unique within an Amazon Web Services account.

transcriptionJobStatus

public final TranscriptionJobStatus transcriptionJobStatus()

Provides the status of the specified medical transcription job.

If the status is COMPLETED, the job is finished and you can find the results at the location specified in TranscriptFileUri. If the status is FAILED, FailureReason provides details on why your transcription job failed.

If the 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:

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.

See Also:

TranscriptionJobStatus

transcriptionJobStatusAsString

public final String transcriptionJobStatusAsString()

Provides the status of the specified medical transcription job.

If the status is COMPLETED, the job is finished and you can find the results at the location specified in TranscriptFileUri. If the status is FAILED, FailureReason provides details on why your transcription job failed.

If the 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:

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.

See Also:

TranscriptionJobStatus

languageCode

public final LanguageCode languageCode()

The language code used to create your medical transcription job. US English (en-US) is the only supported language for medical transcriptions.

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 used to create your medical transcription job. US English (en-US) is the only supported language for medical transcriptions.

See Also:

LanguageCode

languageCodeAsString

public final String languageCodeAsString()

The language code used to create your medical transcription job. US English (en-US) is the only supported language for medical transcriptions.

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 used to create your medical transcription job. US English (en-US) is the only supported language for medical transcriptions.

See Also:

LanguageCode

mediaSampleRateHertz

public final Integer mediaSampleRateHertz()

The sample rate, in Hertz, of the audio track in your input media file.

Returns:

The sample rate, in Hertz, of the audio track in your input media file.

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()

Provides you with the Amazon S3 URI you can use to access your transcript.

Returns:

Provides you with the Amazon S3 URI you can use to access your transcript.

startTime

public final Instant 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.

Returns:

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.

creationTime

public final Instant 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.

Returns:

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.

completionTime

public final Instant 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.

Returns:

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.

failureReason

public final String 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.

Returns:

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.

settings

public final MedicalTranscriptionSetting settings()

Specify additional optional settings in your request, including channel identification, alternative transcriptions, and speaker labeling; allows you to apply custom vocabularies to your medical transcription job.

Returns:

Specify additional optional settings in your request, including channel identification, alternative transcriptions, and speaker labeling; allows you to apply custom vocabularies to your medical transcription job.

contentIdentificationType

public final MedicalContentIdentificationType contentIdentificationType()

Labels all personal health information (PHI) identified in your transcript. For more information, see Identifying personal health information (PHI) in a transcription.

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:

Labels all personal health information (PHI) identified in your transcript. For more information, see Identifying personal health information (PHI) in a transcription.

See Also:

MedicalContentIdentificationType

contentIdentificationTypeAsString

public final String contentIdentificationTypeAsString()

Labels all personal health information (PHI) identified in your transcript. For more information, see Identifying personal health information (PHI) in a transcription.

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:

Labels all personal health information (PHI) identified in your transcript. For more information, see Identifying personal health information (PHI) in a transcription.

See Also:

MedicalContentIdentificationType

specialty

public final Specialty specialty()

Describes the medical specialty represented in your media.

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:

Describes the medical specialty represented in your media.

See Also:

Specialty

specialtyAsString

public final String specialtyAsString()

Describes the medical specialty represented in your media.

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:

Describes the medical specialty represented in your media.

See Also:

Specialty

type

public final Type type()

Indicates whether the input media is a dictation or a conversation, as specified in the StartMedicalTranscriptionJob request.

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:

Indicates whether the input media is a dictation or a conversation, as specified in the StartMedicalTranscriptionJob request.

See Also:

Type

typeAsString

public final String typeAsString()

Indicates whether the input media is a dictation or a conversation, as specified in the StartMedicalTranscriptionJob request.

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:

Indicates whether the input media is a dictation or a conversation, as specified in the StartMedicalTranscriptionJob request.

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()

The tags, each in the form of a key:value pair, assigned to the specified 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:

The tags, each in the form of a key:value pair, assigned to the specified medical transcription job.

toBuilder

public MedicalTranscriptionJob.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<MedicalTranscriptionJob.Builder,MedicalTranscriptionJob>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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