/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.transcribe.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *
* Provides detailed information about a transcription job. *
*
* To view the status of the specified transcription job, check the TranscriptionJobStatus
field. If the
* status is COMPLETED
, the job is finished and you can find the results at the location specified in
* TranscriptFileUri
. If the status is FAILED
, FailureReason
provides details on
* why your transcription job failed.
*
* If you enabled content redaction, the redacted transcript can be found at the location specified in
* RedactedTranscriptFileUri
.
*
* The name of the transcription job. Job names are case sensitive and must be unique within an Amazon Web Services * account. *
*/ private String transcriptionJobName; /** ** Provides the status of the specified transcription job. *
*
* If the status is COMPLETED
, the job is finished and you can find the results at the location
* specified in TranscriptFileUri
(or RedactedTranscriptFileUri
, if you requested
* transcript redaction). If the status is FAILED
, FailureReason
provides details on why
* your transcription job failed.
*
* The language code used to create your transcription job. This parameter is used with single-language
* identification. For multi-language identification requests, refer to the plural version of this parameter,
* LanguageCodes
.
*
* The sample rate, in hertz, of the audio track in your input media file. *
*/ private Integer mediaSampleRateHertz; /** ** The format of the input media file. *
*/ private String mediaFormat; /** ** Provides the Amazon S3 location of the media file you used in your request. *
*/ private Media media; /** ** Provides you with the Amazon S3 URI you can use to access your transcript. *
*/ private Transcript transcript; /** ** The date and time the specified transcription job began processing. *
*
* Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC
. For example,
* 2022-05-04T12:32:58.789000-07:00
represents a transcription job that started processing at 12:32 PM
* UTC-7 on May 4, 2022.
*
* The date and time the specified transcription job request was made. *
*
* Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC
. For example,
* 2022-05-04T12:32:58.761000-07:00
represents a transcription job that started processing at 12:32 PM
* UTC-7 on May 4, 2022.
*
* The date and time the specified transcription job finished processing. *
*
* Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC
. For example,
* 2022-05-04T12:33:13.922000-07:00
represents a transcription job that started processing at 12:33 PM
* UTC-7 on May 4, 2022.
*
* If TranscriptionJobStatus
is FAILED
, FailureReason
contains information
* about why the transcription job request failed.
*
* The FailureReason
field contains one of the following values:
*
* Unsupported media format
.
*
* The media format specified in MediaFormat
isn't valid. Refer to MediaFormat for a list of
* supported formats.
*
* The media format provided does not match the detected media format
.
*
* The media format specified in MediaFormat
doesn't match the format of the input file. Check the
* media format of your media file and correct the specified value.
*
* Invalid sample rate for audio file
.
*
* The sample rate specified in MediaSampleRateHertz
isn't valid. The sample rate must be between 8,000
* and 48,000 hertz.
*
* The sample rate provided does not match the detected sample rate
.
*
* The sample rate specified in MediaSampleRateHertz
doesn't match the sample rate detected in your
* input media file. Check the sample rate of your media file and correct the specified value.
*
* Invalid file size: file size too large
.
*
* The size of your media file is larger than what Amazon Transcribe can process. For more information, refer to Guidelines and quotas. *
*
* Invalid number of channels: number of channels too large
.
*
* Your audio contains more channels than Amazon Transcribe is able to process. For more information, refer to Guidelines and quotas. *
** Provides information on any additional settings that were included in your request. Additional settings include * channel identification, alternative transcriptions, speaker partitioning, custom vocabularies, and custom * vocabulary filters. *
*/ private Settings settings; /** ** Provides information on the custom language model you included in your request. *
*/ private ModelSettings modelSettings; /** ** Provides information about how your transcription job was processed. This parameter shows if your request was * queued and what data access role was used. *
*/ private JobExecutionSettings jobExecutionSettings; /** ** Indicates whether redaction was enabled in your transcript. *
*/ private ContentRedaction contentRedaction; /** *
* Indicates whether automatic language identification was enabled (TRUE
) for the specified
* transcription job.
*
* Indicates whether automatic multi-language identification was enabled (TRUE
) for the specified
* transcription job.
*
* Provides the language codes you specified in your request. *
*/ private java.util.List* The confidence score associated with the language identified in your media file. *
** Confidence scores are values between 0 and 1; a larger value indicates a higher probability that the identified * language correctly matches the language spoken in your media. *
*/ private Float identifiedLanguageScore; /** *
* The language codes used to create your transcription job. This parameter is used with multi-language
* identification. For single-language identification requests, refer to the singular version of this parameter,
* LanguageCode
.
*
* The tags, each in the form of a key:value pair, assigned to the specified transcription job. *
*/ private java.util.List* Indicates whether subtitles were generated with your transcription. *
*/ private SubtitlesOutput subtitles; /** ** Provides the name and language of all custom language models, custom vocabularies, and custom vocabulary filters * that you included in your request. *
*/ private java.util.Map* Provides information about the toxicity detection settings applied to your transcription. *
*/ private java.util.List* The name of the transcription job. Job names are case sensitive and must be unique within an Amazon Web Services * account. *
* * @param transcriptionJobName * The name of the transcription job. Job names are case sensitive and must be unique within an Amazon Web * Services account. */ public void setTranscriptionJobName(String transcriptionJobName) { this.transcriptionJobName = transcriptionJobName; } /** ** The name of the transcription job. Job names are case sensitive and must be unique within an Amazon Web Services * account. *
* * @return The name of the transcription job. Job names are case sensitive and must be unique within an Amazon Web * Services account. */ public String getTranscriptionJobName() { return this.transcriptionJobName; } /** ** The name of the transcription job. Job names are case sensitive and must be unique within an Amazon Web Services * account. *
* * @param transcriptionJobName * The name of the transcription job. Job names are case sensitive and must be unique within an Amazon Web * Services account. * @return Returns a reference to this object so that method calls can be chained together. */ public TranscriptionJob withTranscriptionJobName(String transcriptionJobName) { setTranscriptionJobName(transcriptionJobName); return this; } /** ** Provides the status of the specified transcription job. *
*
* If the status is COMPLETED
, the job is finished and you can find the results at the location
* specified in TranscriptFileUri
(or RedactedTranscriptFileUri
, if you requested
* transcript redaction). If the status is FAILED
, FailureReason
provides details on why
* your transcription job failed.
*
* If the status is COMPLETED
, the job is finished and you can find the results at the location
* specified in TranscriptFileUri
(or RedactedTranscriptFileUri
, if you requested
* transcript redaction). If the status is FAILED
, FailureReason
provides details
* on why your transcription job failed.
* @see TranscriptionJobStatus
*/
public void setTranscriptionJobStatus(String transcriptionJobStatus) {
this.transcriptionJobStatus = transcriptionJobStatus;
}
/**
*
* Provides the status of the specified transcription job. *
*
* If the status is COMPLETED
, the job is finished and you can find the results at the location
* specified in TranscriptFileUri
(or RedactedTranscriptFileUri
, if you requested
* transcript redaction). If the status is FAILED
, FailureReason
provides details on why
* your transcription job failed.
*
* If the status is COMPLETED
, the job is finished and you can find the results at the location
* specified in TranscriptFileUri
(or RedactedTranscriptFileUri
, if you requested
* transcript redaction). If the status is FAILED
, FailureReason
provides details
* on why your transcription job failed.
* @see TranscriptionJobStatus
*/
public String getTranscriptionJobStatus() {
return this.transcriptionJobStatus;
}
/**
*
* Provides the status of the specified transcription job. *
*
* If the status is COMPLETED
, the job is finished and you can find the results at the location
* specified in TranscriptFileUri
(or RedactedTranscriptFileUri
, if you requested
* transcript redaction). If the status is FAILED
, FailureReason
provides details on why
* your transcription job failed.
*
* If the status is COMPLETED
, the job is finished and you can find the results at the location
* specified in TranscriptFileUri
(or RedactedTranscriptFileUri
, if you requested
* transcript redaction). If the status is FAILED
, FailureReason
provides details
* on why your transcription job failed.
* @return Returns a reference to this object so that method calls can be chained together.
* @see TranscriptionJobStatus
*/
public TranscriptionJob withTranscriptionJobStatus(String transcriptionJobStatus) {
setTranscriptionJobStatus(transcriptionJobStatus);
return this;
}
/**
*
* Provides the status of the specified transcription job. *
*
* If the status is COMPLETED
, the job is finished and you can find the results at the location
* specified in TranscriptFileUri
(or RedactedTranscriptFileUri
, if you requested
* transcript redaction). If the status is FAILED
, FailureReason
provides details on why
* your transcription job failed.
*
* If the status is COMPLETED
, the job is finished and you can find the results at the location
* specified in TranscriptFileUri
(or RedactedTranscriptFileUri
, if you requested
* transcript redaction). If the status is FAILED
, FailureReason
provides details
* on why your transcription job failed.
* @return Returns a reference to this object so that method calls can be chained together.
* @see TranscriptionJobStatus
*/
public TranscriptionJob withTranscriptionJobStatus(TranscriptionJobStatus transcriptionJobStatus) {
this.transcriptionJobStatus = transcriptionJobStatus.toString();
return this;
}
/**
*
* The language code used to create your transcription job. This parameter is used with single-language
* identification. For multi-language identification requests, refer to the plural version of this parameter,
* LanguageCodes
.
*
LanguageCodes
.
* @see LanguageCode
*/
public void setLanguageCode(String languageCode) {
this.languageCode = languageCode;
}
/**
*
* The language code used to create your transcription job. This parameter is used with single-language
* identification. For multi-language identification requests, refer to the plural version of this parameter,
* LanguageCodes
.
*
LanguageCodes
.
* @see LanguageCode
*/
public String getLanguageCode() {
return this.languageCode;
}
/**
*
* The language code used to create your transcription job. This parameter is used with single-language
* identification. For multi-language identification requests, refer to the plural version of this parameter,
* LanguageCodes
.
*
LanguageCodes
.
* @return Returns a reference to this object so that method calls can be chained together.
* @see LanguageCode
*/
public TranscriptionJob withLanguageCode(String languageCode) {
setLanguageCode(languageCode);
return this;
}
/**
*
* The language code used to create your transcription job. This parameter is used with single-language
* identification. For multi-language identification requests, refer to the plural version of this parameter,
* LanguageCodes
.
*
LanguageCodes
.
* @return Returns a reference to this object so that method calls can be chained together.
* @see LanguageCode
*/
public TranscriptionJob withLanguageCode(LanguageCode languageCode) {
this.languageCode = languageCode.toString();
return this;
}
/**
* * The sample rate, in hertz, of the audio track in your input media file. *
* * @param mediaSampleRateHertz * The sample rate, in hertz, of the audio track in your input media file. */ public void setMediaSampleRateHertz(Integer mediaSampleRateHertz) { this.mediaSampleRateHertz = mediaSampleRateHertz; } /** ** The sample rate, in hertz, of the audio track in your input media file. *
* * @return The sample rate, in hertz, of the audio track in your input media file. */ public Integer getMediaSampleRateHertz() { return this.mediaSampleRateHertz; } /** ** The sample rate, in hertz, of the audio track in your input media file. *
* * @param mediaSampleRateHertz * The sample rate, in hertz, of the audio track in your input media file. * @return Returns a reference to this object so that method calls can be chained together. */ public TranscriptionJob withMediaSampleRateHertz(Integer mediaSampleRateHertz) { setMediaSampleRateHertz(mediaSampleRateHertz); return this; } /** ** The format of the input media file. *
* * @param mediaFormat * The format of the input media file. * @see MediaFormat */ public void setMediaFormat(String mediaFormat) { this.mediaFormat = mediaFormat; } /** ** The format of the input media file. *
* * @return The format of the input media file. * @see MediaFormat */ public String getMediaFormat() { return this.mediaFormat; } /** ** The format of the input media file. *
* * @param mediaFormat * The format of the input media file. * @return Returns a reference to this object so that method calls can be chained together. * @see MediaFormat */ public TranscriptionJob withMediaFormat(String mediaFormat) { setMediaFormat(mediaFormat); return this; } /** ** The format of the input media file. *
* * @param mediaFormat * The format of the input media file. * @return Returns a reference to this object so that method calls can be chained together. * @see MediaFormat */ public TranscriptionJob withMediaFormat(MediaFormat mediaFormat) { this.mediaFormat = mediaFormat.toString(); return this; } /** ** Provides the Amazon S3 location of the media file you used in your request. *
* * @param media * Provides the Amazon S3 location of the media file you used in your request. */ public void setMedia(Media media) { this.media = media; } /** ** Provides the Amazon S3 location of the media file you used in your request. *
* * @return Provides the Amazon S3 location of the media file you used in your request. */ public Media getMedia() { return this.media; } /** ** Provides the Amazon S3 location of the media file you used in your request. *
* * @param media * Provides the Amazon S3 location of the media file you used in your request. * @return Returns a reference to this object so that method calls can be chained together. */ public TranscriptionJob withMedia(Media media) { setMedia(media); return this; } /** ** Provides you with the Amazon S3 URI you can use to access your transcript. *
* * @param transcript * Provides you with the Amazon S3 URI you can use to access your transcript. */ public void setTranscript(Transcript transcript) { this.transcript = transcript; } /** ** Provides you with the Amazon S3 URI you can use to access your transcript. *
* * @return Provides you with the Amazon S3 URI you can use to access your transcript. */ public Transcript getTranscript() { return this.transcript; } /** ** Provides you with the Amazon S3 URI you can use to access your transcript. *
* * @param transcript * Provides you with the Amazon S3 URI you can use to access your transcript. * @return Returns a reference to this object so that method calls can be chained together. */ public TranscriptionJob withTranscript(Transcript transcript) { setTranscript(transcript); return this; } /** ** The date and time the specified transcription job began processing. *
*
* Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC
. For example,
* 2022-05-04T12:32:58.789000-07:00
represents a transcription job that started processing at 12:32 PM
* UTC-7 on May 4, 2022.
*
* Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC
. For example,
* 2022-05-04T12:32:58.789000-07:00
represents a transcription job that started processing at
* 12:32 PM UTC-7 on May 4, 2022.
*/
public void setStartTime(java.util.Date startTime) {
this.startTime = startTime;
}
/**
*
* The date and time the specified transcription job began processing. *
*
* Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC
. For example,
* 2022-05-04T12:32:58.789000-07:00
represents a transcription job that started processing at 12:32 PM
* UTC-7 on May 4, 2022.
*
* Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC
. For example,
* 2022-05-04T12:32:58.789000-07:00
represents a transcription job that started processing at
* 12:32 PM UTC-7 on May 4, 2022.
*/
public java.util.Date getStartTime() {
return this.startTime;
}
/**
*
* The date and time the specified transcription job began processing. *
*
* Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC
. For example,
* 2022-05-04T12:32:58.789000-07:00
represents a transcription job that started processing at 12:32 PM
* UTC-7 on May 4, 2022.
*
* Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC
. For example,
* 2022-05-04T12:32:58.789000-07:00
represents a transcription job that started processing at
* 12:32 PM UTC-7 on May 4, 2022.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public TranscriptionJob withStartTime(java.util.Date startTime) {
setStartTime(startTime);
return this;
}
/**
*
* The date and time the specified transcription job request was made. *
*
* Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC
. For example,
* 2022-05-04T12:32:58.761000-07:00
represents a transcription job that started processing at 12:32 PM
* UTC-7 on May 4, 2022.
*
* Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC
. For example,
* 2022-05-04T12:32:58.761000-07:00
represents a transcription job that started processing at
* 12:32 PM UTC-7 on May 4, 2022.
*/
public void setCreationTime(java.util.Date creationTime) {
this.creationTime = creationTime;
}
/**
*
* The date and time the specified transcription job request was made. *
*
* Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC
. For example,
* 2022-05-04T12:32:58.761000-07:00
represents a transcription job that started processing at 12:32 PM
* UTC-7 on May 4, 2022.
*
* Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC
. For example,
* 2022-05-04T12:32:58.761000-07:00
represents a transcription job that started processing at
* 12:32 PM UTC-7 on May 4, 2022.
*/
public java.util.Date getCreationTime() {
return this.creationTime;
}
/**
*
* The date and time the specified transcription job request was made. *
*
* Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC
. For example,
* 2022-05-04T12:32:58.761000-07:00
represents a transcription job that started processing at 12:32 PM
* UTC-7 on May 4, 2022.
*
* Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC
. For example,
* 2022-05-04T12:32:58.761000-07:00
represents a transcription job that started processing at
* 12:32 PM UTC-7 on May 4, 2022.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public TranscriptionJob withCreationTime(java.util.Date creationTime) {
setCreationTime(creationTime);
return this;
}
/**
*
* The date and time the specified transcription job finished processing. *
*
* Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC
. For example,
* 2022-05-04T12:33:13.922000-07:00
represents a transcription job that started processing at 12:33 PM
* UTC-7 on May 4, 2022.
*
* Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC
. For example,
* 2022-05-04T12:33:13.922000-07:00
represents a transcription job that started processing at
* 12:33 PM UTC-7 on May 4, 2022.
*/
public void setCompletionTime(java.util.Date completionTime) {
this.completionTime = completionTime;
}
/**
*
* The date and time the specified transcription job finished processing. *
*
* Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC
. For example,
* 2022-05-04T12:33:13.922000-07:00
represents a transcription job that started processing at 12:33 PM
* UTC-7 on May 4, 2022.
*
* Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC
. For example,
* 2022-05-04T12:33:13.922000-07:00
represents a transcription job that started processing at
* 12:33 PM UTC-7 on May 4, 2022.
*/
public java.util.Date getCompletionTime() {
return this.completionTime;
}
/**
*
* The date and time the specified transcription job finished processing. *
*
* Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC
. For example,
* 2022-05-04T12:33:13.922000-07:00
represents a transcription job that started processing at 12:33 PM
* UTC-7 on May 4, 2022.
*
* Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC
. For example,
* 2022-05-04T12:33:13.922000-07:00
represents a transcription job that started processing at
* 12:33 PM UTC-7 on May 4, 2022.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public TranscriptionJob withCompletionTime(java.util.Date completionTime) {
setCompletionTime(completionTime);
return this;
}
/**
*
* If TranscriptionJobStatus
is FAILED
, FailureReason
contains information
* about why the transcription job request failed.
*
* The FailureReason
field contains one of the following values:
*
* Unsupported media format
.
*
* The media format specified in MediaFormat
isn't valid. Refer to MediaFormat for a list of
* supported formats.
*
* The media format provided does not match the detected media format
.
*
* The media format specified in MediaFormat
doesn't match the format of the input file. Check the
* media format of your media file and correct the specified value.
*
* Invalid sample rate for audio file
.
*
* The sample rate specified in MediaSampleRateHertz
isn't valid. The sample rate must be between 8,000
* and 48,000 hertz.
*
* The sample rate provided does not match the detected sample rate
.
*
* The sample rate specified in MediaSampleRateHertz
doesn't match the sample rate detected in your
* input media file. Check the sample rate of your media file and correct the specified value.
*
* Invalid file size: file size too large
.
*
* The size of your media file is larger than what Amazon Transcribe can process. For more information, refer to Guidelines and quotas. *
*
* Invalid number of channels: number of channels too large
.
*
* Your audio contains more channels than Amazon Transcribe is able to process. For more information, refer to Guidelines and quotas. *
*TranscriptionJobStatus
is FAILED
, FailureReason
contains
* information about why the transcription job request failed.
*
* The FailureReason
field contains one of the following values:
*
* Unsupported media format
.
*
* The media format specified in MediaFormat
isn't valid. Refer to MediaFormat for a list
* of supported formats.
*
* The media format provided does not match the detected media format
.
*
* The media format specified in MediaFormat
doesn't match the format of the input file. Check
* the media format of your media file and correct the specified value.
*
* Invalid sample rate for audio file
.
*
* The sample rate specified in MediaSampleRateHertz
isn't valid. The sample rate must be
* between 8,000 and 48,000 hertz.
*
* The sample rate provided does not match the detected sample rate
.
*
* The sample rate specified in MediaSampleRateHertz
doesn't match the sample rate detected in
* your input media file. Check the sample rate of your media file and correct the specified value.
*
* Invalid file size: file size too large
.
*
* The size of your media file is larger than what Amazon Transcribe can process. For more information, refer * to Guidelines and * quotas. *
*
* Invalid number of channels: number of channels too large
.
*
* Your audio contains more channels than Amazon Transcribe is able to process. For more information, refer * to Guidelines and * quotas. *
*
* If TranscriptionJobStatus
is FAILED
, FailureReason
contains information
* about why the transcription job request failed.
*
* The FailureReason
field contains one of the following values:
*
* Unsupported media format
.
*
* The media format specified in MediaFormat
isn't valid. Refer to MediaFormat for a list of
* supported formats.
*
* The media format provided does not match the detected media format
.
*
* The media format specified in MediaFormat
doesn't match the format of the input file. Check the
* media format of your media file and correct the specified value.
*
* Invalid sample rate for audio file
.
*
* The sample rate specified in MediaSampleRateHertz
isn't valid. The sample rate must be between 8,000
* and 48,000 hertz.
*
* The sample rate provided does not match the detected sample rate
.
*
* The sample rate specified in MediaSampleRateHertz
doesn't match the sample rate detected in your
* input media file. Check the sample rate of your media file and correct the specified value.
*
* Invalid file size: file size too large
.
*
* The size of your media file is larger than what Amazon Transcribe can process. For more information, refer to Guidelines and quotas. *
*
* Invalid number of channels: number of channels too large
.
*
* Your audio contains more channels than Amazon Transcribe is able to process. For more information, refer to Guidelines and quotas. *
*TranscriptionJobStatus
is FAILED
, FailureReason
contains
* information about why the transcription job request failed.
*
* The FailureReason
field contains one of the following values:
*
* Unsupported media format
.
*
* The media format specified in MediaFormat
isn't valid. Refer to MediaFormat for a
* list of supported formats.
*
* The media format provided does not match the detected media format
.
*
* The media format specified in MediaFormat
doesn't match the format of the input file. Check
* the media format of your media file and correct the specified value.
*
* Invalid sample rate for audio file
.
*
* The sample rate specified in MediaSampleRateHertz
isn't valid. The sample rate must be
* between 8,000 and 48,000 hertz.
*
* The sample rate provided does not match the detected sample rate
.
*
* The sample rate specified in MediaSampleRateHertz
doesn't match the sample rate detected in
* your input media file. Check the sample rate of your media file and correct the specified value.
*
* Invalid file size: file size too large
.
*
* The size of your media file is larger than what Amazon Transcribe can process. For more information, * refer to Guidelines and * quotas. *
*
* Invalid number of channels: number of channels too large
.
*
* Your audio contains more channels than Amazon Transcribe is able to process. For more information, refer * to Guidelines * and quotas. *
*
* If TranscriptionJobStatus
is FAILED
, FailureReason
contains information
* about why the transcription job request failed.
*
* The FailureReason
field contains one of the following values:
*
* Unsupported media format
.
*
* The media format specified in MediaFormat
isn't valid. Refer to MediaFormat for a list of
* supported formats.
*
* The media format provided does not match the detected media format
.
*
* The media format specified in MediaFormat
doesn't match the format of the input file. Check the
* media format of your media file and correct the specified value.
*
* Invalid sample rate for audio file
.
*
* The sample rate specified in MediaSampleRateHertz
isn't valid. The sample rate must be between 8,000
* and 48,000 hertz.
*
* The sample rate provided does not match the detected sample rate
.
*
* The sample rate specified in MediaSampleRateHertz
doesn't match the sample rate detected in your
* input media file. Check the sample rate of your media file and correct the specified value.
*
* Invalid file size: file size too large
.
*
* The size of your media file is larger than what Amazon Transcribe can process. For more information, refer to Guidelines and quotas. *
*
* Invalid number of channels: number of channels too large
.
*
* Your audio contains more channels than Amazon Transcribe is able to process. For more information, refer to Guidelines and quotas. *
*TranscriptionJobStatus
is FAILED
, FailureReason
contains
* information about why the transcription job request failed.
*
* The FailureReason
field contains one of the following values:
*
* Unsupported media format
.
*
* The media format specified in MediaFormat
isn't valid. Refer to MediaFormat for a list
* of supported formats.
*
* The media format provided does not match the detected media format
.
*
* The media format specified in MediaFormat
doesn't match the format of the input file. Check
* the media format of your media file and correct the specified value.
*
* Invalid sample rate for audio file
.
*
* The sample rate specified in MediaSampleRateHertz
isn't valid. The sample rate must be
* between 8,000 and 48,000 hertz.
*
* The sample rate provided does not match the detected sample rate
.
*
* The sample rate specified in MediaSampleRateHertz
doesn't match the sample rate detected in
* your input media file. Check the sample rate of your media file and correct the specified value.
*
* Invalid file size: file size too large
.
*
* The size of your media file is larger than what Amazon Transcribe can process. For more information, refer * to Guidelines and * quotas. *
*
* Invalid number of channels: number of channels too large
.
*
* Your audio contains more channels than Amazon Transcribe is able to process. For more information, refer * to Guidelines and * quotas. *
** Provides information on any additional settings that were included in your request. Additional settings include * channel identification, alternative transcriptions, speaker partitioning, custom vocabularies, and custom * vocabulary filters. *
* * @param settings * Provides information on any additional settings that were included in your request. Additional settings * include channel identification, alternative transcriptions, speaker partitioning, custom vocabularies, and * custom vocabulary filters. */ public void setSettings(Settings settings) { this.settings = settings; } /** ** Provides information on any additional settings that were included in your request. Additional settings include * channel identification, alternative transcriptions, speaker partitioning, custom vocabularies, and custom * vocabulary filters. *
* * @return Provides information on any additional settings that were included in your request. Additional settings * include channel identification, alternative transcriptions, speaker partitioning, custom vocabularies, * and custom vocabulary filters. */ public Settings getSettings() { return this.settings; } /** ** Provides information on any additional settings that were included in your request. Additional settings include * channel identification, alternative transcriptions, speaker partitioning, custom vocabularies, and custom * vocabulary filters. *
* * @param settings * Provides information on any additional settings that were included in your request. Additional settings * include channel identification, alternative transcriptions, speaker partitioning, custom vocabularies, and * custom vocabulary filters. * @return Returns a reference to this object so that method calls can be chained together. */ public TranscriptionJob withSettings(Settings settings) { setSettings(settings); return this; } /** ** Provides information on the custom language model you included in your request. *
* * @param modelSettings * Provides information on the custom language model you included in your request. */ public void setModelSettings(ModelSettings modelSettings) { this.modelSettings = modelSettings; } /** ** Provides information on the custom language model you included in your request. *
* * @return Provides information on the custom language model you included in your request. */ public ModelSettings getModelSettings() { return this.modelSettings; } /** ** Provides information on the custom language model you included in your request. *
* * @param modelSettings * Provides information on the custom language model you included in your request. * @return Returns a reference to this object so that method calls can be chained together. */ public TranscriptionJob withModelSettings(ModelSettings modelSettings) { setModelSettings(modelSettings); return this; } /** ** Provides information about how your transcription job was processed. This parameter shows if your request was * queued and what data access role was used. *
* * @param jobExecutionSettings * Provides information about how your transcription job was processed. This parameter shows if your request * was queued and what data access role was used. */ public void setJobExecutionSettings(JobExecutionSettings jobExecutionSettings) { this.jobExecutionSettings = jobExecutionSettings; } /** ** Provides information about how your transcription job was processed. This parameter shows if your request was * queued and what data access role was used. *
* * @return Provides information about how your transcription job was processed. This parameter shows if your request * was queued and what data access role was used. */ public JobExecutionSettings getJobExecutionSettings() { return this.jobExecutionSettings; } /** ** Provides information about how your transcription job was processed. This parameter shows if your request was * queued and what data access role was used. *
* * @param jobExecutionSettings * Provides information about how your transcription job was processed. This parameter shows if your request * was queued and what data access role was used. * @return Returns a reference to this object so that method calls can be chained together. */ public TranscriptionJob withJobExecutionSettings(JobExecutionSettings jobExecutionSettings) { setJobExecutionSettings(jobExecutionSettings); return this; } /** ** Indicates whether redaction was enabled in your transcript. *
* * @param contentRedaction * Indicates whether redaction was enabled in your transcript. */ public void setContentRedaction(ContentRedaction contentRedaction) { this.contentRedaction = contentRedaction; } /** ** Indicates whether redaction was enabled in your transcript. *
* * @return Indicates whether redaction was enabled in your transcript. */ public ContentRedaction getContentRedaction() { return this.contentRedaction; } /** ** Indicates whether redaction was enabled in your transcript. *
* * @param contentRedaction * Indicates whether redaction was enabled in your transcript. * @return Returns a reference to this object so that method calls can be chained together. */ public TranscriptionJob withContentRedaction(ContentRedaction contentRedaction) { setContentRedaction(contentRedaction); return this; } /** *
* Indicates whether automatic language identification was enabled (TRUE
) for the specified
* transcription job.
*
TRUE
) for the specified
* transcription job.
*/
public void setIdentifyLanguage(Boolean identifyLanguage) {
this.identifyLanguage = identifyLanguage;
}
/**
*
* Indicates whether automatic language identification was enabled (TRUE
) for the specified
* transcription job.
*
TRUE
) for the specified
* transcription job.
*/
public Boolean getIdentifyLanguage() {
return this.identifyLanguage;
}
/**
*
* Indicates whether automatic language identification was enabled (TRUE
) for the specified
* transcription job.
*
TRUE
) for the specified
* transcription job.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public TranscriptionJob withIdentifyLanguage(Boolean identifyLanguage) {
setIdentifyLanguage(identifyLanguage);
return this;
}
/**
*
* Indicates whether automatic language identification was enabled (TRUE
) for the specified
* transcription job.
*
TRUE
) for the specified
* transcription job.
*/
public Boolean isIdentifyLanguage() {
return this.identifyLanguage;
}
/**
*
* Indicates whether automatic multi-language identification was enabled (TRUE
) for the specified
* transcription job.
*
TRUE
) for the
* specified transcription job.
*/
public void setIdentifyMultipleLanguages(Boolean identifyMultipleLanguages) {
this.identifyMultipleLanguages = identifyMultipleLanguages;
}
/**
*
* Indicates whether automatic multi-language identification was enabled (TRUE
) for the specified
* transcription job.
*
TRUE
) for the
* specified transcription job.
*/
public Boolean getIdentifyMultipleLanguages() {
return this.identifyMultipleLanguages;
}
/**
*
* Indicates whether automatic multi-language identification was enabled (TRUE
) for the specified
* transcription job.
*
TRUE
) for the
* specified transcription job.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public TranscriptionJob withIdentifyMultipleLanguages(Boolean identifyMultipleLanguages) {
setIdentifyMultipleLanguages(identifyMultipleLanguages);
return this;
}
/**
*
* Indicates whether automatic multi-language identification was enabled (TRUE
) for the specified
* transcription job.
*
TRUE
) for the
* specified transcription job.
*/
public Boolean isIdentifyMultipleLanguages() {
return this.identifyMultipleLanguages;
}
/**
* * Provides the language codes you specified in your request. *
* * @return Provides the language codes you specified in your request. * @see LanguageCode */ public java.util.List* Provides the language codes you specified in your request. *
* * @param languageOptions * Provides the language codes you specified in your request. * @see LanguageCode */ public void setLanguageOptions(java.util.Collection* Provides the language codes you specified in your request. *
** NOTE: This method appends the values to the existing list (if any). Use * {@link #setLanguageOptions(java.util.Collection)} or {@link #withLanguageOptions(java.util.Collection)} if you * want to override the existing values. *
* * @param languageOptions * Provides the language codes you specified in your request. * @return Returns a reference to this object so that method calls can be chained together. * @see LanguageCode */ public TranscriptionJob withLanguageOptions(String... languageOptions) { if (this.languageOptions == null) { setLanguageOptions(new java.util.ArrayList* Provides the language codes you specified in your request. *
* * @param languageOptions * Provides the language codes you specified in your request. * @return Returns a reference to this object so that method calls can be chained together. * @see LanguageCode */ public TranscriptionJob withLanguageOptions(java.util.Collection* Provides the language codes you specified in your request. *
* * @param languageOptions * Provides the language codes you specified in your request. * @return Returns a reference to this object so that method calls can be chained together. * @see LanguageCode */ public TranscriptionJob withLanguageOptions(LanguageCode... languageOptions) { java.util.ArrayList* The confidence score associated with the language identified in your media file. *
** Confidence scores are values between 0 and 1; a larger value indicates a higher probability that the identified * language correctly matches the language spoken in your media. *
* * @param identifiedLanguageScore * The confidence score associated with the language identified in your media file. ** Confidence scores are values between 0 and 1; a larger value indicates a higher probability that the * identified language correctly matches the language spoken in your media. */ public void setIdentifiedLanguageScore(Float identifiedLanguageScore) { this.identifiedLanguageScore = identifiedLanguageScore; } /** *
* The confidence score associated with the language identified in your media file. *
** Confidence scores are values between 0 and 1; a larger value indicates a higher probability that the identified * language correctly matches the language spoken in your media. *
* * @return The confidence score associated with the language identified in your media file. ** Confidence scores are values between 0 and 1; a larger value indicates a higher probability that the * identified language correctly matches the language spoken in your media. */ public Float getIdentifiedLanguageScore() { return this.identifiedLanguageScore; } /** *
* The confidence score associated with the language identified in your media file. *
** Confidence scores are values between 0 and 1; a larger value indicates a higher probability that the identified * language correctly matches the language spoken in your media. *
* * @param identifiedLanguageScore * The confidence score associated with the language identified in your media file. ** Confidence scores are values between 0 and 1; a larger value indicates a higher probability that the * identified language correctly matches the language spoken in your media. * @return Returns a reference to this object so that method calls can be chained together. */ public TranscriptionJob withIdentifiedLanguageScore(Float identifiedLanguageScore) { setIdentifiedLanguageScore(identifiedLanguageScore); return this; } /** *
* The language codes used to create your transcription job. This parameter is used with multi-language
* identification. For single-language identification requests, refer to the singular version of this parameter,
* LanguageCode
.
*
LanguageCode
.
*/
public java.util.List
* The language codes used to create your transcription job. This parameter is used with multi-language
* identification. For single-language identification requests, refer to the singular version of this parameter,
* LanguageCode
.
*
LanguageCode
.
*/
public void setLanguageCodes(java.util.Collection
* The language codes used to create your transcription job. This parameter is used with multi-language
* identification. For single-language identification requests, refer to the singular version of this parameter,
* LanguageCode
.
*
* NOTE: This method appends the values to the existing list (if any). Use * {@link #setLanguageCodes(java.util.Collection)} or {@link #withLanguageCodes(java.util.Collection)} if you want * to override the existing values. *
* * @param languageCodes * The language codes used to create your transcription job. This parameter is used with multi-language * identification. For single-language identification requests, refer to the singular version of this * parameter,LanguageCode
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public TranscriptionJob withLanguageCodes(LanguageCodeItem... languageCodes) {
if (this.languageCodes == null) {
setLanguageCodes(new java.util.ArrayList
* The language codes used to create your transcription job. This parameter is used with multi-language
* identification. For single-language identification requests, refer to the singular version of this parameter,
* LanguageCode
.
*
LanguageCode
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public TranscriptionJob withLanguageCodes(java.util.Collection* The tags, each in the form of a key:value pair, assigned to the specified transcription job. *
* * @return The tags, each in the form of a key:value pair, assigned to the specified transcription job. */ public java.util.List* The tags, each in the form of a key:value pair, assigned to the specified transcription job. *
* * @param tags * The tags, each in the form of a key:value pair, assigned to the specified transcription job. */ public void setTags(java.util.Collection* The tags, each in the form of a key:value pair, assigned to the specified transcription job. *
** NOTE: This method appends the values to the existing list (if any). Use * {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the * existing values. *
* * @param tags * The tags, each in the form of a key:value pair, assigned to the specified transcription job. * @return Returns a reference to this object so that method calls can be chained together. */ public TranscriptionJob withTags(Tag... tags) { if (this.tags == null) { setTags(new java.util.ArrayList* The tags, each in the form of a key:value pair, assigned to the specified transcription job. *
* * @param tags * The tags, each in the form of a key:value pair, assigned to the specified transcription job. * @return Returns a reference to this object so that method calls can be chained together. */ public TranscriptionJob withTags(java.util.Collection* Indicates whether subtitles were generated with your transcription. *
* * @param subtitles * Indicates whether subtitles were generated with your transcription. */ public void setSubtitles(SubtitlesOutput subtitles) { this.subtitles = subtitles; } /** ** Indicates whether subtitles were generated with your transcription. *
* * @return Indicates whether subtitles were generated with your transcription. */ public SubtitlesOutput getSubtitles() { return this.subtitles; } /** ** Indicates whether subtitles were generated with your transcription. *
* * @param subtitles * Indicates whether subtitles were generated with your transcription. * @return Returns a reference to this object so that method calls can be chained together. */ public TranscriptionJob withSubtitles(SubtitlesOutput subtitles) { setSubtitles(subtitles); return this; } /** ** Provides the name and language of all custom language models, custom vocabularies, and custom vocabulary filters * that you included in your request. *
* * @return Provides the name and language of all custom language models, custom vocabularies, and custom vocabulary * filters that you included in your request. */ public java.util.Map* Provides the name and language of all custom language models, custom vocabularies, and custom vocabulary filters * that you included in your request. *
* * @param languageIdSettings * Provides the name and language of all custom language models, custom vocabularies, and custom vocabulary * filters that you included in your request. */ public void setLanguageIdSettings(java.util.Map* Provides the name and language of all custom language models, custom vocabularies, and custom vocabulary filters * that you included in your request. *
* * @param languageIdSettings * Provides the name and language of all custom language models, custom vocabularies, and custom vocabulary * filters that you included in your request. * @return Returns a reference to this object so that method calls can be chained together. */ public TranscriptionJob withLanguageIdSettings(java.util.Map* Provides information about the toxicity detection settings applied to your transcription. *
* * @return Provides information about the toxicity detection settings applied to your transcription. */ public java.util.List* Provides information about the toxicity detection settings applied to your transcription. *
* * @param toxicityDetection * Provides information about the toxicity detection settings applied to your transcription. */ public void setToxicityDetection(java.util.Collection* Provides information about the toxicity detection settings applied to your transcription. *
** NOTE: This method appends the values to the existing list (if any). Use * {@link #setToxicityDetection(java.util.Collection)} or {@link #withToxicityDetection(java.util.Collection)} if * you want to override the existing values. *
* * @param toxicityDetection * Provides information about the toxicity detection settings applied to your transcription. * @return Returns a reference to this object so that method calls can be chained together. */ public TranscriptionJob withToxicityDetection(ToxicityDetectionSettings... toxicityDetection) { if (this.toxicityDetection == null) { setToxicityDetection(new java.util.ArrayList* Provides information about the toxicity detection settings applied to your transcription. *
* * @param toxicityDetection * Provides information about the toxicity detection settings applied to your transcription. * @return Returns a reference to this object so that method calls can be chained together. */ public TranscriptionJob withToxicityDetection(java.util.Collection