Package software.amazon.awssdk.services.transcribe.model

Interface CallAnalyticsJobSummary.Builder

All Superinterfaces:

Buildable, CopyableBuilder<CallAnalyticsJobSummary.Builder,CallAnalyticsJobSummary>, SdkBuilder<CallAnalyticsJobSummary.Builder,CallAnalyticsJobSummary>, SdkPojo

Enclosing class:

CallAnalyticsJobSummary

public static interface CallAnalyticsJobSummary.Builder
extends SdkPojo, CopyableBuilder<CallAnalyticsJobSummary.Builder,CallAnalyticsJobSummary>

Method Summary

Modifier and Type	Method	Description
default CallAnalyticsJobSummary.Builder	callAnalyticsJobDetails(Consumer<CallAnalyticsJobDetails.Builder> callAnalyticsJobDetails)	Provides detailed information about a call analytics job, including information about skipped analytics features.
CallAnalyticsJobSummary.Builder	callAnalyticsJobDetails(CallAnalyticsJobDetails callAnalyticsJobDetails)	Provides detailed information about a call analytics job, including information about skipped analytics features.
CallAnalyticsJobSummary.Builder	callAnalyticsJobName(String callAnalyticsJobName)	The name of the Call Analytics job.
CallAnalyticsJobSummary.Builder	callAnalyticsJobStatus(String callAnalyticsJobStatus)	Provides the status of your Call Analytics job.
CallAnalyticsJobSummary.Builder	callAnalyticsJobStatus(CallAnalyticsJobStatus callAnalyticsJobStatus)	Provides the status of your Call Analytics job.
CallAnalyticsJobSummary.Builder	completionTime(Instant completionTime)	The date and time the specified Call Analytics job finished processing.
CallAnalyticsJobSummary.Builder	creationTime(Instant creationTime)	The date and time the specified Call Analytics job request was made.
CallAnalyticsJobSummary.Builder	failureReason(String failureReason)	If CallAnalyticsJobStatus is FAILED, FailureReason contains information about why the Call Analytics job failed.
CallAnalyticsJobSummary.Builder	languageCode(String languageCode)	The language code used to create your Call Analytics transcription.
CallAnalyticsJobSummary.Builder	languageCode(LanguageCode languageCode)	The language code used to create your Call Analytics transcription.
CallAnalyticsJobSummary.Builder	startTime(Instant startTime)	The date and time your Call Analytics job began processing.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Detail

callAnalyticsJobName

CallAnalyticsJobSummary.Builder callAnalyticsJobName(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.

creationTime

CallAnalyticsJobSummary.Builder creationTime(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: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.

startTime

CallAnalyticsJobSummary.Builder startTime(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: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.

completionTime

CallAnalyticsJobSummary.Builder completionTime(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: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.

languageCode

CallAnalyticsJobSummary.Builder languageCode(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, LanguageCode

languageCode

CallAnalyticsJobSummary.Builder languageCode(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, LanguageCode

callAnalyticsJobStatus

CallAnalyticsJobSummary.Builder callAnalyticsJobStatus(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, CallAnalyticsJobStatus

callAnalyticsJobStatus

CallAnalyticsJobSummary.Builder callAnalyticsJobStatus(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, CallAnalyticsJobStatus

callAnalyticsJobDetails

CallAnalyticsJobSummary.Builder callAnalyticsJobDetails(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.

callAnalyticsJobDetails

default CallAnalyticsJobSummary.Builder callAnalyticsJobDetails(Consumer<CallAnalyticsJobDetails.Builder> callAnalyticsJobDetails)

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

This is a convenience method that creates an instance of the CallAnalyticsJobDetails.Builder avoiding the need to create one manually via CallAnalyticsJobDetails.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to callAnalyticsJobDetails(CallAnalyticsJobDetails).

Parameters:

callAnalyticsJobDetails - a consumer that will call methods on CallAnalyticsJobDetails.Builder

Returns:

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

See Also:

callAnalyticsJobDetails(CallAnalyticsJobDetails)

failureReason

CallAnalyticsJobSummary.Builder failureReason(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.