software.amazon.awssdk.services.transcribe.model

Interface MedicalTranscriptionJob.Builder

All Superinterfaces:

Buildable, CopyableBuilder<MedicalTranscriptionJob.Builder,MedicalTranscriptionJob>, SdkBuilder<MedicalTranscriptionJob.Builder,MedicalTranscriptionJob>, SdkPojo

Enclosing class:

MedicalTranscriptionJob

public static interface MedicalTranscriptionJob.Builder
extends SdkPojo, CopyableBuilder<MedicalTranscriptionJob.Builder,MedicalTranscriptionJob>

Method Summary

Modifier and Type	Method and Description
MedicalTranscriptionJob.Builder	completionTime(Instant completionTime) A timestamp that shows when the job was completed.
MedicalTranscriptionJob.Builder	contentIdentificationType(MedicalContentIdentificationType contentIdentificationType) Shows the type of content that you've configured Amazon Transcribe Medical to identify in a transcription job.
MedicalTranscriptionJob.Builder	contentIdentificationType(String contentIdentificationType) Shows the type of content that you've configured Amazon Transcribe Medical to identify in a transcription job.
MedicalTranscriptionJob.Builder	creationTime(Instant creationTime) A timestamp that shows when the job was created.
MedicalTranscriptionJob.Builder	failureReason(String failureReason) If the TranscriptionJobStatus field is FAILED, this field contains information about why the job failed.
MedicalTranscriptionJob.Builder	languageCode(LanguageCode languageCode) The language code for the language spoken in the source audio file.
MedicalTranscriptionJob.Builder	languageCode(String languageCode) The language code for the language spoken in the source audio file.
default MedicalTranscriptionJob.Builder	media(Consumer<Media.Builder> media) Sets the value of the Media property for this object.
MedicalTranscriptionJob.Builder	media(Media media) Sets the value of the Media property for this object.
MedicalTranscriptionJob.Builder	mediaFormat(MediaFormat mediaFormat) The format of the input media file.
MedicalTranscriptionJob.Builder	mediaFormat(String mediaFormat) The format of the input media file.
MedicalTranscriptionJob.Builder	mediaSampleRateHertz(Integer mediaSampleRateHertz) The sample rate, in Hertz, of the source audio containing medical information.
MedicalTranscriptionJob.Builder	medicalTranscriptionJobName(String medicalTranscriptionJobName) The name for a given medical transcription job.
default MedicalTranscriptionJob.Builder	settings(Consumer<MedicalTranscriptionSetting.Builder> settings) Object that contains object.
MedicalTranscriptionJob.Builder	settings(MedicalTranscriptionSetting settings) Object that contains object.
MedicalTranscriptionJob.Builder	specialty(Specialty specialty) The medical specialty of any clinicians providing a dictation or having a conversation.
MedicalTranscriptionJob.Builder	specialty(String specialty) The medical specialty of any clinicians providing a dictation or having a conversation.
MedicalTranscriptionJob.Builder	startTime(Instant startTime) A timestamp that shows when the job started processing.
MedicalTranscriptionJob.Builder	tags(Collection<Tag> tags) A key:value pair assigned to a given medical transcription job.
MedicalTranscriptionJob.Builder	tags(Consumer<Tag.Builder>... tags) A key:value pair assigned to a given medical transcription job.
MedicalTranscriptionJob.Builder	tags(Tag... tags) A key:value pair assigned to a given medical transcription job.
default MedicalTranscriptionJob.Builder	transcript(Consumer<MedicalTranscript.Builder> transcript) An object that contains the MedicalTranscript.
MedicalTranscriptionJob.Builder	transcript(MedicalTranscript transcript) An object that contains the MedicalTranscript.
MedicalTranscriptionJob.Builder	transcriptionJobStatus(String transcriptionJobStatus) The completion status of a medical transcription job.
MedicalTranscriptionJob.Builder	transcriptionJobStatus(TranscriptionJobStatus transcriptionJobStatus) The completion status of a medical transcription job.
MedicalTranscriptionJob.Builder	type(String type) The type of speech in the transcription job.
MedicalTranscriptionJob.Builder	type(Type type) The type of speech in the transcription job.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

medicalTranscriptionJobName

MedicalTranscriptionJob.Builder medicalTranscriptionJobName(String medicalTranscriptionJobName)

The name for a given medical transcription job.

Parameters:

medicalTranscriptionJobName - The name for a given medical transcription job.

Returns:

Returns a reference to this object so that method calls can be chained together.

transcriptionJobStatus

MedicalTranscriptionJob.Builder transcriptionJobStatus(String transcriptionJobStatus)

The completion status of a medical transcription job.

Parameters:

transcriptionJobStatus - The completion status of a medical transcription job.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

TranscriptionJobStatus, TranscriptionJobStatus

transcriptionJobStatus

MedicalTranscriptionJob.Builder transcriptionJobStatus(TranscriptionJobStatus transcriptionJobStatus)

The completion status of a medical transcription job.

Parameters:

transcriptionJobStatus - The completion status of a medical transcription job.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

