com.amazonaws.services.transcribe.model

Class CallAnalyticsJobSummary

java.lang.Object

com.amazonaws.services.transcribe.model.CallAnalyticsJobSummary

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CallAnalyticsJobSummary
extends Object
implements Serializable, Cloneable, StructuredPojo

Provides detailed information about a specific Call Analytics job.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
CallAnalyticsJobSummary()

Method Summary

Modifier and Type	Method and Description
CallAnalyticsJobSummary	clone()
boolean	equals(Object obj)
CallAnalyticsJobDetails	getCallAnalyticsJobDetails() Provides detailed information about a call analytics job, including information about skipped analytics features.
String	getCallAnalyticsJobName() The name of the Call Analytics job.
String	getCallAnalyticsJobStatus() Provides the status of your Call Analytics job.
Date	getCompletionTime() The date and time the specified Call Analytics job finished processing.
Date	getCreationTime() The date and time the specified Call Analytics job request was made.
String	getFailureReason() If CallAnalyticsJobStatus is FAILED, FailureReason contains information about why the Call Analytics job failed.
String	getLanguageCode() The language code used to create your Call Analytics transcription.
Date	getStartTime() The date and time your Call Analytics job began processing.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setCallAnalyticsJobDetails(CallAnalyticsJobDetails callAnalyticsJobDetails) Provides detailed information about a call analytics job, including information about skipped analytics features.
void	setCallAnalyticsJobName(String callAnalyticsJobName) The name of the Call Analytics job.
void	setCallAnalyticsJobStatus(String callAnalyticsJobStatus) Provides the status of your Call Analytics job.
void	setCompletionTime(Date completionTime) The date and time the specified Call Analytics job finished processing.
void	setCreationTime(Date creationTime) The date and time the specified Call Analytics job request was made.
void	setFailureReason(String failureReason) If CallAnalyticsJobStatus is FAILED, FailureReason contains information about why the Call Analytics job failed.
void	setLanguageCode(String languageCode) The language code used to create your Call Analytics transcription.
void	setStartTime(Date startTime) The date and time your Call Analytics job began processing.
String	toString() Returns a string representation of this object.
CallAnalyticsJobSummary	withCallAnalyticsJobDetails(CallAnalyticsJobDetails callAnalyticsJobDetails) Provides detailed information about a call analytics job, including information about skipped analytics features.
CallAnalyticsJobSummary	withCallAnalyticsJobName(String callAnalyticsJobName) The name of the Call Analytics job.
CallAnalyticsJobSummary	withCallAnalyticsJobStatus(CallAnalyticsJobStatus callAnalyticsJobStatus) Provides the status of your Call Analytics job.
CallAnalyticsJobSummary	withCallAnalyticsJobStatus(String callAnalyticsJobStatus) Provides the status of your Call Analytics job.
CallAnalyticsJobSummary	withCompletionTime(Date completionTime) The date and time the specified Call Analytics job finished processing.
CallAnalyticsJobSummary	withCreationTime(Date creationTime) The date and time the specified Call Analytics job request was made.
CallAnalyticsJobSummary	withFailureReason(String failureReason) If CallAnalyticsJobStatus is FAILED, FailureReason contains information about why the Call Analytics job failed.
CallAnalyticsJobSummary	withLanguageCode(LanguageCode languageCode) The language code used to create your Call Analytics transcription.
CallAnalyticsJobSummary	withLanguageCode(String languageCode) The language code used to create your Call Analytics transcription.
CallAnalyticsJobSummary	withStartTime(Date startTime) The date and time your Call Analytics job began processing.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CallAnalyticsJobSummary

public CallAnalyticsJobSummary()

Method Detail

setCallAnalyticsJobName

public void setCallAnalyticsJobName(String callAnalyticsJobName)

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

Parameters:

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

getCallAnalyticsJobName

public String getCallAnalyticsJobName()

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.

withCallAnalyticsJobName

public CallAnalyticsJobSummary withCallAnalyticsJobName(String callAnalyticsJobName)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setCreationTime

