/* * Copyright 2010-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; /** *
* Provides detailed information about a specific Call Analytics job. *
*/ public class CallAnalyticsJobSummary implements Serializable { /** ** The name of the Call Analytics job. Job names are case sensitive and must * be unique within an Amazon Web Services account. *
*
* Constraints:
* Length: 1 - 200
* Pattern: ^[0-9a-zA-Z._-]+
*/
private String callAnalyticsJobName;
/**
*
* 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.
*
* The date and time your 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.
*
* 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.
*
* The language code used to create your Call Analytics transcription. *
*
* Constraints:
* Allowed Values: af-ZA, ar-AE, ar-SA, da-DK, de-CH, de-DE, en-AB,
* en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA,
* fr-FR, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR,
* pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ,
* vi-VN, sv-SE
*/
private String languageCode;
/**
*
* Provides the status of your 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.
*
* Constraints:
* Allowed Values: QUEUED, IN_PROGRESS, FAILED, COMPLETED
*/
private String callAnalyticsJobStatus;
/**
*
* If CallAnalyticsJobStatus
is FAILED
,
* FailureReason
contains information about why the Call
* Analytics job failed. See also: Common Errors.
*
* The name of the Call Analytics job. Job names are case sensitive and must * be unique within an Amazon Web Services account. *
*
* Constraints:
* Length: 1 - 200
* Pattern: ^[0-9a-zA-Z._-]+
*
* @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 callAnalyticsJobName; } /** ** The name of the Call Analytics job. Job names are case sensitive and must * be unique within an Amazon Web Services account. *
*
* Constraints:
* Length: 1 - 200
* Pattern: ^[0-9a-zA-Z._-]+
*
* @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. *
** Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Length: 1 - 200
* Pattern: ^[0-9a-zA-Z._-]+
*
* @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 A reference to this updated object so that method calls can be * chained together. */ public CallAnalyticsJobSummary withCallAnalyticsJobName(String callAnalyticsJobName) { this.callAnalyticsJobName = callAnalyticsJobName; 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* Returns a reference to this object so that method calls can be chained * together. * * @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.
*
* The date and time your 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.
*
* The date and time your 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.
*
* The date and time your 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.
*
* The date and time your 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.
*
* The date and time your 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.
*
* Returns a reference to this object so that method calls can be chained * together. * * @param startTime
* The date and time your 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* Returns a reference to this object so that method calls can be chained * together. * * @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.
*
* The language code used to create your Call Analytics transcription. *
*
* Constraints:
* Allowed Values: af-ZA, ar-AE, ar-SA, da-DK, de-CH, de-DE, en-AB,
* en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA,
* fr-FR, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR,
* pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ,
* vi-VN, sv-SE
*
* @return
* The language code used to create your Call Analytics * transcription. *
* @see LanguageCode */ public String getLanguageCode() { return languageCode; } /** ** The language code used to create your Call Analytics transcription. *
*
* Constraints:
* Allowed Values: af-ZA, ar-AE, ar-SA, da-DK, de-CH, de-DE, en-AB,
* en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA,
* fr-FR, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR,
* pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ,
* vi-VN, sv-SE
*
* @param languageCode
* The language code used to create your Call Analytics * transcription. *
* @see LanguageCode */ public void setLanguageCode(String languageCode) { this.languageCode = languageCode; } /** ** The language code used to create your Call Analytics transcription. *
** Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Allowed Values: af-ZA, ar-AE, ar-SA, da-DK, de-CH, de-DE, en-AB,
* en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA,
* fr-FR, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR,
* pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ,
* vi-VN, sv-SE
*
* @param languageCode
* The language code used to create your Call Analytics * transcription. *
* @return A reference to this updated object so that method calls can be * chained together. * @see LanguageCode */ public CallAnalyticsJobSummary withLanguageCode(String languageCode) { this.languageCode = languageCode; return this; } /** ** The language code used to create your Call Analytics transcription. *
*
* Constraints:
* Allowed Values: af-ZA, ar-AE, ar-SA, da-DK, de-CH, de-DE, en-AB,
* en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA,
* fr-FR, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR,
* pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ,
* vi-VN, sv-SE
*
* @param languageCode
* The language code used to create your Call Analytics * transcription. *
* @see LanguageCode */ public void setLanguageCode(LanguageCode languageCode) { this.languageCode = languageCode.toString(); } /** ** The language code used to create your Call Analytics transcription. *
** Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Allowed Values: af-ZA, ar-AE, ar-SA, da-DK, de-CH, de-DE, en-AB,
* en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA,
* fr-FR, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR,
* pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ,
* vi-VN, sv-SE
*
* @param languageCode
* The language code used to create your Call Analytics * transcription. *
* @return A reference to this updated object so that method calls can be * chained together. * @see LanguageCode */ public CallAnalyticsJobSummary withLanguageCode(LanguageCode languageCode) { this.languageCode = languageCode.toString(); return this; } /** ** Provides the status of your 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.
*
* Constraints:
* Allowed Values: QUEUED, IN_PROGRESS, FAILED, COMPLETED
*
* @return
* Provides the status of your 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.
*
* Provides the status of your 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.
*
* Constraints:
* Allowed Values: QUEUED, IN_PROGRESS, FAILED, COMPLETED
*
* @param callAnalyticsJobStatus
* Provides the status of your 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.
*
* Provides the status of your 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.
*
* Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Allowed Values: QUEUED, IN_PROGRESS, FAILED, COMPLETED
*
* @param callAnalyticsJobStatus
* Provides the status of your 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.
*
* Provides the status of your 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.
*
* Constraints:
* Allowed Values: QUEUED, IN_PROGRESS, FAILED, COMPLETED
*
* @param callAnalyticsJobStatus
* Provides the status of your 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.
*
* Provides the status of your 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.
*
* Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Allowed Values: QUEUED, IN_PROGRESS, FAILED, COMPLETED
*
* @param callAnalyticsJobStatus
* Provides the status of your 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.
*
* If CallAnalyticsJobStatus
is FAILED
,
* FailureReason
contains information about why the Call
* Analytics job failed. See also: Common Errors.
*
* If CallAnalyticsJobStatus
is FAILED
,
* FailureReason
contains information about why the
* Call Analytics job failed. See also: Common Errors.
*
* If CallAnalyticsJobStatus
is FAILED
,
* FailureReason
contains information about why the Call
* Analytics job failed. See also: Common Errors.
*
* If CallAnalyticsJobStatus
is FAILED
,
* FailureReason
contains information about why the
* Call Analytics job failed. See also: Common Errors.
*
* If CallAnalyticsJobStatus
is FAILED
,
* FailureReason
contains information about why the Call
* Analytics job failed. See also: Common Errors.
*
* Returns a reference to this object so that method calls can be chained * together. * * @param failureReason
* If CallAnalyticsJobStatus
is FAILED
,
* FailureReason
contains information about why the
* Call Analytics job failed. See also: Common Errors.
*