Class TextResponseEvent
- All Implemented Interfaces:
Serializable
,SdkPojo
,StartConversationResponseEventStream
,ToCopyableBuilder<TextResponseEvent.Builder,
TextResponseEvent>
- Direct Known Subclasses:
DefaultTextResponseEvent
The event sent from Amazon Lex V2 to your application with text to present to the user.
- See Also:
-
Nested Class Summary
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
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Calls the appropriate visit method depending on the subtype ofTextResponseEvent
.static TextResponseEvent.Builder
builder()
final TextResponseEvent
copy
(Consumer<? super TextResponseEvent.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 String
eventId()
A unique identifier of the event sent by Amazon Lex V2.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Messages property.messages()
A list of messages to send to the user.static Class
<? extends TextResponseEvent.Builder> 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.Methods inherited from interface software.amazon.awssdk.services.lexruntimev2.model.StartConversationResponseEventStream
sdkEventType
-
Method Details
-
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 theisEmpty()
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
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
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
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<TextResponseEvent.Builder,
TextResponseEvent> - 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<TextResponseEvent.Builder,
TextResponseEvent> - 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 ofTextResponseEvent
.- Specified by:
accept
in interfaceStartConversationResponseEventStream
- Parameters:
visitor
- Visitor to invoke.
-