Class Transcript

java.lang.Object
software.amazon.awssdk.services.connectcontactlens.model.Transcript
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Transcript.Builder,Transcript>
@Generated("software.amazon.awssdk:codegen") public final class Transcript extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Transcript.Builder,Transcript>

A list of messages in the session.

See Also:

  • Method Details

    • id

      public final String id()

      The identifier of the transcript.

      Returns:
      The identifier of the transcript.

    • participantId

      public final String participantId()

      The identifier of the participant. Valid values are CUSTOMER or AGENT.

      Returns:
      The identifier of the participant. Valid values are CUSTOMER or AGENT.

    • participantRole

      public final String participantRole()

      The role of participant. For example, is it a customer, agent, or system.

      Returns:
      The role of participant. For example, is it a customer, agent, or system.

    • content

      public final String content()

      The content of the transcript.

      Returns:
      The content of the transcript.

    • beginOffsetMillis

      public final Integer beginOffsetMillis()

      The beginning offset in the contact for this transcript.

      Returns:
      The beginning offset in the contact for this transcript.

    • endOffsetMillis

      public final Integer endOffsetMillis()

      The end offset in the contact for this transcript.

      Returns:
      The end offset in the contact for this transcript.

    • sentiment

      public final SentimentValue sentiment()

      The sentiment detected for this piece of transcript.

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

      Returns:
      The sentiment detected for this piece of transcript.
      See Also:

    • sentimentAsString

      public final String sentimentAsString()

      The sentiment detected for this piece of transcript.

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

      Returns:
      The sentiment detected for this piece of transcript.
      See Also:

    • hasIssuesDetected

      public final boolean hasIssuesDetected()
      For responses, this returns true if the service returned a value for the IssuesDetected property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • issuesDetected

      public final List<IssueDetected> issuesDetected()

      List of positions where issues were detected on the transcript.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasIssuesDetected() method.

      Returns:
      List of positions where issues were detected on the transcript.

    • toBuilder

      public Transcript.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<Transcript.Builder,Transcript>
      Returns:
      a builder for type T

    • builder

      public static Transcript.Builder builder()

    • serializableBuilderClass

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