Package software.amazon.awssdk.services.qbusiness.model

Class Message

    • Method Detail

      • messageId

        public final String messageId()

        The identifier of the Amazon Q Business web experience message.

        Returns:
        The identifier of the Amazon Q Business web experience message.

      • body

        public final String body()

        The content of the Amazon Q Business web experience message.

        Returns:
        The content of the Amazon Q Business web experience message.

      • time

        public final Instant time()

        The timestamp of the first Amazon Q Business web experience message.

        Returns:
        The timestamp of the first Amazon Q Business web experience message.

      • type

        public final MessageType type()

        The type of Amazon Q Business message, whether HUMAN or AI generated.

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

        Returns:
        The type of Amazon Q Business message, whether HUMAN or AI generated.
        See Also:
        MessageType

      • typeAsString

        public final String typeAsString()

        The type of Amazon Q Business message, whether HUMAN or AI generated.

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

        Returns:
        The type of Amazon Q Business message, whether HUMAN or AI generated.
        See Also:
        MessageType

      • hasAttachments

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

      • attachments

        public final List<AttachmentOutput> attachments()

        A file directly uploaded into an Amazon Q Business web experience chat.

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

        Returns:
        A file directly uploaded into an Amazon Q Business web experience chat.

      • hasSourceAttribution

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

      • sourceAttribution

        public final List<SourceAttribution> sourceAttribution()

        The source documents used to generate Amazon Q Business web experience message.

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

        Returns:
        The source documents used to generate Amazon Q Business web experience message.

      • actionReview

        public final ActionReview actionReview()
        Returns the value of the ActionReview property for this object.
        Returns:
        The value of the ActionReview property for this object.

      • actionExecution

        public final ActionExecution actionExecution()
        Returns the value of the ActionExecution property for this object.
        Returns:
        The value of the ActionExecution property for this object.

      • serializableBuilderClass

        public static Class<? extends Message.Builder> serializableBuilderClass()

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object

      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object

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