software.amazon.awssdk.services.transcribe.model

Class CallAnalyticsJobSummary

java.lang.Object

software.amazon.awssdk.services.transcribe.model.CallAnalyticsJobSummary

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<CallAnalyticsJobSummary.Builder,CallAnalyticsJobSummary>

@Generated(value="software.amazon.awssdk:codegen")
public final class CallAnalyticsJobSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CallAnalyticsJobSummary.Builder,CallAnalyticsJobSummary>

Provides summary information about a call analytics job.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CallAnalyticsJobSummary.Builder

Method Summary

Modifier and Type	Method and Description
static CallAnalyticsJobSummary.Builder	builder()
String	callAnalyticsJobName() The name of the call analytics job.
CallAnalyticsJobStatus	callAnalyticsJobStatus() The status of the call analytics job.
String	callAnalyticsJobStatusAsString() The status of the call analytics job.
Instant	completionTime() A timestamp that shows when the job was completed.
Instant	creationTime() A timestamp that shows when the call analytics job was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	failureReason() If the CallAnalyticsJobStatus is FAILED, a description of the error.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
LanguageCode	languageCode() The language of the transcript in the source audio file.
String	languageCodeAsString() The language of the transcript in the source audio file.
List<SdkField<?>>	sdkFields()
static Class<? extends CallAnalyticsJobSummary.Builder>	serializableBuilderClass()
Instant	startTime() A timestamp that shows when the job began processing.
CallAnalyticsJobSummary.Builder	toBuilder()
String	toString() 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.

Returns:

The name of the call analytics job.

creationTime

public final Instant creationTime()

A timestamp that shows when the call analytics job was created.

Returns:

A timestamp that shows when the call analytics job was created.

startTime

public final Instant startTime()

A timestamp that shows when the job began processing.

Returns:

A timestamp that shows when the job began processing.

completionTime

public final Instant completionTime()

A timestamp that shows when the job was completed.

Returns:

A timestamp that shows when the job was completed.

languageCode

public final LanguageCode languageCode()

The language of the transcript in the source audio file.

If the service returns an enum value that is not available in the current SDK version, languageCode will return LanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from languageCodeAsString().

Returns:

The language of the transcript in the source audio file.

See Also:

LanguageCode

languageCodeAsString

public final String languageCodeAsString()

The language of the transcript in the source audio file.

If the service returns an enum value that is not available in the current SDK version, languageCode will return LanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from languageCodeAsString().

Returns:

The language of the transcript in the source audio file.

See Also:

LanguageCode

callAnalyticsJobStatus

public final CallAnalyticsJobStatus callAnalyticsJobStatus()

The status of the call analytics job.

If the service returns an enum value that is not available in the current SDK version, callAnalyticsJobStatus will return CallAnalyticsJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from callAnalyticsJobStatusAsString().

Returns:

The status of the call analytics job.

See Also:

CallAnalyticsJobStatus

callAnalyticsJobStatusAsString

public final String callAnalyticsJobStatusAsString()

The status of the call analytics job.

If the service returns an enum value that is not available in the current SDK version, callAnalyticsJobStatus will return CallAnalyticsJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from callAnalyticsJobStatusAsString().

Returns:

The status of the call analytics job.

See Also:

CallAnalyticsJobStatus

failureReason

public final String failureReason()

If the CallAnalyticsJobStatus is FAILED, a description of the error.

Returns:

If the CallAnalyticsJobStatus is FAILED, a description of the error.

toBuilder

public CallAnalyticsJobSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CallAnalyticsJobSummary.Builder,CallAnalyticsJobSummary>

builder

public static CallAnalyticsJobSummary.Builder builder()

serializableBuilderClass

public static Class<? extends CallAnalyticsJobSummary.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo