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) The date and time the specified medical transcription job finished processing.
MedicalTranscriptionJob.Builder	contentIdentificationType(MedicalContentIdentificationType contentIdentificationType) Indicates whether content identification was enabled for your transcription request.
MedicalTranscriptionJob.Builder	contentIdentificationType(String contentIdentificationType) Indicates whether content identification was enabled for your transcription request.
MedicalTranscriptionJob.Builder	creationTime(Instant creationTime) The date and time the specified medical transcription job request was made.
MedicalTranscriptionJob.Builder	failureReason(String failureReason) If TranscriptionJobStatus is FAILED, FailureReason contains information about why the transcription job request failed.
MedicalTranscriptionJob.Builder	languageCode(LanguageCode languageCode) The language code used to create your medical transcription job.
MedicalTranscriptionJob.Builder	languageCode(String languageCode) The language code used to create your medical transcription job.
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 audio track in your input media file.
MedicalTranscriptionJob.Builder	medicalTranscriptionJobName(String medicalTranscriptionJobName) The name of the medical transcription job.
default MedicalTranscriptionJob.Builder	settings(Consumer<MedicalTranscriptionSetting.Builder> settings) Provides information on any additional settings that were included in your request.
MedicalTranscriptionJob.Builder	settings(MedicalTranscriptionSetting settings) Provides information on any additional settings that were included in your request.
MedicalTranscriptionJob.Builder	specialty(Specialty specialty) Describes the medical specialty represented in your media.
MedicalTranscriptionJob.Builder	specialty(String specialty) Describes the medical specialty represented in your media.
MedicalTranscriptionJob.Builder	startTime(Instant startTime) The date and time the specified medical transcription job began processing.
MedicalTranscriptionJob.Builder	tags(Collection<Tag> tags) The tags, each in the form of a key:value pair, assigned to the specified medical transcription job.
MedicalTranscriptionJob.Builder	tags(Consumer<Tag.Builder>... tags) The tags, each in the form of a key:value pair, assigned to the specified medical transcription job.
MedicalTranscriptionJob.Builder	tags(Tag... tags) The tags, each in the form of a key:value pair, assigned to the specified medical transcription job.
default MedicalTranscriptionJob.Builder	transcript(Consumer<MedicalTranscript.Builder> transcript) Provides you with the Amazon S3 URI you can use to access your transcript.
MedicalTranscriptionJob.Builder	transcript(MedicalTranscript transcript) Provides you with the Amazon S3 URI you can use to access your transcript.
MedicalTranscriptionJob.Builder	transcriptionJobStatus(String transcriptionJobStatus) Provides the status of the specified medical transcription job.
MedicalTranscriptionJob.Builder	transcriptionJobStatus(TranscriptionJobStatus transcriptionJobStatus) Provides the status of the specified medical transcription job.
MedicalTranscriptionJob.Builder	type(String type) Indicates whether the input media is a dictation or a conversation, as specified in the StartMedicalTranscriptionJob request.
MedicalTranscriptionJob.Builder	type(Type type) Indicates whether the input media is a dictation or a conversation, as specified in the StartMedicalTranscriptionJob request.

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

Parameters:

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

Returns:

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

transcriptionJobStatus

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

Parameters:

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.

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)

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.

Parameters:

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.

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

Parameters:

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

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

Parameters:

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

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 audio track in your input media file.

Parameters:

mediaSampleRateHertz - The sample rate, in hertz, of the audio track in your input media file.

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

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

Parameters:

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

Returns:

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

transcript

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

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

This is a convenience method 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)

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.

Parameters:

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:

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

creationTime

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

Parameters:

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:

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

completionTime

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

Parameters:

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:

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

failureReason

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

Parameters:

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:

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

settings

MedicalTranscriptionJob.Builder settings(MedicalTranscriptionSetting settings)

Provides information on any additional settings that were included in your request. Additional settings include channel identification, alternative transcriptions, speaker partitioning, custom vocabularies, and custom vocabulary filters.

Parameters:

settings - Provides information on any additional settings that were included in your request. Additional settings include channel identification, alternative transcriptions, speaker partitioning, custom vocabularies, and custom vocabulary filters.

Returns:

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

settings

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

Provides information on any additional settings that were included in your request. Additional settings include channel identification, alternative transcriptions, speaker partitioning, custom vocabularies, and custom vocabulary filters.

This is a convenience method 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)

Indicates whether content identification was enabled for your transcription request.

Parameters:

contentIdentificationType - Indicates whether content identification was enabled for your transcription request.

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)

Indicates whether content identification was enabled for your transcription request.

Parameters:

contentIdentificationType - Indicates whether content identification was enabled for your transcription request.

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)

Describes the medical specialty represented in your media.

Parameters:

specialty - Describes the medical specialty represented in your media.

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)

Describes the medical specialty represented in your media.

Parameters:

specialty - Describes the medical specialty represented in your media.

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)

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

Parameters:

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

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)

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

Parameters:

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

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)

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

Parameters:

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

Returns:

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

tags

MedicalTranscriptionJob.Builder tags(Tag... tags)

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

Parameters:

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

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

This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

Parameters:

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

Returns:

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

See Also:

#tags(java.util.Collection)