public static interface TranscriptionJob.Builder extends SdkPojo, CopyableBuilder<TranscriptionJob.Builder,TranscriptionJob>
| Modifier and Type | Method and Description |
|---|---|
TranscriptionJob.Builder |
completionTime(Instant completionTime)
The date and time the specified transcription job finished processing.
|
default TranscriptionJob.Builder |
contentRedaction(Consumer<ContentRedaction.Builder> contentRedaction)
Indicates whether redaction was enabled in your transcript.
|
TranscriptionJob.Builder |
contentRedaction(ContentRedaction contentRedaction)
Indicates whether redaction was enabled in your transcript.
|
TranscriptionJob.Builder |
creationTime(Instant creationTime)
The date and time the specified transcription job request was made.
|
TranscriptionJob.Builder |
failureReason(String failureReason)
If
TranscriptionJobStatus is FAILED, FailureReason contains
information about why the transcription job request failed. |
TranscriptionJob.Builder |
identifiedLanguageScore(Float identifiedLanguageScore)
The confidence score associated with the language identified in your media file.
|
TranscriptionJob.Builder |
identifyLanguage(Boolean identifyLanguage)
Indicates whether automatic language identification was enabled (
TRUE) for the specified
transcription job. |
TranscriptionJob.Builder |
identifyMultipleLanguages(Boolean identifyMultipleLanguages)
Indicates whether automatic multi-language identification was enabled (
TRUE) for the specified
transcription job. |
default TranscriptionJob.Builder |
jobExecutionSettings(Consumer<JobExecutionSettings.Builder> jobExecutionSettings)
Provides information about how your transcription job was processed.
|
TranscriptionJob.Builder |
jobExecutionSettings(JobExecutionSettings jobExecutionSettings)
Provides information about how your transcription job was processed.
|
TranscriptionJob.Builder |
languageCode(LanguageCode languageCode)
The language code used to create your transcription job.
|
TranscriptionJob.Builder |
languageCode(String languageCode)
The language code used to create your transcription job.
|
TranscriptionJob.Builder |
languageCodes(Collection<LanguageCodeItem> languageCodes)
The language codes used to create your transcription job.
|
TranscriptionJob.Builder |
languageCodes(Consumer<LanguageCodeItem.Builder>... languageCodes)
The language codes used to create your transcription job.
|
TranscriptionJob.Builder |
languageCodes(LanguageCodeItem... languageCodes)
The language codes used to create your transcription job.
|
TranscriptionJob.Builder |
languageIdSettings(Map<LanguageCode,LanguageIdSettings> languageIdSettings)
Provides the name and language of all custom language models, custom vocabularies, and custom vocabulary
filters that you included in your request.
|
TranscriptionJob.Builder |
languageIdSettingsWithStrings(Map<String,LanguageIdSettings> languageIdSettings)
Provides the name and language of all custom language models, custom vocabularies, and custom vocabulary
filters that you included in your request.
|
TranscriptionJob.Builder |
languageOptions(Collection<LanguageCode> languageOptions)
Provides the language codes you specified in your request.
|
TranscriptionJob.Builder |
languageOptions(LanguageCode... languageOptions)
Provides the language codes you specified in your request.
|
TranscriptionJob.Builder |
languageOptionsWithStrings(Collection<String> languageOptions)
Provides the language codes you specified in your request.
|
TranscriptionJob.Builder |
languageOptionsWithStrings(String... languageOptions)
Provides the language codes you specified in your request.
|
default TranscriptionJob.Builder |
media(Consumer<Media.Builder> media)
Provides the Amazon S3 location of the media file you used in your request.
|
TranscriptionJob.Builder |
media(Media media)
Provides the Amazon S3 location of the media file you used in your request.
|
TranscriptionJob.Builder |
mediaFormat(MediaFormat mediaFormat)
The format of the input media file.
|
TranscriptionJob.Builder |
mediaFormat(String mediaFormat)
The format of the input media file.
|
TranscriptionJob.Builder |
mediaSampleRateHertz(Integer mediaSampleRateHertz)
The sample rate, in hertz, of the audio track in your input media file.
|
default TranscriptionJob.Builder |
modelSettings(Consumer<ModelSettings.Builder> modelSettings)
Provides information on the custom language model you included in your request.
|
TranscriptionJob.Builder |
modelSettings(ModelSettings modelSettings)
Provides information on the custom language model you included in your request.
|
default TranscriptionJob.Builder |
settings(Consumer<Settings.Builder> settings)
Provides information on any additional settings that were included in your request.
|
TranscriptionJob.Builder |
settings(Settings settings)
Provides information on any additional settings that were included in your request.
|
TranscriptionJob.Builder |
startTime(Instant startTime)
The date and time the specified transcription job began processing.
|
default TranscriptionJob.Builder |
subtitles(Consumer<SubtitlesOutput.Builder> subtitles)
Indicates whether subtitles were generated with your transcription.
|
TranscriptionJob.Builder |
subtitles(SubtitlesOutput subtitles)
Indicates whether subtitles were generated with your transcription.
|
TranscriptionJob.Builder |
tags(Collection<Tag> tags)
The tags, each in the form of a key:value pair, assigned to the specified transcription job.
|
TranscriptionJob.Builder |
tags(Consumer<Tag.Builder>... tags)
The tags, each in the form of a key:value pair, assigned to the specified transcription job.
|
TranscriptionJob.Builder |
tags(Tag... tags)
The tags, each in the form of a key:value pair, assigned to the specified transcription job.
|
default TranscriptionJob.Builder |
transcript(Consumer<Transcript.Builder> transcript)
Provides you with the Amazon S3 URI you can use to access your transcript.
|
TranscriptionJob.Builder |
transcript(Transcript transcript)
Provides you with the Amazon S3 URI you can use to access your transcript.
|
TranscriptionJob.Builder |
transcriptionJobName(String transcriptionJobName)
The name of the transcription job.
|
TranscriptionJob.Builder |
transcriptionJobStatus(String transcriptionJobStatus)
Provides the status of the specified transcription job.
|
TranscriptionJob.Builder |
transcriptionJobStatus(TranscriptionJobStatus transcriptionJobStatus)
Provides the status of the specified transcription job.
|
equalsBySdkFields, sdkFieldscopyapplyMutation, buildTranscriptionJob.Builder transcriptionJobName(String transcriptionJobName)
The name of the transcription job. Job names are case sensitive and must be unique within an Amazon Web Services account.
transcriptionJobName - The name of the transcription job. Job names are case sensitive and must be unique within an Amazon
Web Services account.TranscriptionJob.Builder transcriptionJobStatus(String transcriptionJobStatus)
Provides the status of the specified transcription job.
If the status is COMPLETED, the job is finished and you can find the results at the location
specified in TranscriptFileUri (or RedactedTranscriptFileUri, if you requested
transcript redaction). If the status is FAILED, FailureReason provides details on
why your transcription job failed.
transcriptionJobStatus - Provides the status of the specified transcription job.
If the status is COMPLETED, the job is finished and you can find the results at the
location specified in TranscriptFileUri (or RedactedTranscriptFileUri, if
you requested transcript redaction). If the status is FAILED, FailureReason
provides details on why your transcription job failed.
TranscriptionJobStatus,
TranscriptionJobStatusTranscriptionJob.Builder transcriptionJobStatus(TranscriptionJobStatus transcriptionJobStatus)
Provides the status of the specified transcription job.
If the status is COMPLETED, the job is finished and you can find the results at the location
specified in TranscriptFileUri (or RedactedTranscriptFileUri, if you requested
transcript redaction). If the status is FAILED, FailureReason provides details on
why your transcription job failed.
transcriptionJobStatus - Provides the status of the specified transcription job.
If the status is COMPLETED, the job is finished and you can find the results at the
location specified in TranscriptFileUri (or RedactedTranscriptFileUri, if
you requested transcript redaction). If the status is FAILED, FailureReason
provides details on why your transcription job failed.
TranscriptionJobStatus,
TranscriptionJobStatusTranscriptionJob.Builder languageCode(String languageCode)
The language code used to create your transcription job. This parameter is used with single-language
identification. For multi-language identification requests, refer to the plural version of this parameter,
LanguageCodes.
languageCode - The language code used to create your transcription job. This parameter is used with single-language
identification. For multi-language identification requests, refer to the plural version of this
parameter, LanguageCodes.LanguageCode,
LanguageCodeTranscriptionJob.Builder languageCode(LanguageCode languageCode)
The language code used to create your transcription job. This parameter is used with single-language
identification. For multi-language identification requests, refer to the plural version of this parameter,
LanguageCodes.
languageCode - The language code used to create your transcription job. This parameter is used with single-language
identification. For multi-language identification requests, refer to the plural version of this
parameter, LanguageCodes.LanguageCode,
LanguageCodeTranscriptionJob.Builder mediaSampleRateHertz(Integer mediaSampleRateHertz)
The sample rate, in hertz, of the audio track in your input media file.
mediaSampleRateHertz - The sample rate, in hertz, of the audio track in your input media file.TranscriptionJob.Builder mediaFormat(String mediaFormat)
The format of the input media file.
mediaFormat - The format of the input media file.MediaFormat,
MediaFormatTranscriptionJob.Builder mediaFormat(MediaFormat mediaFormat)
The format of the input media file.
mediaFormat - The format of the input media file.MediaFormat,
MediaFormatTranscriptionJob.Builder media(Media media)
Provides the Amazon S3 location of the media file you used in your request.
media - Provides the Amazon S3 location of the media file you used in your request.default TranscriptionJob.Builder media(Consumer<Media.Builder> media)
Provides the Amazon S3 location of the media file you used in your request.
This is a convenience method that creates an instance of theMedia.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).
media - a consumer that will call methods on Media.Buildermedia(Media)TranscriptionJob.Builder transcript(Transcript transcript)
Provides you with the Amazon S3 URI you can use to access your transcript.
transcript - Provides you with the Amazon S3 URI you can use to access your transcript.default TranscriptionJob.Builder transcript(Consumer<Transcript.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 theTranscript.Builder avoiding the need to
create one manually via Transcript.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its result
is passed to transcript(Transcript).
transcript - a consumer that will call methods on Transcript.Buildertranscript(Transcript)TranscriptionJob.Builder startTime(Instant startTime)
The date and time the specified 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.
startTime - The date and time the specified 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.
TranscriptionJob.Builder creationTime(Instant creationTime)
The date and time the specified 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.
creationTime - The date and time the specified 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.
TranscriptionJob.Builder completionTime(Instant completionTime)
The date and time the specified 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.
completionTime - The date and time the specified 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.
TranscriptionJob.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
8,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.
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 8,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.
TranscriptionJob.Builder settings(Settings 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.
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.default TranscriptionJob.Builder settings(Consumer<Settings.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 theSettings.Builder avoiding the need to
create one manually via Settings.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its result is
passed to settings(Settings).
settings - a consumer that will call methods on Settings.Buildersettings(Settings)TranscriptionJob.Builder modelSettings(ModelSettings modelSettings)
Provides information on the custom language model you included in your request.
modelSettings - Provides information on the custom language model you included in your request.default TranscriptionJob.Builder modelSettings(Consumer<ModelSettings.Builder> modelSettings)
Provides information on the custom language model you included in your request.
This is a convenience method that creates an instance of theModelSettings.Builder avoiding the need
to create one manually via ModelSettings.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to modelSettings(ModelSettings).
modelSettings - a consumer that will call methods on ModelSettings.BuildermodelSettings(ModelSettings)TranscriptionJob.Builder jobExecutionSettings(JobExecutionSettings jobExecutionSettings)
Provides information about how your transcription job was processed. This parameter shows if your request was queued and what data access role was used.
jobExecutionSettings - Provides information about how your transcription job was processed. This parameter shows if your
request was queued and what data access role was used.default TranscriptionJob.Builder jobExecutionSettings(Consumer<JobExecutionSettings.Builder> jobExecutionSettings)
Provides information about how your transcription job was processed. This parameter shows if your request was queued and what data access role was used.
This is a convenience method that creates an instance of theJobExecutionSettings.Builder avoiding
the need to create one manually via JobExecutionSettings.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and
its result is passed to jobExecutionSettings(JobExecutionSettings).
jobExecutionSettings - a consumer that will call methods on JobExecutionSettings.BuilderjobExecutionSettings(JobExecutionSettings)TranscriptionJob.Builder contentRedaction(ContentRedaction contentRedaction)
Indicates whether redaction was enabled in your transcript.
contentRedaction - Indicates whether redaction was enabled in your transcript.default TranscriptionJob.Builder contentRedaction(Consumer<ContentRedaction.Builder> contentRedaction)
Indicates whether redaction was enabled in your transcript.
This is a convenience method that creates an instance of theContentRedaction.Builder avoiding the
need to create one manually via ContentRedaction.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to contentRedaction(ContentRedaction).
contentRedaction - a consumer that will call methods on ContentRedaction.BuildercontentRedaction(ContentRedaction)TranscriptionJob.Builder identifyLanguage(Boolean identifyLanguage)
Indicates whether automatic language identification was enabled (TRUE) for the specified
transcription job.
identifyLanguage - Indicates whether automatic language identification was enabled (TRUE) for the specified
transcription job.TranscriptionJob.Builder identifyMultipleLanguages(Boolean identifyMultipleLanguages)
Indicates whether automatic multi-language identification was enabled (TRUE) for the specified
transcription job.
identifyMultipleLanguages - Indicates whether automatic multi-language identification was enabled (TRUE) for the
specified transcription job.TranscriptionJob.Builder languageOptionsWithStrings(Collection<String> languageOptions)
Provides the language codes you specified in your request.
languageOptions - Provides the language codes you specified in your request.TranscriptionJob.Builder languageOptionsWithStrings(String... languageOptions)
Provides the language codes you specified in your request.
languageOptions - Provides the language codes you specified in your request.TranscriptionJob.Builder languageOptions(Collection<LanguageCode> languageOptions)
Provides the language codes you specified in your request.
languageOptions - Provides the language codes you specified in your request.TranscriptionJob.Builder languageOptions(LanguageCode... languageOptions)
Provides the language codes you specified in your request.
languageOptions - Provides the language codes you specified in your request.TranscriptionJob.Builder identifiedLanguageScore(Float identifiedLanguageScore)
The confidence score associated with the language identified in your media file.
Confidence scores are values between 0 and 1; a larger value indicates a higher probability that the identified language correctly matches the language spoken in your media.
identifiedLanguageScore - The confidence score associated with the language identified in your media file.
Confidence scores are values between 0 and 1; a larger value indicates a higher probability that the identified language correctly matches the language spoken in your media.
TranscriptionJob.Builder languageCodes(Collection<LanguageCodeItem> languageCodes)
The language codes used to create your transcription job. This parameter is used with multi-language
identification. For single-language identification requests, refer to the singular version of this parameter,
LanguageCode.
languageCodes - The language codes used to create your transcription job. This parameter is used with multi-language
identification. For single-language identification requests, refer to the singular version of this
parameter, LanguageCode.TranscriptionJob.Builder languageCodes(LanguageCodeItem... languageCodes)
The language codes used to create your transcription job. This parameter is used with multi-language
identification. For single-language identification requests, refer to the singular version of this parameter,
LanguageCode.
languageCodes - The language codes used to create your transcription job. This parameter is used with multi-language
identification. For single-language identification requests, refer to the singular version of this
parameter, LanguageCode.TranscriptionJob.Builder languageCodes(Consumer<LanguageCodeItem.Builder>... languageCodes)
The language codes used to create your transcription job. This parameter is used with multi-language
identification. For single-language identification requests, refer to the singular version of this parameter,
LanguageCode.
LanguageCodeItem.Builder avoiding the need to create
one manually via LanguageCodeItem.builder().
When the Consumer completes,
SdkBuilder.build() is called
immediately and its result is passed to #languageCodes(List.
languageCodes - a consumer that will call methods on
LanguageCodeItem.Builder#languageCodes(java.util.Collection) TranscriptionJob.Builder tags(Collection<Tag> tags)
The tags, each in the form of a key:value pair, assigned to the specified transcription job.
tags - The tags, each in the form of a key:value pair, assigned to the specified transcription job.TranscriptionJob.Builder tags(Tag... tags)
The tags, each in the form of a key:value pair, assigned to the specified transcription job.
tags - The tags, each in the form of a key:value pair, assigned to the specified transcription job.TranscriptionJob.Builder tags(Consumer<Tag.Builder>... tags)
The tags, each in the form of a key:value pair, assigned to the specified transcription job.
This is a convenience method that creates an instance of theTag.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.
tags - a consumer that will call methods on
Tag.Builder#tags(java.util.Collection) TranscriptionJob.Builder subtitles(SubtitlesOutput subtitles)
Indicates whether subtitles were generated with your transcription.
subtitles - Indicates whether subtitles were generated with your transcription.default TranscriptionJob.Builder subtitles(Consumer<SubtitlesOutput.Builder> subtitles)
Indicates whether subtitles were generated with your transcription.
This is a convenience method that creates an instance of theSubtitlesOutput.Builder avoiding the
need to create one manually via SubtitlesOutput.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to subtitles(SubtitlesOutput).
subtitles - a consumer that will call methods on SubtitlesOutput.Buildersubtitles(SubtitlesOutput)TranscriptionJob.Builder languageIdSettingsWithStrings(Map<String,LanguageIdSettings> languageIdSettings)
Provides the name and language of all custom language models, custom vocabularies, and custom vocabulary filters that you included in your request.
languageIdSettings - Provides the name and language of all custom language models, custom vocabularies, and custom
vocabulary filters that you included in your request.TranscriptionJob.Builder languageIdSettings(Map<LanguageCode,LanguageIdSettings> languageIdSettings)
Provides the name and language of all custom language models, custom vocabularies, and custom vocabulary filters that you included in your request.
languageIdSettings - Provides the name and language of all custom language models, custom vocabularies, and custom
vocabulary filters that you included in your request.Copyright © 2023. All rights reserved.