/* * 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 Call Analytics job. *

*

* To view the job's status, refer to CallAnalyticsJobStatus. If the status is COMPLETED, the * job is finished. You can find your completed transcript at the URI specified in TranscriptFileUri. If * the status is FAILED, FailureReason provides details on why your transcription job failed. *

*

* If you enabled personally identifiable information (PII) redaction, the redacted transcript appears at the location * specified in RedactedTranscriptFileUri. *

*

* If you chose to redact the audio in your media file, you can find your redacted media file at the location specified * in the RedactedMediaFileUri field of your response. *

* * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class CallAnalyticsJob implements Serializable, Cloneable, StructuredPojo { /** *

* The name of the Call Analytics job. Job names are case sensitive and must be unique within an Amazon Web Services * account. *

*/ private String callAnalyticsJobName; /** *

* Provides the status of the specified Call Analytics 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 callAnalyticsJobStatus; /** *

* The language code used to create your Call Analytics job. For a list of supported languages and their associated * language codes, refer to the Supported languages table. *

*

* If you don't know the language spoken in your media file, you can omit this field and let Amazon Transcribe * automatically identify the language of your media. To improve the accuracy of language identification, you can * include several language codes and Amazon Transcribe chooses the closest match for your transcription. *

*/ 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 Call Analytics request. *

