Class TextOutputEvent
java.lang.Object
software.amazon.awssdk.services.qbusiness.model.TextOutputEvent
- All Implemented Interfaces:
Serializable
,SdkPojo
,ChatOutputStream
,ToCopyableBuilder<TextOutputEvent.Builder,
TextOutputEvent>
- Direct Known Subclasses:
DefaultTextEvent
@Generated("software.amazon.awssdk:codegen")
public class TextOutputEvent
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<TextOutputEvent.Builder,TextOutputEvent>, ChatOutputStream
An output event for an AI-generated response in an Amazon Q Business web experience.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from interface software.amazon.awssdk.services.qbusiness.model.ChatOutputStream
ChatOutputStream.EventType
-
Field Summary
Fields inherited from interface software.amazon.awssdk.services.qbusiness.model.ChatOutputStream
UNKNOWN
-
Method Summary
Modifier and TypeMethodDescriptionvoid
accept
(ChatResponseHandler.Visitor visitor) Calls the appropriate visit method depending on the subtype ofTextOutputEvent
.static TextOutputEvent.Builder
builder()
final String
The identifier of the conversation with which the text output event is associated.final TextOutputEvent
copy
(Consumer<? super TextOutputEvent.Builder> modifier) A convenience method for callingToCopyableBuilder.toBuilder()
, updating the returned builder and then callingSdkBuilder.build()
.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
static Class
<? extends TextOutputEvent.Builder> final String
An AI-generated message in aTextOutputEvent
.final String
The identifier of an AI-generated message in aTextOutputEvent
.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
The identifier of an end user message in aTextOutputEvent
.Methods inherited from interface software.amazon.awssdk.services.qbusiness.model.ChatOutputStream
sdkEventType
-
Method Details
-
conversationId
The identifier of the conversation with which the text output event is associated.
- Returns:
- The identifier of the conversation with which the text output event is associated.
-
userMessageId
The identifier of an end user message in a
TextOutputEvent
.- Returns:
- The identifier of an end user message in a
TextOutputEvent
.
-
systemMessageId
The identifier of an AI-generated message in a
TextOutputEvent
.- Returns:
- The identifier of an AI-generated message in a
TextOutputEvent
.
-
systemMessage
An AI-generated message in a
TextOutputEvent
.- Returns:
- An AI-generated message in a
TextOutputEvent
.
-
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 interfaceToCopyableBuilder<TextOutputEvent.Builder,
TextOutputEvent> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
copy
Description copied from interface:ToCopyableBuilder
A convenience method for callingToCopyableBuilder.toBuilder()
, updating the returned builder and then callingSdkBuilder.build()
. This is useful for making small modifications to the existing object.- Specified by:
copy
in interfaceToCopyableBuilder<TextOutputEvent.Builder,
TextOutputEvent> - 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
-
accept
Calls the appropriate visit method depending on the subtype ofTextOutputEvent
.- Specified by:
accept
in interfaceChatOutputStream
- Parameters:
visitor
- Visitor to invoke.
-