software.amazon.awssdk.services.transcribe.model

Class TranscriptionJob

java.lang.Object

software.amazon.awssdk.services.transcribe.model.TranscriptionJob

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<TranscriptionJob.Builder,TranscriptionJob>

@Generated(value="software.amazon.awssdk:codegen")
public final class TranscriptionJob
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<TranscriptionJob.Builder,TranscriptionJob>

Describes an asynchronous transcription job that was created with the StartTranscriptionJob operation.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TranscriptionJob.Builder

Method Summary

Modifier and Type	Method and Description
static TranscriptionJob.Builder	builder()
Instant	completionTime() A timestamp that shows when the job was completed.
ContentRedaction	contentRedaction() An object that describes content redaction settings for the transcription job.
Instant	creationTime() A timestamp that shows when the job was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
String	failureReason() If the TranscriptionJobStatus field is FAILED, this field contains information about why the job failed.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
JobExecutionSettings	jobExecutionSettings() Provides information about how a transcription job is executed.
LanguageCode	languageCode() The language code for the input speech.
String	languageCodeAsString() The language code for the input speech.
Media	media() An object that describes the input media for the transcription job.
MediaFormat	mediaFormat() The format of the input media file.
String	mediaFormatAsString() The format of the input media file.
Integer	mediaSampleRateHertz() The sample rate, in Hertz, of the audio track in the input media file.
List<SdkField<?>>	sdkFields()
static Class<? extends TranscriptionJob.Builder>	serializableBuilderClass()
Settings	settings() Optional settings for the transcription job.
Instant	startTime() A timestamp that shows with the job was started processing.
TranscriptionJob.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.
Transcript	transcript() An object that describes the output of the transcription job.
String	transcriptionJobName() The name of the transcription job.
TranscriptionJobStatus	transcriptionJobStatus() The status of the transcription job.
String	transcriptionJobStatusAsString() The status of the transcription job.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

transcriptionJobName

public String transcriptionJobName()

The name of the transcription job.

Returns:

The name of the transcription job.

transcriptionJobStatus

public TranscriptionJobStatus transcriptionJobStatus()

The status of the transcription job.

If the service returns an enum value that is not available in the current SDK version, transcriptionJobStatus will return TranscriptionJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from transcriptionJobStatusAsString().

Returns:

The status of the transcription job.

See Also:

TranscriptionJobStatus

transcriptionJobStatusAsString

public String transcriptionJobStatusAsString()

The status of the transcription job.

If the service returns an enum value that is not available in the current SDK version, transcriptionJobStatus will return TranscriptionJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from transcriptionJobStatusAsString().

Returns:

The status of the transcription job.

See Also:

TranscriptionJobStatus

languageCode

public LanguageCode languageCode()

The language code for the input speech.

If the service returns an enum value that is not available in the current SDK version, languageCode will return LanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from languageCodeAsString().

Returns:

The language code for the input speech.

See Also:

LanguageCode

languageCodeAsString

public String languageCodeAsString()

The language code for the input speech.

If the service returns an enum value that is not available in the current SDK version, languageCode will return LanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from languageCodeAsString().

Returns:

The language code for the input speech.

See Also:

LanguageCode

mediaSampleRateHertz

public Integer mediaSampleRateHertz()

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

Returns:

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

mediaFormat

public MediaFormat mediaFormat()

The format of the input media file.

If the service returns an enum value that is not available in the current SDK version, mediaFormat will return MediaFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from mediaFormatAsString().

Returns:

The format of the input media file.

See Also:

MediaFormat

mediaFormatAsString

public String mediaFormatAsString()

The format of the input media file.

If the service returns an enum value that is not available in the current SDK version, mediaFormat will return MediaFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from mediaFormatAsString().

Returns:

The format of the input media file.

See Also:

MediaFormat

media

public Media media()

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

Returns:

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

transcript

public Transcript transcript()

An object that describes the output of the transcription job.

Returns:

An object that describes the output of the transcription job.

startTime

public Instant startTime()

A timestamp that shows with the job was started processing.

Returns:

A timestamp that shows with the job was started processing.

creationTime

public Instant creationTime()

A timestamp that shows when the job was created.

Returns:

A timestamp that shows when the job was created.

completionTime

public Instant completionTime()

A timestamp that shows when the job was completed.

Returns:

A timestamp that shows when the job was completed.

failureReason

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

Returns:

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.

settings

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

Returns:

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.

jobExecutionSettings

public JobExecutionSettings jobExecutionSettings()

Provides information about how a transcription job is executed.

Returns:

Provides information about how a transcription job is executed.

contentRedaction

public ContentRedaction contentRedaction()

An object that describes content redaction settings for the transcription job.

Returns:

An object that describes content redaction settings for the transcription job.

toBuilder

public TranscriptionJob.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<TranscriptionJob.Builder,TranscriptionJob>

Returns:

a builder for type T

builder

public static TranscriptionJob.Builder builder()

serializableBuilderClass

public static Class<? extends TranscriptionJob.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.