com.amazonaws.services.transcribe.model

Class TranscriptionJob

java.lang.Object

com.amazonaws.services.transcribe.model.TranscriptionJob

All Implemented Interfaces:

Serializable

public class TranscriptionJob
extends Object
implements Serializable

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TranscriptionJob()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Date	getCompletionTime() A timestamp that shows when the job was completed.
Date	getCreationTime() A timestamp that shows when the job was created.
String	getFailureReason() If the TranscriptionJobStatus field is FAILED, this field contains information about why the job failed.
String	getLanguageCode() The language code for the input speech.
Media	getMedia() An object that describes the input media for the transcription job.
String	getMediaFormat() The format of the input media file.
Integer	getMediaSampleRateHertz() The sample rate, in Hertz, of the audio track in the input media file.
Settings	getSettings() Optional settings for the transcription job.
Transcript	getTranscript() An object that describes the output of the transcription job.
String	getTranscriptionJobName() The name of the transcription job.
String	getTranscriptionJobStatus() The status of the transcription job.
int	hashCode()
void	setCompletionTime(Date completionTime) A timestamp that shows when the job was completed.
void	setCreationTime(Date creationTime) A timestamp that shows when the job was created.
void	setFailureReason(String failureReason) If the TranscriptionJobStatus field is FAILED, this field contains information about why the job failed.
void	setLanguageCode(LanguageCode languageCode) The language code for the input speech.
void	setLanguageCode(String languageCode) The language code for the input speech.
void	setMedia(Media media) An object that describes the input media for the transcription job.
void	setMediaFormat(MediaFormat mediaFormat) The format of the input media file.
void	setMediaFormat(String mediaFormat) The format of the input media file.
void	setMediaSampleRateHertz(Integer mediaSampleRateHertz) The sample rate, in Hertz, of the audio track in the input media file.
void	setSettings(Settings settings) Optional settings for the transcription job.
void	setTranscript(Transcript transcript) An object that describes the output of the transcription job.
void	setTranscriptionJobName(String transcriptionJobName) The name of the transcription job.
void	setTranscriptionJobStatus(String transcriptionJobStatus) The status of the transcription job.
void	setTranscriptionJobStatus(TranscriptionJobStatus transcriptionJobStatus) The status of the transcription job.
String	toString() Returns a string representation of this object; useful for testing and debugging.
TranscriptionJob	withCompletionTime(Date completionTime) A timestamp that shows when the job was completed.
TranscriptionJob	withCreationTime(Date creationTime) A timestamp that shows when the job was created.
TranscriptionJob	withFailureReason(String failureReason) If the TranscriptionJobStatus field is FAILED, this field contains information about why the job failed.
TranscriptionJob	withLanguageCode(LanguageCode languageCode) The language code for the input speech.
TranscriptionJob	withLanguageCode(String languageCode) The language code for the input speech.
TranscriptionJob	withMedia(Media media) An object that describes the input media for the transcription job.
TranscriptionJob	withMediaFormat(MediaFormat mediaFormat) The format of the input media file.
TranscriptionJob	withMediaFormat(String mediaFormat) The format of the input media file.
TranscriptionJob	withMediaSampleRateHertz(Integer mediaSampleRateHertz) The sample rate, in Hertz, of the audio track in the input media file.
TranscriptionJob	withSettings(Settings settings) Optional settings for the transcription job.
TranscriptionJob	withTranscript(Transcript transcript) An object that describes the output of the transcription job.
TranscriptionJob	withTranscriptionJobName(String transcriptionJobName) The name of the transcription job.
TranscriptionJob	withTranscriptionJobStatus(String transcriptionJobStatus) The status of the transcription job.
TranscriptionJob	withTranscriptionJobStatus(TranscriptionJobStatus transcriptionJobStatus) The status of the transcription job.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TranscriptionJob

public TranscriptionJob()

Method Detail

getTranscriptionJobName

public String getTranscriptionJobName()

The name of the transcription job.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

Returns:

The name of the transcription job.

setTranscriptionJobName

public void setTranscriptionJobName(String transcriptionJobName)

The name of the transcription job.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

Parameters:

transcriptionJobName -

The name of the transcription job.

withTranscriptionJobName

public TranscriptionJob withTranscriptionJobName(String transcriptionJobName)

The name of the transcription job.

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

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

Parameters:

transcriptionJobName -

The name of the transcription job.

Returns:

A reference to this updated object so that method calls can be chained together.

getTranscriptionJobStatus

public String getTranscriptionJobStatus()

The status of the transcription job.

Constraints:
Allowed Values: IN_PROGRESS, FAILED, COMPLETED

Returns:

The status of the transcription job.

See Also:

TranscriptionJobStatus

setTranscriptionJobStatus

public void setTranscriptionJobStatus(String transcriptionJobStatus)

The status of the transcription job.

Constraints:
Allowed Values: IN_PROGRESS, FAILED, COMPLETED

Parameters:

transcriptionJobStatus -

The status of the transcription job.

See Also:

TranscriptionJobStatus

withTranscriptionJobStatus

public TranscriptionJob withTranscriptionJobStatus(String transcriptionJobStatus)

The status of the transcription job.

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

Constraints:
Allowed Values: IN_PROGRESS, FAILED, COMPLETED

Parameters:

transcriptionJobStatus -

The status of the transcription job.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

TranscriptionJobStatus

setTranscriptionJobStatus

public void setTranscriptionJobStatus(TranscriptionJobStatus transcriptionJobStatus)

The status of the transcription job.

Constraints:
Allowed Values: IN_PROGRESS, FAILED, COMPLETED

Parameters:

transcriptionJobStatus -

The status of the transcription job.

See Also:

TranscriptionJobStatus

withTranscriptionJobStatus

public TranscriptionJob withTranscriptionJobStatus(TranscriptionJobStatus transcriptionJobStatus)

The status of the transcription job.

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

Constraints:
Allowed Values: IN_PROGRESS, FAILED, COMPLETED

Parameters:

transcriptionJobStatus -

The status of the transcription job.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

TranscriptionJobStatus

getLanguageCode

public String getLanguageCode()

The language code for the input speech.

Constraints:
Allowed Values: en-US, es-US, en-AU, fr-CA, en-GB, de-DE, pt-BR, fr-FR, it-IT, ko-KR

Returns:

The language code for the input speech.

See Also:

LanguageCode

setLanguageCode

public void setLanguageCode(String languageCode)

The language code for the input speech.

Constraints:
Allowed Values: en-US, es-US, en-AU, fr-CA, en-GB, de-DE, pt-BR, fr-FR, it-IT, ko-KR

Parameters:

languageCode -

The language code for the input speech.

See Also:

LanguageCode

withLanguageCode

public TranscriptionJob withLanguageCode(String languageCode)

The language code for the input speech.

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

Constraints:
Allowed Values: en-US, es-US, en-AU, fr-CA, en-GB, de-DE, pt-BR, fr-FR, it-IT, ko-KR

Parameters:

languageCode -

The language code for the input speech.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

LanguageCode

setLanguageCode

public void setLanguageCode(LanguageCode languageCode)

The language code for the input speech.

Constraints:
Allowed Values: en-US, es-US, en-AU, fr-CA, en-GB, de-DE, pt-BR, fr-FR, it-IT, ko-KR

Parameters:

languageCode -

The language code for the input speech.

See Also:

LanguageCode

withLanguageCode

public TranscriptionJob withLanguageCode(LanguageCode languageCode)

The language code for the input speech.

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

Constraints:
Allowed Values: en-US, es-US, en-AU, fr-CA, en-GB, de-DE, pt-BR, fr-FR, it-IT, ko-KR

Parameters:

languageCode -

The language code for the input speech.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

LanguageCode

getMediaSampleRateHertz

public Integer getMediaSampleRateHertz()

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

Constraints:
Range: 8000 - 48000

Returns:

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

setMediaSampleRateHertz

public void setMediaSampleRateHertz(Integer mediaSampleRateHertz)

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

