Package software.amazon.awssdk.services.connectcontactlens.model

Class PostContactSummary

java.lang.Object

software.amazon.awssdk.services.connectcontactlens.model.PostContactSummary

All Implemented Interfaces:

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

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

Information about the post-contact summary.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PostContactSummary.Builder

Method Summary

Modifier and Type	Method	Description
static PostContactSummary.Builder	builder()
String	content()	The content of the summary.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
PostContactSummaryFailureCode	failureCode()	If the summary failed to be generated, one of the following failure codes occurs:
String	failureCodeAsString()	If the summary failed to be generated, one of the following failure codes occurs:
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends PostContactSummary.Builder>	serializableBuilderClass()
PostContactSummaryStatus	status()	Whether the summary was successfully COMPLETED or FAILED to be generated.
String	statusAsString()	Whether the summary was successfully COMPLETED or FAILED to be generated.
PostContactSummary.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

content

public final String content()

The content of the summary.

Returns:

The content of the summary.

status

public final PostContactSummaryStatus status()

Whether the summary was successfully COMPLETED or FAILED to be generated.

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

Returns:

Whether the summary was successfully COMPLETED or FAILED to be generated.

See Also:

PostContactSummaryStatus

statusAsString

public final String statusAsString()

Whether the summary was successfully COMPLETED or FAILED to be generated.

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

Returns:

Whether the summary was successfully COMPLETED or FAILED to be generated.

See Also:

PostContactSummaryStatus

failureCode

public final PostContactSummaryFailureCode failureCode()

If the summary failed to be generated, one of the following failure codes occurs:

• QUOTA_EXCEEDED: The number of concurrent analytics jobs reached your service quota.

• INSUFFICIENT_CONVERSATION_CONTENT: The conversation needs to have at least one turn from both the participants in order to generate the summary.

• FAILED_SAFETY_GUIDELINES: The generated summary cannot be provided because it failed to meet system safety guidelines.

• INVALID_ANALYSIS_CONFIGURATION: This code occurs when, for example, you're using a language that isn't supported by generative AI-powered post-contact summaries.

• INTERNAL_ERROR: Internal system error.

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

Returns:

If the summary failed to be generated, one of the following failure codes occurs:

• QUOTA_EXCEEDED: The number of concurrent analytics jobs reached your service quota.

• INSUFFICIENT_CONVERSATION_CONTENT: The conversation needs to have at least one turn from both the participants in order to generate the summary.

• FAILED_SAFETY_GUIDELINES: The generated summary cannot be provided because it failed to meet system safety guidelines.

• INVALID_ANALYSIS_CONFIGURATION: This code occurs when, for example, you're using a language that isn't supported by generative AI-powered post-contact summaries.

• INTERNAL_ERROR: Internal system error.

See Also:

PostContactSummaryFailureCode

failureCodeAsString

public final String failureCodeAsString()

If the summary failed to be generated, one of the following failure codes occurs:

• QUOTA_EXCEEDED: The number of concurrent analytics jobs reached your service quota.

• INSUFFICIENT_CONVERSATION_CONTENT: The conversation needs to have at least one turn from both the participants in order to generate the summary.

• FAILED_SAFETY_GUIDELINES: The generated summary cannot be provided because it failed to meet system safety guidelines.

• INVALID_ANALYSIS_CONFIGURATION: This code occurs when, for example, you're using a language that isn't supported by generative AI-powered post-contact summaries.

• INTERNAL_ERROR: Internal system error.

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

Returns:

If the summary failed to be generated, one of the following failure codes occurs:

• QUOTA_EXCEEDED: The number of concurrent analytics jobs reached your service quota.

• INSUFFICIENT_CONVERSATION_CONTENT: The conversation needs to have at least one turn from both the participants in order to generate the summary.

• FAILED_SAFETY_GUIDELINES: The generated summary cannot be provided because it failed to meet system safety guidelines.

• INVALID_ANALYSIS_CONFIGURATION: This code occurs when, for example, you're using a language that isn't supported by generative AI-powered post-contact summaries.

• INTERNAL_ERROR: Internal system error.

See Also:

PostContactSummaryFailureCode

toBuilder

public PostContactSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PostContactSummary.Builder,PostContactSummary>

builder

public static PostContactSummary.Builder builder()

serializableBuilderClass

public static Class<? extends PostContactSummary.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