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

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TextOutputEvent.Builder
protected static class	TextOutputEvent.BuilderImpl

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TextOutputEvent(TextOutputEvent.BuilderImpl builder)

Method Summary

Modifier and Type	Method	Description
void	accept(ChatResponseHandler.Visitor visitor)	Calls the appropriate visit method depending on the subtype of TextOutputEvent.
static TextOutputEvent.Builder	builder()
String	conversationId()	The identifier of the conversation with which the text output event is associated.
TextOutputEvent	copy(Consumer<? super TextOutputEvent.Builder> modifier)
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends TextOutputEvent.Builder>	serializableBuilderClass()
String	systemMessage()	An AI-generated message in a TextOutputEvent.
String	systemMessageId()	The identifier of an AI-generated message in a TextOutputEvent.
TextOutputEvent.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	userMessageId()	The identifier of an end user message in a TextOutputEvent.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.services.qbusiness.model.ChatOutputStream

sdkEventType

Constructor Detail

TextOutputEvent

protected TextOutputEvent(TextOutputEvent.BuilderImpl builder)

Method Detail

conversationId

public final String 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

public final String userMessageId()

The identifier of an end user message in a TextOutputEvent.

Returns:

The identifier of an end user message in a TextOutputEvent.

systemMessageId

public final String systemMessageId()

The identifier of an AI-generated message in a TextOutputEvent.

Returns:

The identifier of an AI-generated message in a TextOutputEvent.

systemMessage

public final String systemMessage()

An AI-generated message in a TextOutputEvent.

Returns:

An AI-generated message in a TextOutputEvent.

toBuilder

public TextOutputEvent.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TextOutputEvent.Builder,TextOutputEvent>

builder

public static TextOutputEvent.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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 TextOutputEvent copy(Consumer<? super TextOutputEvent.Builder> modifier)

Specified by:

copy in interface ToCopyableBuilder<TextOutputEvent.Builder,TextOutputEvent>

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

accept

public void accept(ChatResponseHandler.Visitor visitor)

Calls the appropriate visit method depending on the subtype of TextOutputEvent.

Specified by:

accept in interface ChatOutputStream

Parameters:

visitor - Visitor to invoke.