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:

  • Method Details

    • 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:

    • 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:

    • 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:

    • 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:

    • toBuilder

      public PostContactSummary.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<PostContactSummary.Builder,PostContactSummary>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.