public void setCreationTime(Date 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.

Parameters:

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.

getCreationTime

public Date getCreationTime()

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:

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.

withCreationTime

public CallAnalyticsJobSummary withCreationTime(Date 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setStartTime

public void setStartTime(Date 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.

Parameters:

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.

getStartTime

public Date getStartTime()

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:

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.

withStartTime

public CallAnalyticsJobSummary withStartTime(Date 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setCompletionTime

public void setCompletionTime(Date 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.

Parameters:

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.

getCompletionTime

public Date getCompletionTime()

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:

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.

withCompletionTime

public CallAnalyticsJobSummary withCompletionTime(Date 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setLanguageCode

public void setLanguageCode(String languageCode)

The language code used to create your Call Analytics transcription.

Parameters:

languageCode - The language code used to create your Call Analytics transcription.

See Also:

LanguageCode

getLanguageCode

public String getLanguageCode()

The language code used to create your Call Analytics transcription.

Returns:

The language code used to create your Call Analytics transcription.

See Also:

LanguageCode

withLanguageCode

public CallAnalyticsJobSummary withLanguageCode(String languageCode)

The language code used to create your Call Analytics transcription.

Parameters:

languageCode - The language code used to create your Call Analytics transcription.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

LanguageCode

withLanguageCode

public CallAnalyticsJobSummary withLanguageCode(LanguageCode languageCode)

The language code used to create your Call Analytics transcription.

Parameters:

languageCode - The language code used to create your Call Analytics transcription.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

LanguageCode

setCallAnalyticsJobStatus

public void setCallAnalyticsJobStatus(String 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.

Parameters:

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.

See Also:

CallAnalyticsJobStatus

getCallAnalyticsJobStatus

public String getCallAnalyticsJobStatus()

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:

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.

See Also:

CallAnalyticsJobStatus

withCallAnalyticsJobStatus

public CallAnalyticsJobSummary withCallAnalyticsJobStatus(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

CallAnalyticsJobStatus

withCallAnalyticsJobStatus

public CallAnalyticsJobSummary withCallAnalyticsJobStatus(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 in TranscriptFileUri (or RedactedTranscriptFileUri, if you requested transcript redaction). If the status is FAILED, FailureReason provides details on why your transcription job failed.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

CallAnalyticsJobStatus

setCallAnalyticsJobDetails

public void setCallAnalyticsJobDetails(CallAnalyticsJobDetails callAnalyticsJobDetails)

Provides detailed information about a call analytics job, including information about skipped analytics features.

Parameters:

callAnalyticsJobDetails - Provides detailed information about a call analytics job, including information about skipped analytics features.

getCallAnalyticsJobDetails

public CallAnalyticsJobDetails getCallAnalyticsJobDetails()

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.

withCallAnalyticsJobDetails

public CallAnalyticsJobSummary withCallAnalyticsJobDetails(CallAnalyticsJobDetails callAnalyticsJobDetails)

Provides detailed information about a call analytics job, including information about skipped analytics features.

Parameters:

callAnalyticsJobDetails - Provides detailed information about a call analytics job, including information about skipped analytics features.

Returns:

Returns a reference to this object so that method calls can be chained together.

setFailureReason

public void setFailureReason(String failureReason)

If CallAnalyticsJobStatus is FAILED, FailureReason contains information about why the Call Analytics job failed. See also: Common Errors.

Parameters:

failureReason - If CallAnalyticsJobStatus is FAILED, FailureReason contains information about why the Call Analytics job failed. See also: Common Errors.

getFailureReason

public String getFailureReason()

If CallAnalyticsJobStatus is FAILED, FailureReason contains information about why the Call Analytics job failed. See also: Common Errors.

Returns:

If CallAnalyticsJobStatus is FAILED, FailureReason contains information about why the Call Analytics job failed. See also: Common Errors.

withFailureReason

public CallAnalyticsJobSummary withFailureReason(String failureReason)

If CallAnalyticsJobStatus is FAILED, FailureReason contains information about why the Call Analytics job failed. See also: Common Errors.

Parameters:

failureReason - If CallAnalyticsJobStatus is FAILED, FailureReason contains information about why the Call Analytics job failed. See also: Common Errors.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CallAnalyticsJobSummary clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.