@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class TranscriptionJob extends Object implements Serializable, Cloneable, StructuredPojo
Describes an asynchronous transcription job that was created with the StartTranscriptionJob
operation.
Constructor and Description |
---|
TranscriptionJob() |
Modifier and Type | Method and Description |
---|---|
TranscriptionJob |
clone() |
boolean |
equals(Object obj) |
Date |
getCompletionTime()
A timestamp that shows when the job was completed.
|
ContentRedaction |
getContentRedaction()
An object that describes content redaction settings for the transcription job.
|
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. |
Float |
getIdentifiedLanguageScore()
The score that Amazon Transcribe gives for the predominant language that it identified in your collection of
source audio files.
|
Boolean |
getIdentifyLanguage()
A value that shows if automatic language identification was enabled for a transcription job.
|
JobExecutionSettings |
getJobExecutionSettings()
Provides information about how a transcription job is executed.
|
String |
getLanguageCode()
The language code for the input speech.
|
List<String> |
getLanguageOptions()
An object that shows the optional array of languages inputted for transcription jobs with automatic language
identification enabled.
|
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.
|
ModelSettings |
getModelSettings()
An object containing the details of your custom language model.
|
Settings |
getSettings()
Optional settings for the transcription job.
|
Date |
getStartTime()
A timestamp that shows with the job was started processing.
|
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() |
Boolean |
isIdentifyLanguage()
A value that shows if automatic language identification was enabled for a transcription job.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setCompletionTime(Date completionTime)
A timestamp that shows when the job was completed.
|
void |
setContentRedaction(ContentRedaction contentRedaction)
An object that describes content redaction settings for the transcription job.
|
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 |
setIdentifiedLanguageScore(Float identifiedLanguageScore)
The score that Amazon Transcribe gives for the predominant language that it identified in your collection of
source audio files.
|
void |
setIdentifyLanguage(Boolean identifyLanguage)
A value that shows if automatic language identification was enabled for a transcription job.
|
void |
setJobExecutionSettings(JobExecutionSettings jobExecutionSettings)
Provides information about how a transcription job is executed.
|
void |
setLanguageCode(String languageCode)
The language code for the input speech.
|
void |
setLanguageOptions(Collection<String> languageOptions)
An object that shows the optional array of languages inputted for transcription jobs with automatic language
identification enabled.
|
void |
setMedia(Media media)
An object that describes the input media for the transcription job.
|
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 |
setModelSettings(ModelSettings modelSettings)
An object containing the details of your custom language model.
|
void |
setSettings(Settings settings)
Optional settings for the transcription job.
|
void |
setStartTime(Date startTime)
A timestamp that shows with the job was started processing.
|
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.
|
String |
toString()
Returns a string representation of this object.
|
TranscriptionJob |
withCompletionTime(Date completionTime)
A timestamp that shows when the job was completed.
|
TranscriptionJob |
withContentRedaction(ContentRedaction contentRedaction)
An object that describes content redaction settings for the transcription job.
|
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 |
withIdentifiedLanguageScore(Float identifiedLanguageScore)
The score that Amazon Transcribe gives for the predominant language that it identified in your collection of
source audio files.
|
TranscriptionJob |
withIdentifyLanguage(Boolean identifyLanguage)
A value that shows if automatic language identification was enabled for a transcription job.
|
TranscriptionJob |
withJobExecutionSettings(JobExecutionSettings jobExecutionSettings)
Provides information about how a transcription job is executed.
|
TranscriptionJob |
withLanguageCode(LanguageCode languageCode)
The language code for the input speech.
|
TranscriptionJob |
withLanguageCode(String languageCode)
The language code for the input speech.
|
TranscriptionJob |
withLanguageOptions(Collection<String> languageOptions)
An object that shows the optional array of languages inputted for transcription jobs with automatic language
identification enabled.
|
TranscriptionJob |
withLanguageOptions(LanguageCode... languageOptions)
An object that shows the optional array of languages inputted for transcription jobs with automatic language
identification enabled.
|
TranscriptionJob |
withLanguageOptions(String... languageOptions)
An object that shows the optional array of languages inputted for transcription jobs with automatic language
identification enabled.
|
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 |
withModelSettings(ModelSettings modelSettings)
An object containing the details of your custom language model.
|
TranscriptionJob |
withSettings(Settings settings)
Optional settings for the transcription job.
|
TranscriptionJob |
withStartTime(Date startTime)
A timestamp that shows with the job was started processing.
|
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.
|
public void setTranscriptionJobName(String transcriptionJobName)
The name of the transcription job.
transcriptionJobName
- The name of the transcription job.public String getTranscriptionJobName()
The name of the transcription job.
public TranscriptionJob withTranscriptionJobName(String transcriptionJobName)
The name of the transcription job.
transcriptionJobName
- The name of the transcription job.public void setTranscriptionJobStatus(String transcriptionJobStatus)
The status of the transcription job.
transcriptionJobStatus
- The status of the transcription job.TranscriptionJobStatus
public String getTranscriptionJobStatus()
The status of the transcription job.
TranscriptionJobStatus
public TranscriptionJob withTranscriptionJobStatus(String transcriptionJobStatus)
The status of the transcription job.
transcriptionJobStatus
- The status of the transcription job.TranscriptionJobStatus
public TranscriptionJob withTranscriptionJobStatus(TranscriptionJobStatus transcriptionJobStatus)
The status of the transcription job.
transcriptionJobStatus
- The status of the transcription job.TranscriptionJobStatus
public void setLanguageCode(String languageCode)
The language code for the input speech.
languageCode
- The language code for the input speech.LanguageCode
public String getLanguageCode()
The language code for the input speech.
LanguageCode
public TranscriptionJob withLanguageCode(String languageCode)
The language code for the input speech.
languageCode
- The language code for the input speech.LanguageCode
public TranscriptionJob withLanguageCode(LanguageCode languageCode)
The language code for the input speech.
languageCode
- The language code for the input speech.LanguageCode
public void setMediaSampleRateHertz(Integer mediaSampleRateHertz)
The sample rate, in Hertz, of the audio track in the input media file.
mediaSampleRateHertz
- The sample rate, in Hertz, of the audio track in the input media file.public Integer getMediaSampleRateHertz()
The sample rate, in Hertz, of the audio track in the input media file.
public TranscriptionJob withMediaSampleRateHertz(Integer mediaSampleRateHertz)
The sample rate, in Hertz, of the audio track in the input media file.
mediaSampleRateHertz
- The sample rate, in Hertz, of the audio track in the input media file.public void setMediaFormat(String mediaFormat)
The format of the input media file.
mediaFormat
- The format of the input media file.MediaFormat
public String getMediaFormat()
The format of the input media file.
MediaFormat
public TranscriptionJob withMediaFormat(String mediaFormat)
The format of the input media file.
mediaFormat
- The format of the input media file.MediaFormat
public TranscriptionJob withMediaFormat(MediaFormat mediaFormat)
The format of the input media file.
mediaFormat
- The format of the input media file.MediaFormat
public void setMedia(Media media)
An object that describes the input media for the transcription job.
media
- An object that describes the input media for the transcription job.public Media getMedia()
An object that describes the input media for the transcription job.
public TranscriptionJob withMedia(Media media)
An object that describes the input media for the transcription job.
media
- An object that describes the input media for the transcription job.public void setTranscript(Transcript transcript)
An object that describes the output of the transcription job.
transcript
- An object that describes the output of the transcription job.public Transcript getTranscript()
An object that describes the output of the transcription job.
public TranscriptionJob withTranscript(Transcript transcript)
An object that describes the output of the transcription job.
transcript
- An object that describes the output of the transcription job.public void setStartTime(Date startTime)
A timestamp that shows with the job was started processing.
startTime
- A timestamp that shows with the job was started processing.public Date getStartTime()
A timestamp that shows with the job was started processing.
public TranscriptionJob withStartTime(Date startTime)
A timestamp that shows with the job was started processing.
startTime
- A timestamp that shows with the job was started processing.public void setCreationTime(Date creationTime)
A timestamp that shows when the job was created.
creationTime
- A timestamp that shows when the job was created.public Date getCreationTime()
A timestamp that shows when the job was created.
public TranscriptionJob withCreationTime(Date creationTime)
A timestamp that shows when the job was created.
creationTime
- A timestamp that shows when the job was created.public void setCompletionTime(Date completionTime)
A timestamp that shows when the job was completed.
completionTime
- A timestamp that shows when the job was completed.public Date getCompletionTime()
A timestamp that shows when the job was completed.
public TranscriptionJob withCompletionTime(Date completionTime)
A timestamp that shows when the job was completed.
completionTime
- A timestamp that shows when the job was completed.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.
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.
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.
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.
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.
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.
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.
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.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.
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.
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.public void setModelSettings(ModelSettings modelSettings)
An object containing the details of your custom language model.
modelSettings
- An object containing the details of your custom language model.public ModelSettings getModelSettings()
An object containing the details of your custom language model.
public TranscriptionJob withModelSettings(ModelSettings modelSettings)
An object containing the details of your custom language model.
modelSettings
- An object containing the details of your custom language model.public void setJobExecutionSettings(JobExecutionSettings jobExecutionSettings)
Provides information about how a transcription job is executed.
jobExecutionSettings
- Provides information about how a transcription job is executed.public JobExecutionSettings getJobExecutionSettings()
Provides information about how a transcription job is executed.
public TranscriptionJob withJobExecutionSettings(JobExecutionSettings jobExecutionSettings)
Provides information about how a transcription job is executed.
jobExecutionSettings
- Provides information about how a transcription job is executed.public void setContentRedaction(ContentRedaction contentRedaction)
An object that describes content redaction settings for the transcription job.
contentRedaction
- An object that describes content redaction settings for the transcription job.public ContentRedaction getContentRedaction()
An object that describes content redaction settings for the transcription job.
public TranscriptionJob withContentRedaction(ContentRedaction contentRedaction)
An object that describes content redaction settings for the transcription job.
contentRedaction
- An object that describes content redaction settings for the transcription job.public void setIdentifyLanguage(Boolean identifyLanguage)
A value that shows if automatic language identification was enabled for a transcription job.
identifyLanguage
- A value that shows if automatic language identification was enabled for a transcription job.public Boolean getIdentifyLanguage()
A value that shows if automatic language identification was enabled for a transcription job.
public TranscriptionJob withIdentifyLanguage(Boolean identifyLanguage)
A value that shows if automatic language identification was enabled for a transcription job.
identifyLanguage
- A value that shows if automatic language identification was enabled for a transcription job.public Boolean isIdentifyLanguage()
A value that shows if automatic language identification was enabled for a transcription job.
public List<String> getLanguageOptions()
An object that shows the optional array of languages inputted for transcription jobs with automatic language identification enabled.
LanguageCode
public void setLanguageOptions(Collection<String> languageOptions)
An object that shows the optional array of languages inputted for transcription jobs with automatic language identification enabled.
languageOptions
- An object that shows the optional array of languages inputted for transcription jobs with automatic
language identification enabled.LanguageCode
public TranscriptionJob withLanguageOptions(String... languageOptions)
An object that shows the optional array of languages inputted for transcription jobs with automatic language identification enabled.
NOTE: This method appends the values to the existing list (if any). Use
setLanguageOptions(java.util.Collection)
or withLanguageOptions(java.util.Collection)
if you
want to override the existing values.
languageOptions
- An object that shows the optional array of languages inputted for transcription jobs with automatic
language identification enabled.LanguageCode
public TranscriptionJob withLanguageOptions(Collection<String> languageOptions)
An object that shows the optional array of languages inputted for transcription jobs with automatic language identification enabled.
languageOptions
- An object that shows the optional array of languages inputted for transcription jobs with automatic
language identification enabled.LanguageCode
public TranscriptionJob withLanguageOptions(LanguageCode... languageOptions)
An object that shows the optional array of languages inputted for transcription jobs with automatic language identification enabled.
languageOptions
- An object that shows the optional array of languages inputted for transcription jobs with automatic
language identification enabled.LanguageCode
public void setIdentifiedLanguageScore(Float identifiedLanguageScore)
The score that Amazon Transcribe gives for the predominant language that it identified in your collection of source audio files. This score reflects the confidence that the language that Amazon Transcribe identified is the correct language.
identifiedLanguageScore
- The score that Amazon Transcribe gives for the predominant language that it identified in your collection
of source audio files. This score reflects the confidence that the language that Amazon Transcribe
identified is the correct language.public Float getIdentifiedLanguageScore()
The score that Amazon Transcribe gives for the predominant language that it identified in your collection of source audio files. This score reflects the confidence that the language that Amazon Transcribe identified is the correct language.
public TranscriptionJob withIdentifiedLanguageScore(Float identifiedLanguageScore)
The score that Amazon Transcribe gives for the predominant language that it identified in your collection of source audio files. This score reflects the confidence that the language that Amazon Transcribe identified is the correct language.
identifiedLanguageScore
- The score that Amazon Transcribe gives for the predominant language that it identified in your collection
of source audio files. This score reflects the confidence that the language that Amazon Transcribe
identified is the correct language.public String toString()
toString
in class Object
Object.toString()
public TranscriptionJob clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.