TranscriptionJobStatus, TranscriptionJobStatus

languageCode

MedicalTranscriptionJob.Builder languageCode(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

LanguageCode, LanguageCode

languageCode

MedicalTranscriptionJob.Builder languageCode(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

LanguageCode, LanguageCode

mediaSampleRateHertz

MedicalTranscriptionJob.Builder mediaSampleRateHertz(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

mediaFormat

MedicalTranscriptionJob.Builder mediaFormat(String mediaFormat)

The format of the input media file.

Parameters:

mediaFormat - The format of the input media file.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MediaFormat, MediaFormat

mediaFormat

MedicalTranscriptionJob.Builder mediaFormat(MediaFormat mediaFormat)

The format of the input media file.

Parameters:

mediaFormat - The format of the input media file.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MediaFormat, MediaFormat

media

MedicalTranscriptionJob.Builder media(Media media)

Sets the value of the Media property for this object.

Parameters:

media - The new value for the Media property for this object.

Returns:

Returns a reference to this object so that method calls can be chained together.

media

default MedicalTranscriptionJob.Builder media(Consumer<Media.Builder> media)

Sets the value of the Media property for this object. This is a convenience that creates an instance of the Media.Builder avoiding the need to create one manually via Media.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to media(Media).

Parameters:

media - a consumer that will call methods on Media.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

media(Media)

transcript

MedicalTranscriptionJob.Builder transcript(MedicalTranscript transcript)

An object that contains the MedicalTranscript. The MedicalTranscript contains the TranscriptFileUri.

Parameters:

transcript - An object that contains the MedicalTranscript. The MedicalTranscript contains the TranscriptFileUri.

Returns:

Returns a reference to this object so that method calls can be chained together.

transcript

default MedicalTranscriptionJob.Builder transcript(Consumer<MedicalTranscript.Builder> transcript)

An object that contains the MedicalTranscript. The MedicalTranscript contains the TranscriptFileUri.

This is a convenience that creates an instance of the MedicalTranscript.Builder avoiding the need to create one manually via MedicalTranscript.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to transcript(MedicalTranscript).

Parameters:

transcript - a consumer that will call methods on MedicalTranscript.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

transcript(MedicalTranscript)

startTime

MedicalTranscriptionJob.Builder startTime(Instant startTime)

A timestamp that shows when the job started processing.

Parameters:

startTime - A timestamp that shows when the job started processing.

Returns:

Returns a reference to this object so that method calls can be chained together.

creationTime

MedicalTranscriptionJob.Builder creationTime(Instant creationTime)

A timestamp that shows when the job was created.

Parameters:

creationTime - A timestamp that shows when the job was created.

Returns:

Returns a reference to this object so that method calls can be chained together.

completionTime

MedicalTranscriptionJob.Builder completionTime(Instant completionTime)

A timestamp that shows when the job was completed.

Parameters:

completionTime - A timestamp that shows when the job was completed.

Returns:

Returns a reference to this object so that method calls can be chained together.

failureReason

MedicalTranscriptionJob.Builder failureReason(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

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

settings

MedicalTranscriptionJob.Builder settings(MedicalTranscriptionSetting settings)

Object that contains object.

Parameters:

settings - Object that contains object.

Returns:

Returns a reference to this object so that method calls can be chained together.

settings

default MedicalTranscriptionJob.Builder settings(Consumer<MedicalTranscriptionSetting.Builder> settings)

Object that contains object.

This is a convenience that creates an instance of the MedicalTranscriptionSetting.Builder avoiding the need to create one manually via MedicalTranscriptionSetting.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to settings(MedicalTranscriptionSetting).

Parameters:

settings - a consumer that will call methods on MedicalTranscriptionSetting.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

settings(MedicalTranscriptionSetting)

contentIdentificationType

MedicalTranscriptionJob.Builder contentIdentificationType(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MedicalContentIdentificationType, MedicalContentIdentificationType

contentIdentificationType

MedicalTranscriptionJob.Builder contentIdentificationType(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MedicalContentIdentificationType, MedicalContentIdentificationType

specialty

MedicalTranscriptionJob.Builder specialty(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Specialty, Specialty

specialty

MedicalTranscriptionJob.Builder specialty(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Specialty, Specialty

type

MedicalTranscriptionJob.Builder type(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 What is Amazon Transcribe Medical?.

Parameters:

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?.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Type, Type

type

MedicalTranscriptionJob.Builder type(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?.

Parameters:

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?.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Type, Type

tags

MedicalTranscriptionJob.Builder tags(Collection<Tag> tags)

A key:value pair assigned to a given medical transcription job.

Parameters:

tags - A key:value pair assigned to a given medical transcription job.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

MedicalTranscriptionJob.Builder tags(Tag... tags)

A key:value pair assigned to a given medical transcription job.

Parameters:

tags - A key:value pair assigned to a given medical transcription job.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

MedicalTranscriptionJob.Builder tags(Consumer<Tag.Builder>... tags)

A key:value pair assigned to a given medical transcription job.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #tags(List).

Parameters:

tags - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#tags(List)