software.amazon.awssdk.services.lexruntimev2.model

Class TextResponseEvent

java.lang.Object

software.amazon.awssdk.services.lexruntimev2.model.TextResponseEvent

All Implemented Interfaces:

Serializable, SdkPojo, StartConversationResponseEventStream, ToCopyableBuilder<TextResponseEvent.Builder,TextResponseEvent>

Direct Known Subclasses:

DefaultTextResponseEvent

@Generated(value="software.amazon.awssdk:codegen")
public class TextResponseEvent
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<TextResponseEvent.Builder,TextResponseEvent>, StartConversationResponseEventStream

The event sent from Amazon Lex V2 to your application with text to present to the user.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from interface software.amazon.awssdk.services.lexruntimev2.model.StartConversationResponseEventStream

StartConversationResponseEventStream.EventType

Field Summary

Fields inherited from interface software.amazon.awssdk.services.lexruntimev2.model.StartConversationResponseEventStream

UNKNOWN

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TextResponseEvent(TextResponseEvent.BuilderImpl builder)

Method Summary

Modifier and Type	Method and Description
void	accept(StartConversationResponseHandler.Visitor visitor) Calls the appropriate visit method depending on the subtype of TextResponseEvent.
static TextResponseEvent.Builder	builder()
TextResponseEvent	copy(Consumer<? super TextResponseEvent.Builder> modifier)
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	eventId() A unique identifier of the event sent by Amazon Lex V2.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasMessages() For responses, this returns true if the service returned a value for the Messages property.
List<Message>	messages() A list of messages to send to the user.
List<SdkField<?>>	sdkFields()
static Class<? extends TextResponseEvent.Builder>	serializableBuilderClass()
TextResponseEvent.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.services.lexruntimev2.model.StartConversationResponseEventStream

audioResponseEventBuilder, heartbeatEventBuilder, intentResultEventBuilder, playbackInterruptionEventBuilder, sdkEventType, textResponseEventBuilder, transcriptEventBuilder

Constructor Detail

TextResponseEvent

protected TextResponseEvent(TextResponseEvent.BuilderImpl builder)

Method Detail

hasMessages

public final boolean hasMessages()

For responses, this returns true if the service returned a value for the Messages 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.

messages

public final List<Message> messages()

A list of messages to send to the user. Messages are ordered based on the order that you returned the messages from your Lambda function or the order that the messages are defined in the bot.

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

Returns:

A list of messages to send to the user. Messages are ordered based on the order that you returned the messages from your Lambda function or the order that the messages are defined in the bot.

eventId

public final String eventId()

A unique identifier of the event sent by Amazon Lex V2. The identifier is in the form RESPONSE-N, where N is a number starting with one and incremented for each event sent by Amazon Lex V2 in the current session.

Returns:

A unique identifier of the event sent by Amazon Lex V2. The identifier is in the form RESPONSE-N, where N is a number starting with one and incremented for each event sent by Amazon Lex V2 in the current session.

toBuilder

public TextResponseEvent.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TextResponseEvent.Builder,TextResponseEvent>

builder

public static TextResponseEvent.Builder builder()

serializableBuilderClass

public static Class<? extends TextResponseEvent.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 TextResponseEvent copy(Consumer<? super TextResponseEvent.Builder> modifier)

Specified by:

copy in interface ToCopyableBuilder<TextResponseEvent.Builder,TextResponseEvent>

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

accept

public void accept(StartConversationResponseHandler.Visitor visitor)

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

Specified by:

accept in interface StartConversationResponseEventStream

Parameters:

visitor - Visitor to invoke.