software.amazon.awssdk.services.transcribe.model

Interface TranscriptionJob.Builder

All Superinterfaces:

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

Enclosing class:

TranscriptionJob

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

Method Summary

Modifier and Type	Method and Description
TranscriptionJob.Builder	completionTime(Instant completionTime) A timestamp that shows when the job was completed.
TranscriptionJob.Builder	creationTime(Instant creationTime) A timestamp that shows when the job was created.
TranscriptionJob.Builder	failureReason(String failureReason) If the TranscriptionJobStatus field is FAILED, this field contains information about why the job failed.
TranscriptionJob.Builder	languageCode(LanguageCode languageCode) The language code for the input speech.
TranscriptionJob.Builder	languageCode(String languageCode) The language code for the input speech.
default TranscriptionJob.Builder	media(Consumer<Media.Builder> media) An object that describes the input media for the transcription job.
TranscriptionJob.Builder	media(Media media) An object that describes the input media for the transcription job.
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 the input media file.
default TranscriptionJob.Builder	settings(Consumer<Settings.Builder> settings) Optional settings for the transcription job.
TranscriptionJob.Builder	settings(Settings settings) Optional settings for the transcription job.
default TranscriptionJob.Builder	transcript(Consumer<Transcript.Builder> transcript) An object that describes the output of the transcription job.
TranscriptionJob.Builder	transcript(Transcript transcript) An object that describes the output of the transcription job.
TranscriptionJob.Builder	transcriptionJobName(String transcriptionJobName) The name of the transcription job.
TranscriptionJob.Builder	transcriptionJobStatus(String transcriptionJobStatus) The status of the transcription job.
TranscriptionJob.Builder	transcriptionJobStatus(TranscriptionJobStatus transcriptionJobStatus) The status of the transcription job.

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

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

transcriptionJobName

TranscriptionJob.Builder transcriptionJobName(String transcriptionJobName)

The name of the transcription job.

Parameters:

transcriptionJobName - The name of the transcription job.

Returns:

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

transcriptionJobStatus

TranscriptionJob.Builder transcriptionJobStatus(String transcriptionJobStatus)

The status of the transcription job.

Parameters:

transcriptionJobStatus - The status of the transcription job.

Returns:

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

See Also:

TranscriptionJobStatus, TranscriptionJobStatus

transcriptionJobStatus

TranscriptionJob.Builder transcriptionJobStatus(TranscriptionJobStatus transcriptionJobStatus)

The status of the transcription job.

Parameters:

transcriptionJobStatus - The status of the transcription job.

Returns:

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

See Also:

TranscriptionJobStatus, TranscriptionJobStatus

languageCode

TranscriptionJob.Builder languageCode(String languageCode)

The language code for the input speech.

Parameters:

languageCode - The language code for the input speech.

Returns:

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

See Also:

LanguageCode, LanguageCode

languageCode

TranscriptionJob.Builder languageCode(LanguageCode languageCode)

The language code for the input speech.

Parameters:

languageCode - The language code for the input speech.

Returns:

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

See Also:

LanguageCode, LanguageCode

mediaSampleRateHertz

TranscriptionJob.Builder mediaSampleRateHertz(Integer mediaSampleRateHertz)

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

Parameters:

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

Returns:

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

mediaFormat

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

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

TranscriptionJob.Builder media(Media media)

An object that describes the input media for the transcription job.

Parameters:

media - An object that describes the input media for the transcription job.

Returns:

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

media

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

An object that describes the input media for the transcription job.

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

TranscriptionJob.Builder transcript(Transcript transcript)

An object that describes the output of the transcription job.

Parameters:

transcript - An object that describes the output of the transcription job.

Returns:

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

transcript

default TranscriptionJob.Builder transcript(Consumer<Transcript.Builder> transcript)

An object that describes the output of the transcription job.

This is a convenience that creates an instance of the Transcript.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).

Parameters:

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

Returns:

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

See Also:

transcript(Transcript)

creationTime

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

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

TranscriptionJob.Builder failureReason(String failureReason)

If the TranscriptionJobStatus field is FAILED, this field contains information about why the job failed.

The FailureReason field can contain 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 that 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 8000 and 48000 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 Amazon Transcribe can process. For more information, see Limits in the Amazon Transcribe Developer Guide.

• Invalid number of channels: number of channels too large - Your audio contains more channels than Amazon Transcribe is configured to process. To request additional channels, see Amazon Transcribe Limits 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 can contain 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 that 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 8000 and 48000 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 Amazon Transcribe can process. For more information, see Limits in the Amazon Transcribe Developer Guide.

• Invalid number of channels: number of channels too large - Your audio contains more channels than Amazon Transcribe is configured to process. To request additional channels, see Amazon Transcribe Limits in the Amazon Web Services General Reference.

Returns:

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

settings

TranscriptionJob.Builder settings(Settings settings)

Optional settings for the transcription job. Use these settings to turn on speaker recognition, to set the maximum number of speakers that should be identified and to specify a custom vocabulary to use when processing the transcription job.

Parameters:

settings - Optional settings for the transcription job. Use these settings to turn on speaker recognition, to set the maximum number of speakers that should be identified and to specify a custom vocabulary to use when processing the transcription job.

Returns:

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

settings

default TranscriptionJob.Builder settings(Consumer<Settings.Builder> settings)

Optional settings for the transcription job. Use these settings to turn on speaker recognition, to set the maximum number of speakers that should be identified and to specify a custom vocabulary to use when processing the transcription job.

This is a convenience that creates an instance of the Settings.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).

Parameters:

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

Returns:

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

See Also:

settings(Settings)