Class CallAnalyticsJobSummary
- java.lang.Object
-
- software.amazon.awssdk.services.transcribe.model.CallAnalyticsJobSummary
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<CallAnalyticsJobSummary.Builder,CallAnalyticsJobSummary>
@Generated("software.amazon.awssdk:codegen") public final class CallAnalyticsJobSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CallAnalyticsJobSummary.Builder,CallAnalyticsJobSummary>
Provides detailed information about a specific Call Analytics job.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceCallAnalyticsJobSummary.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CallAnalyticsJobSummary.Builderbuilder()CallAnalyticsJobDetailscallAnalyticsJobDetails()Provides detailed information about a call analytics job, including information about skipped analytics features.StringcallAnalyticsJobName()The name of the Call Analytics job.CallAnalyticsJobStatuscallAnalyticsJobStatus()Provides the status of your Call Analytics job.StringcallAnalyticsJobStatusAsString()Provides the status of your Call Analytics job.InstantcompletionTime()The date and time the specified Call Analytics job finished processing.InstantcreationTime()The date and time the specified Call Analytics job request was made.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)StringfailureReason()IfCallAnalyticsJobStatusisFAILED,FailureReasoncontains information about why the Call Analytics job failed.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()LanguageCodelanguageCode()The language code used to create your Call Analytics transcription.StringlanguageCodeAsString()The language code used to create your Call Analytics transcription.List<SdkField<?>>sdkFields()static Class<? extends CallAnalyticsJobSummary.Builder>serializableBuilderClass()InstantstartTime()The date and time your Call Analytics job began processing.CallAnalyticsJobSummary.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
callAnalyticsJobName
public final String callAnalyticsJobName()
The name of the Call Analytics job. Job names are case sensitive and must be unique within an Amazon Web Services account.
- Returns:
- The name of the Call Analytics job. Job names are case sensitive and must be unique within an Amazon Web Services account.
-
creationTime
public final Instant 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:00represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.- Returns:
- 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:00represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.
-
startTime
public final Instant 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:00represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.- Returns:
- 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:00represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.
-
completionTime
public final Instant 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:00represents a transcription job that started processing at 12:33 PM UTC-7 on May 4, 2022.- Returns:
- 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:00represents a transcription job that started processing at 12:33 PM UTC-7 on May 4, 2022.
-
languageCode
public final LanguageCode languageCode()
The language code used to create your Call Analytics transcription.
If the service returns an enum value that is not available in the current SDK version,
languageCodewill returnLanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromlanguageCodeAsString().- Returns:
- The language code used to create your Call Analytics transcription.
- See Also:
LanguageCode
-
languageCodeAsString
public final String languageCodeAsString()
The language code used to create your Call Analytics transcription.
If the service returns an enum value that is not available in the current SDK version,
languageCodewill returnLanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromlanguageCodeAsString().- Returns:
- The language code used to create your Call Analytics transcription.
- See Also:
LanguageCode
-
callAnalyticsJobStatus
public final CallAnalyticsJobStatus 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 inTranscriptFileUri(orRedactedTranscriptFileUri, if you requested transcript redaction). If the status isFAILED,FailureReasonprovides details on why your transcription job failed.If the service returns an enum value that is not available in the current SDK version,
callAnalyticsJobStatuswill returnCallAnalyticsJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromcallAnalyticsJobStatusAsString().- Returns:
- 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 inTranscriptFileUri(orRedactedTranscriptFileUri, if you requested transcript redaction). If the status isFAILED,FailureReasonprovides details on why your transcription job failed. - See Also:
CallAnalyticsJobStatus
-
callAnalyticsJobStatusAsString
public final String callAnalyticsJobStatusAsString()
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 inTranscriptFileUri(orRedactedTranscriptFileUri, if you requested transcript redaction). If the status isFAILED,FailureReasonprovides details on why your transcription job failed.If the service returns an enum value that is not available in the current SDK version,
callAnalyticsJobStatuswill returnCallAnalyticsJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromcallAnalyticsJobStatusAsString().- Returns:
- 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 inTranscriptFileUri(orRedactedTranscriptFileUri, if you requested transcript redaction). If the status isFAILED,FailureReasonprovides details on why your transcription job failed. - See Also:
CallAnalyticsJobStatus
-
callAnalyticsJobDetails
public final CallAnalyticsJobDetails callAnalyticsJobDetails()
Provides detailed information about a call analytics job, including information about skipped analytics features.
- Returns:
- Provides detailed information about a call analytics job, including information about skipped analytics features.
-
failureReason
public final String failureReason()
If
CallAnalyticsJobStatusisFAILED,FailureReasoncontains information about why the Call Analytics job failed. See also: Common Errors.- Returns:
- If
CallAnalyticsJobStatusisFAILED,FailureReasoncontains information about why the Call Analytics job failed. See also: Common Errors.
-
toBuilder
public CallAnalyticsJobSummary.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<CallAnalyticsJobSummary.Builder,CallAnalyticsJobSummary>
-
builder
public static CallAnalyticsJobSummary.Builder builder()
-
serializableBuilderClass
public static Class<? extends CallAnalyticsJobSummary.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
toString
public final String toString()
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.
-
-