Class ConfigurationEvent
- All Implemented Interfaces:
Serializable
,SdkPojo
,StartConversationRequestEventStream
,ToCopyableBuilder<ConfigurationEvent.Builder,
ConfigurationEvent>
- Direct Known Subclasses:
DefaultConfigurationEvent
The initial event sent from the application to Amazon Lex V2 to configure the conversation, including session and request attributes and the response content type.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from interface software.amazon.awssdk.services.lexruntimev2.model.StartConversationRequestEventStream
StartConversationRequestEventStream.EventType
-
Method Summary
Modifier and TypeMethodDescriptionstatic ConfigurationEvent.Builder
builder()
final Long
A timestamp set by the client of the date and time that the event was sent to Amazon Lex V2.final ConfigurationEvent
copy
(Consumer<? super ConfigurationEvent.Builder> modifier) A convenience method for callingToCopyableBuilder.toBuilder()
, updating the returned builder and then callingSdkBuilder.build()
.final Boolean
Determines whether Amazon Lex V2 should send audio responses to the client application.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 that your application assigns to the event.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 RequestAttributes property.final boolean
For responses, this returns true if the service returned a value for the WelcomeMessages property.Request-specific information passed between the client application and Amazon Lex V2.final String
The message that Amazon Lex V2 returns in the response can be either text or speech based on theresponseContentType
value.static Class
<? extends ConfigurationEvent.Builder> final SessionState
Returns the value of the SessionState property for this object.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.A list of messages to send to the user.Methods inherited from interface software.amazon.awssdk.services.lexruntimev2.model.StartConversationRequestEventStream
sdkEventType
-
Method Details
-
hasRequestAttributes
public final boolean hasRequestAttributes()For responses, this returns true if the service returned a value for the RequestAttributes 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. -
requestAttributes
Request-specific information passed between the client application and Amazon Lex V2.
The namespace
x-amz-lex:
is reserved for special attributes. Don't create any request attributes for prefixx-amz-lex:
.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
hasRequestAttributes()
method.- Returns:
- Request-specific information passed between the client application and Amazon Lex V2.
The namespace
x-amz-lex:
is reserved for special attributes. Don't create any request attributes for prefixx-amz-lex:
.
-
responseContentType
The message that Amazon Lex V2 returns in the response can be either text or speech based on the
responseContentType
value.-
If the value is
text/plain;charset=utf-8
, Amazon Lex V2 returns text in the response. -
If the value begins with
audio/
, Amazon Lex V2 returns speech in the response. Amazon Lex V2 uses Amazon Polly to generate the speech using the configuration that you specified in therequestContentType
parameter. For example, if you specifyaudio/mpeg
as the value, Amazon Lex V2 returns speech in the MPEG format. -
If the value is
audio/pcm
, the speech returned is audio/pcm in 16-bit, little-endian format. -
The following are the accepted values:
-
audio/mpeg
-
audio/ogg
-
audio/pcm
-
audio/* (defaults to mpeg)
-
text/plain; charset=utf-8
-
- Returns:
- The message that Amazon Lex V2 returns in the response can be either text or speech based on the
responseContentType
value.-
If the value is
text/plain;charset=utf-8
, Amazon Lex V2 returns text in the response. -
If the value begins with
audio/
, Amazon Lex V2 returns speech in the response. Amazon Lex V2 uses Amazon Polly to generate the speech using the configuration that you specified in therequestContentType
parameter. For example, if you specifyaudio/mpeg
as the value, Amazon Lex V2 returns speech in the MPEG format. -
If the value is
audio/pcm
, the speech returned is audio/pcm in 16-bit, little-endian format. -
The following are the accepted values:
-
audio/mpeg
-
audio/ogg
-
audio/pcm
-
audio/* (defaults to mpeg)
-
text/plain; charset=utf-8
-
-
-
-
sessionState
Returns the value of the SessionState property for this object.- Returns:
- The value of the SessionState property for this object.
-
hasWelcomeMessages
public final boolean hasWelcomeMessages()For responses, this returns true if the service returned a value for the WelcomeMessages 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. -
welcomeMessages
A list of messages to send to the user.
If you set the
welcomeMessage
field, you must also set theDialogAction
structure'stype
field.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
hasWelcomeMessages()
method.- Returns:
- A list of messages to send to the user.
If you set the
welcomeMessage
field, you must also set theDialogAction
structure'stype
field.
-
disablePlayback
Determines whether Amazon Lex V2 should send audio responses to the client application.
Set this field to false when the client is operating in a playback mode where audio responses are played to the user. If the client isn't operating in playback mode, such as a text chat application, set this to true so that Amazon Lex V2 doesn't wait for the prompt to finish playing on the client.
- Returns:
- Determines whether Amazon Lex V2 should send audio responses to the client application.
Set this field to false when the client is operating in a playback mode where audio responses are played to the user. If the client isn't operating in playback mode, such as a text chat application, set this to true so that Amazon Lex V2 doesn't wait for the prompt to finish playing on the client.
-
eventId
A unique identifier that your application assigns to the event. You can use this to identify events in logs.
- Returns:
- A unique identifier that your application assigns to the event. You can use this to identify events in logs.
-
clientTimestampMillis
A timestamp set by the client of the date and time that the event was sent to Amazon Lex V2.
- Returns:
- A timestamp set by the client of the date and time that the event was sent to Amazon Lex V2.
-
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<ConfigurationEvent.Builder,
ConfigurationEvent> - 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<ConfigurationEvent.Builder,
ConfigurationEvent> - 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
-