Interface MedicalTranscriptionJob.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<MedicalTranscriptionJob.Builder,
,MedicalTranscriptionJob> SdkBuilder<MedicalTranscriptionJob.Builder,
,MedicalTranscriptionJob> SdkPojo
- Enclosing class:
MedicalTranscriptionJob
-
Method Summary
Modifier and TypeMethodDescriptioncompletionTime
(Instant completionTime) The date and time the specified medical transcription job finished processing.contentIdentificationType
(String contentIdentificationType) Indicates whether content identification was enabled for your transcription request.contentIdentificationType
(MedicalContentIdentificationType contentIdentificationType) Indicates whether content identification was enabled for your transcription request.creationTime
(Instant creationTime) The date and time the specified medical transcription job request was made.failureReason
(String failureReason) IfTranscriptionJobStatus
isFAILED
,FailureReason
contains information about why the transcription job request failed.languageCode
(String languageCode) The language code used to create your medical transcription job.languageCode
(LanguageCode 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.Sets the value of the Media property for this object.mediaFormat
(String mediaFormat) The format of the input media file.mediaFormat
(MediaFormat mediaFormat) The format of the input media file.mediaSampleRateHertz
(Integer mediaSampleRateHertz) The sample rate, in hertz, of the audio track in your input media file.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.settings
(MedicalTranscriptionSetting settings) Provides information on any additional settings that were included in your request.Describes the medical specialty represented in your media.Describes the medical specialty represented in your media.The date and time the specified medical transcription job began processing.tags
(Collection<Tag> tags) The tags, each in the form of a key:value pair, assigned to the specified medical transcription job.tags
(Consumer<Tag.Builder>... tags) The tags, each in the form of a key:value pair, assigned to the specified medical transcription job.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.transcript
(MedicalTranscript transcript) Provides you with the Amazon S3 URI you can use to access your transcript.transcriptionJobStatus
(String transcriptionJobStatus) Provides the status of the specified medical transcription job.transcriptionJobStatus
(TranscriptionJobStatus transcriptionJobStatus) Provides the status of the specified medical transcription job.Indicates whether the input media is a dictation or a conversation, as specified in theStartMedicalTranscriptionJob
request.Indicates whether the input media is a dictation or a conversation, as specified in theStartMedicalTranscriptionJob
request.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
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 inTranscriptFileUri
. If the status isFAILED
,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 inTranscriptFileUri
. If the status isFAILED
,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
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 inTranscriptFileUri
. If the status isFAILED
,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 inTranscriptFileUri
. If the status isFAILED
,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:
-
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
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:
-
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
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
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:
-
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
Sets the value of the Media property for this object. This is a convenience method that creates an instance of theMedia.Builder
avoiding the need to create one manually viaMedia.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tomedia(Media)
.- Parameters:
media
- a consumer that will call methods onMedia.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
Provides you with the Amazon S3 URI you can use to access your transcript.
This is a convenience method that creates an instance of theMedicalTranscript.Builder
avoiding the need to create one manually viaMedicalTranscript.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totranscript(MedicalTranscript)
.- Parameters:
transcript
- a consumer that will call methods onMedicalTranscript.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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
If
TranscriptionJobStatus
isFAILED
,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 refer to theMediaFormat
parameter 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 Service 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 Service quotas.
- Parameters:
failureReason
- IfTranscriptionJobStatus
isFAILED
,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 refer to theMediaFormat
parameter 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 Service 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 Service quotas.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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 theMedicalTranscriptionSetting.Builder
avoiding the need to create one manually viaMedicalTranscriptionSetting.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosettings(MedicalTranscriptionSetting)
.- Parameters:
settings
- a consumer that will call methods onMedicalTranscriptionSetting.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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:
-
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:
-
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
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:
-
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 theStartMedicalTranscriptionJob
request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theStartMedicalTranscriptionJob
request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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 theTag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<Tag>)
.- Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-