Constraints:
Range: 8000 - 48000

Parameters:

mediaSampleRateHertz -

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

withMediaSampleRateHertz

public TranscriptionJob withMediaSampleRateHertz(Integer mediaSampleRateHertz)

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

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

Constraints:
Range: 8000 - 48000

Parameters:

mediaSampleRateHertz -

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

Returns:

A reference to this updated object so that method calls can be chained together.

getMediaFormat

public String getMediaFormat()

The format of the input media file.

Constraints:
Allowed Values: mp3, mp4, wav, flac

Returns:

The format of the input media file.

See Also:

MediaFormat

setMediaFormat

public void setMediaFormat(String mediaFormat)

The format of the input media file.

Constraints:
Allowed Values: mp3, mp4, wav, flac

Parameters:

mediaFormat -

The format of the input media file.

See Also:

MediaFormat

withMediaFormat

public TranscriptionJob withMediaFormat(String mediaFormat)

The format of the input media file.

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

Constraints:
Allowed Values: mp3, mp4, wav, flac

Parameters:

mediaFormat -

The format of the input media file.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

MediaFormat

setMediaFormat

public void setMediaFormat(MediaFormat mediaFormat)

The format of the input media file.

Constraints:
Allowed Values: mp3, mp4, wav, flac

Parameters:

mediaFormat -

The format of the input media file.

See Also:

MediaFormat

withMediaFormat

public TranscriptionJob withMediaFormat(MediaFormat mediaFormat)

The format of the input media file.

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

Constraints:
Allowed Values: mp3, mp4, wav, flac

Parameters:

mediaFormat -

The format of the input media file.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

MediaFormat

getMedia

public Media getMedia()

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

Returns:

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

setMedia

public void setMedia(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.

withMedia

public TranscriptionJob withMedia(Media media)

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

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

Parameters:

media -

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

Returns:

A reference to this updated object so that method calls can be chained together.

getTranscript

public Transcript getTranscript()

An object that describes the output of the transcription job.

Returns:

An object that describes the output of the transcription job.

setTranscript

public void setTranscript(Transcript transcript)

An object that describes the output of the transcription job.

Parameters:

transcript -

An object that describes the output of the transcription job.

withTranscript

public TranscriptionJob withTranscript(Transcript transcript)

An object that describes the output of the transcription job.

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

Parameters:

transcript -

An object that describes the output of the transcription job.

Returns:

A reference to this updated object so that method calls can be chained together.

getCreationTime

public Date getCreationTime()

A timestamp that shows when the job was created.

Returns:

A timestamp that shows when the job was created.

setCreationTime

public void setCreationTime(Date creationTime)

A timestamp that shows when the job was created.

Parameters:

creationTime -

A timestamp that shows when the job was created.

withCreationTime

public TranscriptionJob withCreationTime(Date creationTime)

A timestamp that shows when the job was created.

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

Parameters:

creationTime -

A timestamp that shows when the job was created.

Returns:

A reference to this updated object so that method calls can be chained together.

getCompletionTime

public Date getCompletionTime()

A timestamp that shows when the job was completed.

Returns:

A timestamp that shows when the job was completed.

setCompletionTime

public void setCompletionTime(Date completionTime)

A timestamp that shows when the job was completed.

Parameters:

completionTime -

A timestamp that shows when the job was completed.

withCompletionTime

public TranscriptionJob withCompletionTime(Date completionTime)

A timestamp that shows when the job was completed.

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

Parameters:

completionTime -

A timestamp that shows when the job was completed.

Returns:

A reference to this updated object so that method calls can be chained together.

getFailureReason

public String getFailureReason()

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.

setFailureReason

public void setFailureReason(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.

withFailureReason

public TranscriptionJob withFailureReason(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 a reference to this object so that method calls can be chained together.

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:

A reference to this updated object so that method calls can be chained together.

getSettings

public Settings getSettings()

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.

setSettings

public void setSettings(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.

withSettings

public TranscriptionJob withSettings(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 a reference to this object so that method calls can be chained together.

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:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object