Class MetadataEvent

java.lang.Object
software.amazon.awssdk.services.qbusiness.model.MetadataEvent
All Implemented Interfaces:
Serializable, SdkPojo, ChatOutputStream, ToCopyableBuilder<MetadataEvent.Builder,MetadataEvent>
Direct Known Subclasses:
DefaultMetadataEvent
@Generated("software.amazon.awssdk:codegen") public class MetadataEvent extends Object implements SdkPojo, Serializable, ToCopyableBuilder<MetadataEvent.Builder,MetadataEvent>, ChatOutputStream

A metadata event for a AI-generated text output message in a Amazon Q Business conversation, containing associated metadata generated.

See Also:

  • Method Details

    • conversationId

      public final String conversationId()

      The identifier of the conversation with which the generated metadata is associated.

      Returns:
      The identifier of the conversation with which the generated metadata is associated.

    • userMessageId

      public final String userMessageId()

      The identifier of an Amazon Q Business end user text input message within the conversation.

      Returns:
      The identifier of an Amazon Q Business end user text input message within the conversation.

    • systemMessageId

      public final String systemMessageId()

      The identifier of an Amazon Q Business AI generated message within the conversation.

      Returns:
      The identifier of an Amazon Q Business AI generated message within the conversation.

    • hasSourceAttributions

      public final boolean hasSourceAttributions()
      For responses, this returns true if the service returned a value for the SourceAttributions 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.

    • sourceAttributions

      public final List<SourceAttribution> sourceAttributions()

      The source documents used to generate the conversation response.

      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 hasSourceAttributions() method.

      Returns:
      The source documents used to generate the conversation response.

    • finalTextMessage

      public final String finalTextMessage()

      The final text output message generated by the system.

      Returns:
      The final text output message generated by the system.

    • toBuilder

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

    • builder

      public static MetadataEvent.Builder builder()

    • serializableBuilderClass

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

    • copy

      public final MetadataEvent copy(Consumer<? super MetadataEvent.Builder> modifier)
      Description copied from interface: ToCopyableBuilder
      A convenience method for calling ToCopyableBuilder.toBuilder(), updating the returned builder and then calling SdkBuilder.build(). This is useful for making small modifications to the existing object.
      Specified by:
      copy in interface ToCopyableBuilder<MetadataEvent.Builder,MetadataEvent>
      Parameters:
      modifier - A function that mutates this immutable object using the provided builder.
      Returns:
      A new copy of this object with the requested modifications.

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

    • accept

      public void accept(ChatResponseHandler.Visitor visitor)
      Calls the appropriate visit method depending on the subtype of MetadataEvent.
      Specified by:
      accept in interface ChatOutputStream
      Parameters:
      visitor - Visitor to invoke.