software.amazon.awssdk.services.transcribe.model

Interface TranscriptionJobSummary.Builder

All Superinterfaces:

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

Enclosing class:

TranscriptionJobSummary

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

Method Summary

Modifier and Type	Method and Description
TranscriptionJobSummary.Builder	completionTime(Instant completionTime) A timestamp that shows when the job was completed.
default TranscriptionJobSummary.Builder	contentRedaction(Consumer<ContentRedaction.Builder> contentRedaction) The content redaction settings of the transcription job.
TranscriptionJobSummary.Builder	contentRedaction(ContentRedaction contentRedaction) The content redaction settings of the transcription job.
TranscriptionJobSummary.Builder	creationTime(Instant creationTime) A timestamp that shows when the job was created.
TranscriptionJobSummary.Builder	failureReason(String failureReason) If the TranscriptionJobStatus field is FAILED, a description of the error.
TranscriptionJobSummary.Builder	identifiedLanguageScore(Float identifiedLanguageScore) A value between zero and one that Amazon Transcribe assigned to the language it identified in the source audio.
TranscriptionJobSummary.Builder	identifyLanguage(Boolean identifyLanguage) Whether automatic language identification was enabled for a transcription job.
TranscriptionJobSummary.Builder	languageCode(LanguageCode languageCode) The language code for the input speech.
TranscriptionJobSummary.Builder	languageCode(String languageCode) The language code for the input speech.
default TranscriptionJobSummary.Builder	modelSettings(Consumer<ModelSettings.Builder> modelSettings) Sets the value of the ModelSettings property for this object.
TranscriptionJobSummary.Builder	modelSettings(ModelSettings modelSettings) Sets the value of the ModelSettings property for this object.
TranscriptionJobSummary.Builder	outputLocationType(OutputLocationType outputLocationType) Indicates the location of the output of the transcription job.
TranscriptionJobSummary.Builder	outputLocationType(String outputLocationType) Indicates the location of the output of the transcription job.
TranscriptionJobSummary.Builder	startTime(Instant startTime) A timestamp that shows when the job started processing.
TranscriptionJobSummary.Builder	transcriptionJobName(String transcriptionJobName) The name of the transcription job.
TranscriptionJobSummary.Builder	transcriptionJobStatus(String transcriptionJobStatus) The status of the transcription job.
TranscriptionJobSummary.Builder	transcriptionJobStatus(TranscriptionJobStatus transcriptionJobStatus) The status of 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

transcriptionJobName

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

creationTime

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

startTime

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

completionTime

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

languageCode

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

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

transcriptionJobStatus

TranscriptionJobSummary.Builder transcriptionJobStatus(String transcriptionJobStatus)

The status of the transcription job. When the status is COMPLETED, use the GetTranscriptionJob operation to get the results of the transcription.

Parameters:

transcriptionJobStatus - The status of the transcription job. When the status is COMPLETED, use the GetTranscriptionJob operation to get the results of the transcription.

Returns:

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

See Also:

TranscriptionJobStatus, TranscriptionJobStatus

transcriptionJobStatus

TranscriptionJobSummary.Builder transcriptionJobStatus(TranscriptionJobStatus transcriptionJobStatus)

The status of the transcription job. When the status is COMPLETED, use the GetTranscriptionJob operation to get the results of the transcription.

Parameters:

transcriptionJobStatus - The status of the transcription job. When the status is COMPLETED, use the GetTranscriptionJob operation to get the results of the transcription.

Returns:

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

See Also:

TranscriptionJobStatus, TranscriptionJobStatus

failureReason

TranscriptionJobSummary.Builder failureReason(String failureReason)

If the TranscriptionJobStatus field is FAILED, a description of the error.

Parameters:

failureReason - If the TranscriptionJobStatus field is FAILED, a description of the error.

Returns:

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

outputLocationType

TranscriptionJobSummary.Builder outputLocationType(String outputLocationType)

Indicates the location of the output of the transcription job.

If the value is CUSTOMER_BUCKET then the location is the S3 bucket specified in the outputBucketName field when the transcription job was started with the StartTranscriptionJob operation.

If the value is SERVICE_BUCKET then the output is stored by Amazon Transcribe and can be retrieved using the URI in the GetTranscriptionJob response's TranscriptFileUri field.

Parameters:

outputLocationType - Indicates the location of the output of the transcription job.

If the value is CUSTOMER_BUCKET then the location is the S3 bucket specified in the outputBucketName field when the transcription job was started with the StartTranscriptionJob operation.

If the value is SERVICE_BUCKET then the output is stored by Amazon Transcribe and can be retrieved using the URI in the GetTranscriptionJob response's TranscriptFileUri field.

Returns:

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

See Also:

OutputLocationType, OutputLocationType

outputLocationType

TranscriptionJobSummary.Builder outputLocationType(OutputLocationType outputLocationType)

Indicates the location of the output of the transcription job.

If the value is CUSTOMER_BUCKET then the location is the S3 bucket specified in the outputBucketName field when the transcription job was started with the StartTranscriptionJob operation.

If the value is SERVICE_BUCKET then the output is stored by Amazon Transcribe and can be retrieved using the URI in the GetTranscriptionJob response's TranscriptFileUri field.

Parameters:

outputLocationType - Indicates the location of the output of the transcription job.

If the value is CUSTOMER_BUCKET then the location is the S3 bucket specified in the outputBucketName field when the transcription job was started with the StartTranscriptionJob operation.

If the value is SERVICE_BUCKET then the output is stored by Amazon Transcribe and can be retrieved using the URI in the GetTranscriptionJob response's TranscriptFileUri field.

Returns:

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

See Also:

OutputLocationType, OutputLocationType

contentRedaction

TranscriptionJobSummary.Builder contentRedaction(ContentRedaction contentRedaction)

The content redaction settings of the transcription job.

Parameters:

contentRedaction - The content redaction settings of the transcription job.

Returns:

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

contentRedaction

default TranscriptionJobSummary.Builder contentRedaction(Consumer<ContentRedaction.Builder> contentRedaction)

The content redaction settings of the transcription job.

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

Parameters:

contentRedaction - a consumer that will call methods on ContentRedaction.Builder

Returns:

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

See Also:

contentRedaction(ContentRedaction)

modelSettings

TranscriptionJobSummary.Builder modelSettings(ModelSettings modelSettings)

Sets the value of the ModelSettings property for this object.

Parameters:

modelSettings - The new value for the ModelSettings property for this object.

Returns:

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

modelSettings

default TranscriptionJobSummary.Builder modelSettings(Consumer<ModelSettings.Builder> modelSettings)

Sets the value of the ModelSettings property for this object. This is a convenience that creates an instance of the ModelSettings.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).

Parameters:

modelSettings - a consumer that will call methods on ModelSettings.Builder

Returns:

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

See Also:

modelSettings(ModelSettings)

identifyLanguage

TranscriptionJobSummary.Builder identifyLanguage(Boolean identifyLanguage)

Whether automatic language identification was enabled for a transcription job.

Parameters:

identifyLanguage - Whether automatic language identification was enabled for a transcription job.

Returns:

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

identifiedLanguageScore

TranscriptionJobSummary.Builder identifiedLanguageScore(Float identifiedLanguageScore)

A value between zero and one that Amazon Transcribe assigned to the language it identified in the source audio. A higher score indicates that Amazon Transcribe is more confident in the language it identified.

Parameters:

identifiedLanguageScore - A value between zero and one that Amazon Transcribe assigned to the language it identified in the source audio. A higher score indicates that Amazon Transcribe is more confident in the language it identified.

Returns:

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