*/ private Media media; private Transcript transcript; /** *

* The date and time the specified Call Analytics 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 Call Analytics 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 Call Analytics 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 CallAnalyticsJobStatus is FAILED, FailureReason contains information * about why the Call Analytics job request failed. *

*

* The FailureReason field contains one of the following values: *

* */ private String failureReason; /** *

* The Amazon Resource Name (ARN) you included in your request. *

*/ private String dataAccessRoleArn; /** *

* 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; /** *

* Provides information on any additional settings that were included in your request. Additional settings include * content redaction and language identification settings. *

*/ private CallAnalyticsJobSettings settings; /** *

* Indicates which speaker is on which channel. *

*/ private java.util.List channelDefinitions; /** *

* The name of the Call Analytics job. Job names are case sensitive and must be unique within an Amazon Web Services * account. *

* * @param callAnalyticsJobName * The name of the Call Analytics job. Job names are case sensitive and must be unique within an Amazon Web * Services account. */ public void setCallAnalyticsJobName(String callAnalyticsJobName) { this.callAnalyticsJobName = callAnalyticsJobName; } /** *

* The name of the Call Analytics job. Job names are case sensitive and must be unique within an Amazon Web Services * account. *

* * @return The name of the Call Analytics job. Job names are case sensitive and must be unique within an Amazon Web * Services account. */ public String getCallAnalyticsJobName() { return this.callAnalyticsJobName; } /** *

* The name of the Call Analytics job. Job names are case sensitive and must be unique within an Amazon Web Services * account. *

* * @param callAnalyticsJobName * The name of the Call Analytics 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 CallAnalyticsJob withCallAnalyticsJobName(String callAnalyticsJobName) { setCallAnalyticsJobName(callAnalyticsJobName); return this; } /** *

* Provides the status of the specified Call Analytics 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 callAnalyticsJobStatus * Provides the status of the specified Call Analytics 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 CallAnalyticsJobStatus */ public void setCallAnalyticsJobStatus(String callAnalyticsJobStatus) { this.callAnalyticsJobStatus = callAnalyticsJobStatus; } /** *

* Provides the status of the specified Call Analytics 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 Call Analytics 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 CallAnalyticsJobStatus */ public String getCallAnalyticsJobStatus() { return this.callAnalyticsJobStatus; } /** *

* Provides the status of the specified Call Analytics 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 callAnalyticsJobStatus * Provides the status of the specified Call Analytics 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 CallAnalyticsJobStatus */ public CallAnalyticsJob withCallAnalyticsJobStatus(String callAnalyticsJobStatus) { setCallAnalyticsJobStatus(callAnalyticsJobStatus); return this; } /** *

* Provides the status of the specified Call Analytics 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 callAnalyticsJobStatus * Provides the status of the specified Call Analytics 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 CallAnalyticsJobStatus */ public CallAnalyticsJob withCallAnalyticsJobStatus(CallAnalyticsJobStatus callAnalyticsJobStatus) { this.callAnalyticsJobStatus = callAnalyticsJobStatus.toString(); return this; } /** *

* The language code used to create your Call Analytics job. For a list of supported languages and their associated * language codes, refer to the Supported languages table. *

*

* If you don't know the language spoken in your media file, you can omit this field and let Amazon Transcribe * automatically identify the language of your media. To improve the accuracy of language identification, you can * include several language codes and Amazon Transcribe chooses the closest match for your transcription. *

* * @param languageCode * The language code used to create your Call Analytics job. For a list of supported languages and their * associated language codes, refer to the Supported languages * table.

*

* If you don't know the language spoken in your media file, you can omit this field and let Amazon * Transcribe automatically identify the language of your media. To improve the accuracy of language * identification, you can include several language codes and Amazon Transcribe chooses the closest match for * your transcription. * @see LanguageCode */ public void setLanguageCode(String languageCode) { this.languageCode = languageCode; } /** *

* The language code used to create your Call Analytics job. For a list of supported languages and their associated * language codes, refer to the Supported languages table. *

*

* If you don't know the language spoken in your media file, you can omit this field and let Amazon Transcribe * automatically identify the language of your media. To improve the accuracy of language identification, you can * include several language codes and Amazon Transcribe chooses the closest match for your transcription. *

* * @return The language code used to create your Call Analytics job. For a list of supported languages and their * associated language codes, refer to the Supported languages * table.

*

* If you don't know the language spoken in your media file, you can omit this field and let Amazon * Transcribe automatically identify the language of your media. To improve the accuracy of language * identification, you can include several language codes and Amazon Transcribe chooses the closest match * for your transcription. * @see LanguageCode */ public String getLanguageCode() { return this.languageCode; } /** *

* The language code used to create your Call Analytics job. For a list of supported languages and their associated * language codes, refer to the Supported languages table. *

*

* If you don't know the language spoken in your media file, you can omit this field and let Amazon Transcribe * automatically identify the language of your media. To improve the accuracy of language identification, you can * include several language codes and Amazon Transcribe chooses the closest match for your transcription. *

* * @param languageCode * The language code used to create your Call Analytics job. For a list of supported languages and their * associated language codes, refer to the Supported languages * table.

*

* If you don't know the language spoken in your media file, you can omit this field and let Amazon * Transcribe automatically identify the language of your media. To improve the accuracy of language * identification, you can include several language codes and Amazon Transcribe chooses the closest match for * your transcription. * @return Returns a reference to this object so that method calls can be chained together. * @see LanguageCode */ public CallAnalyticsJob withLanguageCode(String languageCode) { setLanguageCode(languageCode); return this; } /** *

* The language code used to create your Call Analytics job. For a list of supported languages and their associated * language codes, refer to the Supported languages table. *

*

* If you don't know the language spoken in your media file, you can omit this field and let Amazon Transcribe * automatically identify the language of your media. To improve the accuracy of language identification, you can * include several language codes and Amazon Transcribe chooses the closest match for your transcription. *

* * @param languageCode * The language code used to create your Call Analytics job. For a list of supported languages and their * associated language codes, refer to the Supported languages * table.

*

* If you don't know the language spoken in your media file, you can omit this field and let Amazon * Transcribe automatically identify the language of your media. To improve the accuracy of language * identification, you can include several language codes and Amazon Transcribe chooses the closest match for * your transcription. * @return Returns a reference to this object so that method calls can be chained together. * @see LanguageCode */ public CallAnalyticsJob 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 CallAnalyticsJob 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 CallAnalyticsJob 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 CallAnalyticsJob withMediaFormat(MediaFormat mediaFormat) { this.mediaFormat = mediaFormat.toString(); return this; } /** *

* Provides the Amazon S3 location of the media file you used in your Call Analytics request. *

* * @param media * Provides the Amazon S3 location of the media file you used in your Call Analytics request. */ public void setMedia(Media media) { this.media = media; } /** *

* Provides the Amazon S3 location of the media file you used in your Call Analytics request. *

* * @return Provides the Amazon S3 location of the media file you used in your Call Analytics request. */ public Media getMedia() { return this.media; } /** *

* Provides the Amazon S3 location of the media file you used in your Call Analytics request. *

* * @param media * Provides the Amazon S3 location of the media file you used in your Call Analytics request. * @return Returns a reference to this object so that method calls can be chained together. */ public CallAnalyticsJob withMedia(Media media) { setMedia(media); return this; } /** * @param transcript */ public void setTranscript(Transcript transcript) { this.transcript = transcript; } /** * @return */ public Transcript getTranscript() { return this.transcript; } /** * @param transcript * @return Returns a reference to this object so that method calls can be chained together. */ public CallAnalyticsJob withTranscript(Transcript transcript) { setTranscript(transcript); return this; } /** *

* The date and time the specified Call Analytics 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 Call Analytics 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 Call Analytics 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 Call Analytics 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 Call Analytics 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 Call Analytics 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 CallAnalyticsJob withStartTime(java.util.Date startTime) { setStartTime(startTime); return this; } /** *

* The date and time the specified Call Analytics 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 Call Analytics 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 Call Analytics 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 Call Analytics 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 Call Analytics 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 Call Analytics 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 CallAnalyticsJob withCreationTime(java.util.Date creationTime) { setCreationTime(creationTime); return this; } /** *

* The date and time the specified Call Analytics 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 Call Analytics 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 Call Analytics 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 Call Analytics 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 Call Analytics 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 Call Analytics 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 CallAnalyticsJob withCompletionTime(java.util.Date completionTime) { setCompletionTime(completionTime); return this; } /** *

* If CallAnalyticsJobStatus is FAILED, FailureReason contains information * about why the Call Analytics job request failed. *

*

* The FailureReason field contains one of the following values: *

* * * @param failureReason * If CallAnalyticsJobStatus is FAILED, FailureReason contains * information about why the Call Analytics job request failed.

*

* The FailureReason field contains one of the following values: *

*