com.amazonaws.services.transcribe.model.TranscriptionJob Maven / Gradle / Ivy
Show all versions of aws-java-sdk-transcribe Show documentation
/*
* Copyright 2019-2024 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.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class TranscriptionJob implements Serializable, Cloneable, StructuredPojo {
/**
*
* 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.
*
*/
private String transcriptionJobStatus;
/**
*
* 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.
*
*/
private String languageCode;
/**
*
* 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.
*
*/
private java.util.Date startTime;
/**
*
* 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.
*
*/
private java.util.Date creationTime;
/**
*
* 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.
*
*/
private java.util.Date completionTime;
/**
*
* 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 refer to the
* MediaFormat parameter 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 Service 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 Service quotas.
*
*
*
*/
private String failureReason;
/**
*
* 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.
*
*/
private Boolean identifyLanguage;
/**
*
* Indicates whether automatic multi-language identification was enabled (TRUE) for the specified
* transcription job.
*
*/
private Boolean identifyMultipleLanguages;
/**
*
* Provides the language codes you specified in your request.
*
*/
private java.util.List languageOptions;
/**
*
* 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.
*
*/
private java.util.List languageCodes;
/**
*
* The tags, each in the form of a key:value pair, assigned to the specified transcription job.
*
*/
private java.util.List tags;
/**
*
* 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 languageIdSettings;
/**
*
* Provides information about the toxicity detection settings applied to your transcription.
*
*/
private java.util.List toxicityDetection;
/**
*
* 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.
*
*
* @param 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.
* @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.
*
*
* @return 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.
* @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.
*
*
* @param 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.
* @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.
*
*
* @param 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.
* @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.
*
*
* @param 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.
* @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.
*
*
* @return 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.
* @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.
*
*
* @param 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.
* @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.
*
*
* @param 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.
* @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.
*
*
* @param 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.
*/
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.
*
*
* @return 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.
*/
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.
*
*
* @param 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.
* @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.
*
*
* @param 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.
*/
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.
*
*
* @return 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.
*/
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.
*
*
* @param 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.
* @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.
*
*
* @param 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.
*/
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.
*
*
* @return 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.
*/
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.
*
*
* @param 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.
* @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 refer to the
* MediaFormat parameter 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 Service 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 Service quotas.
*
*
*
*
* @param failureReason
* 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 refer to the
* MediaFormat parameter 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 Service
* 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 Service
* quotas.
*
*
*/
public void setFailureReason(String failureReason) {
this.failureReason = failureReason;
}
/**
*
* 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 refer to the
* MediaFormat parameter 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 Service 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 Service quotas.
*
*
*
*
* @return 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 refer to the
* MediaFormat parameter 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 Service
* 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 Service
* quotas.
*
*
*/
public String getFailureReason() {
return this.failureReason;
}
/**
*
* 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 refer to the
* MediaFormat parameter 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 Service 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 Service quotas.
*
*
*
*
* @param failureReason
* 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 refer to the
* MediaFormat parameter 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 Service
* 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 Service
* quotas.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public TranscriptionJob withFailureReason(String failureReason) {
setFailureReason(failureReason);
return this;
}
/**
*
* 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.
*
*
* @param identifyLanguage
* Indicates whether automatic language identification was enabled (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.
*
*
* @return Indicates whether automatic language identification was enabled (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.
*
*
* @param identifyLanguage
* Indicates whether automatic language identification was enabled (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.
*
*
* @return Indicates whether automatic language identification was enabled (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.
*
*
* @param identifyMultipleLanguages
* Indicates whether automatic multi-language identification was enabled (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.
*
*
* @return Indicates whether automatic multi-language identification was enabled (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.
*
*
* @param identifyMultipleLanguages
* Indicates whether automatic multi-language identification was enabled (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.
*
*
* @return Indicates whether automatic multi-language identification was enabled (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 getLanguageOptions() {
return languageOptions;
}
/**
*
* 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 languageOptions) {
if (languageOptions == null) {
this.languageOptions = null;
return;
}
this.languageOptions = new java.util.ArrayList(languageOptions);
}
/**
*
* 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(languageOptions.length));
}
for (String ele : languageOptions) {
this.languageOptions.add(ele);
}
return this;
}
/**
*
* 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 languageOptions) {
setLanguageOptions(languageOptions);
return this;
}
/**
*
* 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 languageOptionsCopy = new java.util.ArrayList(languageOptions.length);
for (LanguageCode value : languageOptions) {
languageOptionsCopy.add(value.toString());
}
if (getLanguageOptions() == null) {
setLanguageOptions(languageOptionsCopy);
} else {
getLanguageOptions().addAll(languageOptionsCopy);
}
return this;
}
/**
*
* 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.
*
*
* @return 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.
*/
public java.util.List getLanguageCodes() {
return 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.
*
*
* @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.
*/
public void setLanguageCodes(java.util.Collection languageCodes) {
if (languageCodes == null) {
this.languageCodes = null;
return;
}
this.languageCodes = new java.util.ArrayList(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.
*
*
* 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(languageCodes.length));
}
for (LanguageCodeItem ele : languageCodes) {
this.languageCodes.add(ele);
}
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.
*
*
* @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(java.util.Collection languageCodes) {
setLanguageCodes(languageCodes);
return this;
}
/**
*
* 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 getTags() {
return tags;
}
/**
*
* 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 tags) {
if (tags == null) {
this.tags = null;
return;
}
this.tags = new java.util.ArrayList(tags);
}
/**
*
* 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(tags.length));
}
for (Tag ele : tags) {
this.tags.add(ele);
}
return this;
}
/**
*
* 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 tags) {
setTags(tags);
return this;
}
/**
*
* 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 getLanguageIdSettings() {
return languageIdSettings;
}
/**
*
* 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 languageIdSettings) {
this.languageIdSettings = languageIdSettings;
}
/**
*
* 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 languageIdSettings) {
setLanguageIdSettings(languageIdSettings);
return this;
}
/**
* Add a single LanguageIdSettings entry
*
* @see TranscriptionJob#withLanguageIdSettings
* @returns a reference to this object so that method calls can be chained together.
*/
public TranscriptionJob addLanguageIdSettingsEntry(String key, LanguageIdSettings value) {
if (null == this.languageIdSettings) {
this.languageIdSettings = new java.util.HashMap();
}
if (this.languageIdSettings.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
this.languageIdSettings.put(key, value);
return this;
}
/**
* Removes all the entries added into LanguageIdSettings.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public TranscriptionJob clearLanguageIdSettingsEntries() {
this.languageIdSettings = null;
return this;
}
/**
*
* 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 getToxicityDetection() {
return toxicityDetection;
}
/**
*
* 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 toxicityDetection) {
if (toxicityDetection == null) {
this.toxicityDetection = null;
return;
}
this.toxicityDetection = new java.util.ArrayList(toxicityDetection);
}
/**
*
* 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(toxicityDetection.length));
}
for (ToxicityDetectionSettings ele : toxicityDetection) {
this.toxicityDetection.add(ele);
}
return this;
}
/**
*
* 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 toxicityDetection) {
setToxicityDetection(toxicityDetection);
return this;
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getTranscriptionJobName() != null)
sb.append("TranscriptionJobName: ").append(getTranscriptionJobName()).append(",");
if (getTranscriptionJobStatus() != null)
sb.append("TranscriptionJobStatus: ").append(getTranscriptionJobStatus()).append(",");
if (getLanguageCode() != null)
sb.append("LanguageCode: ").append(getLanguageCode()).append(",");
if (getMediaSampleRateHertz() != null)
sb.append("MediaSampleRateHertz: ").append(getMediaSampleRateHertz()).append(",");
if (getMediaFormat() != null)
sb.append("MediaFormat: ").append(getMediaFormat()).append(",");
if (getMedia() != null)
sb.append("Media: ").append(getMedia()).append(",");
if (getTranscript() != null)
sb.append("Transcript: ").append(getTranscript()).append(",");
if (getStartTime() != null)
sb.append("StartTime: ").append(getStartTime()).append(",");
if (getCreationTime() != null)
sb.append("CreationTime: ").append(getCreationTime()).append(",");
if (getCompletionTime() != null)
sb.append("CompletionTime: ").append(getCompletionTime()).append(",");
if (getFailureReason() != null)
sb.append("FailureReason: ").append(getFailureReason()).append(",");
if (getSettings() != null)
sb.append("Settings: ").append(getSettings()).append(",");
if (getModelSettings() != null)
sb.append("ModelSettings: ").append(getModelSettings()).append(",");
if (getJobExecutionSettings() != null)
sb.append("JobExecutionSettings: ").append(getJobExecutionSettings()).append(",");
if (getContentRedaction() != null)
sb.append("ContentRedaction: ").append(getContentRedaction()).append(",");
if (getIdentifyLanguage() != null)
sb.append("IdentifyLanguage: ").append(getIdentifyLanguage()).append(",");
if (getIdentifyMultipleLanguages() != null)
sb.append("IdentifyMultipleLanguages: ").append(getIdentifyMultipleLanguages()).append(",");
if (getLanguageOptions() != null)
sb.append("LanguageOptions: ").append(getLanguageOptions()).append(",");
if (getIdentifiedLanguageScore() != null)
sb.append("IdentifiedLanguageScore: ").append(getIdentifiedLanguageScore()).append(",");
if (getLanguageCodes() != null)
sb.append("LanguageCodes: ").append(getLanguageCodes()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags()).append(",");
if (getSubtitles() != null)
sb.append("Subtitles: ").append(getSubtitles()).append(",");
if (getLanguageIdSettings() != null)
sb.append("LanguageIdSettings: ").append(getLanguageIdSettings()).append(",");
if (getToxicityDetection() != null)
sb.append("ToxicityDetection: ").append(getToxicityDetection());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof TranscriptionJob == false)
return false;
TranscriptionJob other = (TranscriptionJob) obj;
if (other.getTranscriptionJobName() == null ^ this.getTranscriptionJobName() == null)
return false;
if (other.getTranscriptionJobName() != null && other.getTranscriptionJobName().equals(this.getTranscriptionJobName()) == false)
return false;
if (other.getTranscriptionJobStatus() == null ^ this.getTranscriptionJobStatus() == null)
return false;
if (other.getTranscriptionJobStatus() != null && other.getTranscriptionJobStatus().equals(this.getTranscriptionJobStatus()) == false)
return false;
if (other.getLanguageCode() == null ^ this.getLanguageCode() == null)
return false;
if (other.getLanguageCode() != null && other.getLanguageCode().equals(this.getLanguageCode()) == false)
return false;
if (other.getMediaSampleRateHertz() == null ^ this.getMediaSampleRateHertz() == null)
return false;
if (other.getMediaSampleRateHertz() != null && other.getMediaSampleRateHertz().equals(this.getMediaSampleRateHertz()) == false)
return false;
if (other.getMediaFormat() == null ^ this.getMediaFormat() == null)
return false;
if (other.getMediaFormat() != null && other.getMediaFormat().equals(this.getMediaFormat()) == false)
return false;
if (other.getMedia() == null ^ this.getMedia() == null)
return false;
if (other.getMedia() != null && other.getMedia().equals(this.getMedia()) == false)
return false;
if (other.getTranscript() == null ^ this.getTranscript() == null)
return false;
if (other.getTranscript() != null && other.getTranscript().equals(this.getTranscript()) == false)
return false;
if (other.getStartTime() == null ^ this.getStartTime() == null)
return false;
if (other.getStartTime() != null && other.getStartTime().equals(this.getStartTime()) == false)
return false;
if (other.getCreationTime() == null ^ this.getCreationTime() == null)
return false;
if (other.getCreationTime() != null && other.getCreationTime().equals(this.getCreationTime()) == false)
return false;
if (other.getCompletionTime() == null ^ this.getCompletionTime() == null)
return false;
if (other.getCompletionTime() != null && other.getCompletionTime().equals(this.getCompletionTime()) == false)
return false;
if (other.getFailureReason() == null ^ this.getFailureReason() == null)
return false;
if (other.getFailureReason() != null && other.getFailureReason().equals(this.getFailureReason()) == false)
return false;
if (other.getSettings() == null ^ this.getSettings() == null)
return false;
if (other.getSettings() != null && other.getSettings().equals(this.getSettings()) == false)
return false;
if (other.getModelSettings() == null ^ this.getModelSettings() == null)
return false;
if (other.getModelSettings() != null && other.getModelSettings().equals(this.getModelSettings()) == false)
return false;
if (other.getJobExecutionSettings() == null ^ this.getJobExecutionSettings() == null)
return false;
if (other.getJobExecutionSettings() != null && other.getJobExecutionSettings().equals(this.getJobExecutionSettings()) == false)
return false;
if (other.getContentRedaction() == null ^ this.getContentRedaction() == null)
return false;
if (other.getContentRedaction() != null && other.getContentRedaction().equals(this.getContentRedaction()) == false)
return false;
if (other.getIdentifyLanguage() == null ^ this.getIdentifyLanguage() == null)
return false;
if (other.getIdentifyLanguage() != null && other.getIdentifyLanguage().equals(this.getIdentifyLanguage()) == false)
return false;
if (other.getIdentifyMultipleLanguages() == null ^ this.getIdentifyMultipleLanguages() == null)
return false;
if (other.getIdentifyMultipleLanguages() != null && other.getIdentifyMultipleLanguages().equals(this.getIdentifyMultipleLanguages()) == false)
return false;
if (other.getLanguageOptions() == null ^ this.getLanguageOptions() == null)
return false;
if (other.getLanguageOptions() != null && other.getLanguageOptions().equals(this.getLanguageOptions()) == false)
return false;
if (other.getIdentifiedLanguageScore() == null ^ this.getIdentifiedLanguageScore() == null)
return false;
if (other.getIdentifiedLanguageScore() != null && other.getIdentifiedLanguageScore().equals(this.getIdentifiedLanguageScore()) == false)
return false;
if (other.getLanguageCodes() == null ^ this.getLanguageCodes() == null)
return false;
if (other.getLanguageCodes() != null && other.getLanguageCodes().equals(this.getLanguageCodes()) == false)
return false;
if (other.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == false)
return false;
if (other.getSubtitles() == null ^ this.getSubtitles() == null)
return false;
if (other.getSubtitles() != null && other.getSubtitles().equals(this.getSubtitles()) == false)
return false;
if (other.getLanguageIdSettings() == null ^ this.getLanguageIdSettings() == null)
return false;
if (other.getLanguageIdSettings() != null && other.getLanguageIdSettings().equals(this.getLanguageIdSettings()) == false)
return false;
if (other.getToxicityDetection() == null ^ this.getToxicityDetection() == null)
return false;
if (other.getToxicityDetection() != null && other.getToxicityDetection().equals(this.getToxicityDetection()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getTranscriptionJobName() == null) ? 0 : getTranscriptionJobName().hashCode());
hashCode = prime * hashCode + ((getTranscriptionJobStatus() == null) ? 0 : getTranscriptionJobStatus().hashCode());
hashCode = prime * hashCode + ((getLanguageCode() == null) ? 0 : getLanguageCode().hashCode());
hashCode = prime * hashCode + ((getMediaSampleRateHertz() == null) ? 0 : getMediaSampleRateHertz().hashCode());
hashCode = prime * hashCode + ((getMediaFormat() == null) ? 0 : getMediaFormat().hashCode());
hashCode = prime * hashCode + ((getMedia() == null) ? 0 : getMedia().hashCode());
hashCode = prime * hashCode + ((getTranscript() == null) ? 0 : getTranscript().hashCode());
hashCode = prime * hashCode + ((getStartTime() == null) ? 0 : getStartTime().hashCode());
hashCode = prime * hashCode + ((getCreationTime() == null) ? 0 : getCreationTime().hashCode());
hashCode = prime * hashCode + ((getCompletionTime() == null) ? 0 : getCompletionTime().hashCode());
hashCode = prime * hashCode + ((getFailureReason() == null) ? 0 : getFailureReason().hashCode());
hashCode = prime * hashCode + ((getSettings() == null) ? 0 : getSettings().hashCode());
hashCode = prime * hashCode + ((getModelSettings() == null) ? 0 : getModelSettings().hashCode());
hashCode = prime * hashCode + ((getJobExecutionSettings() == null) ? 0 : getJobExecutionSettings().hashCode());
hashCode = prime * hashCode + ((getContentRedaction() == null) ? 0 : getContentRedaction().hashCode());
hashCode = prime * hashCode + ((getIdentifyLanguage() == null) ? 0 : getIdentifyLanguage().hashCode());
hashCode = prime * hashCode + ((getIdentifyMultipleLanguages() == null) ? 0 : getIdentifyMultipleLanguages().hashCode());
hashCode = prime * hashCode + ((getLanguageOptions() == null) ? 0 : getLanguageOptions().hashCode());
hashCode = prime * hashCode + ((getIdentifiedLanguageScore() == null) ? 0 : getIdentifiedLanguageScore().hashCode());
hashCode = prime * hashCode + ((getLanguageCodes() == null) ? 0 : getLanguageCodes().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
hashCode = prime * hashCode + ((getSubtitles() == null) ? 0 : getSubtitles().hashCode());
hashCode = prime * hashCode + ((getLanguageIdSettings() == null) ? 0 : getLanguageIdSettings().hashCode());
hashCode = prime * hashCode + ((getToxicityDetection() == null) ? 0 : getToxicityDetection().hashCode());
return hashCode;
}
@Override
public TranscriptionJob clone() {
try {
return (TranscriptionJob) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.transcribe.model.transform.TranscriptionJobMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}