software.amazon.awssdk.services.lexruntimev2.model

Class ConfigurationEvent

java.lang.Object

software.amazon.awssdk.services.lexruntimev2.model.ConfigurationEvent

All Implemented Interfaces:

Serializable, SdkPojo, StartConversationRequestEventStream, ToCopyableBuilder<ConfigurationEvent.Builder,ConfigurationEvent>

Direct Known Subclasses:

DefaultConfigurationEvent

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

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:

Serialized Form

Nested Class Summary

Nested Classes

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

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

StartConversationRequestEventStream.EventType

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static ConfigurationEvent.Builder	builder()
Long	clientTimestampMillis() A timestamp set by the client of the date and time that the event was sent to Amazon Lex V2.
ConfigurationEvent	copy(Consumer<? super ConfigurationEvent.Builder> modifier)
Boolean	disablePlayback() Determines whether Amazon Lex V2 should send audio responses to the client application.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	eventId() A unique identifier that your application assigns to the event.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasRequestAttributes() For responses, this returns true if the service returned a value for the RequestAttributes property.
boolean	hasWelcomeMessages() For responses, this returns true if the service returned a value for the WelcomeMessages property.
Map<String,String>	requestAttributes() Request-specific information passed between the client application and Amazon Lex V2.
String	responseContentType() The message that Amazon Lex V2 returns in the response can be either text or speech based on the responseContentType value.
List<SdkField<?>>	sdkFields()
static Class<? extends ConfigurationEvent.Builder>	serializableBuilderClass()
SessionState	sessionState() Returns the value of the SessionState property for this object.
ConfigurationEvent.Builder	toBuilder()
String	toString() Returns a string representation of this object.
List<Message>	welcomeMessages() A list of messages to send to the user.

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.StartConversationRequestEventStream

audioInputEventBuilder, configurationEventBuilder, disconnectionEventBuilder, dTMFInputEventBuilder, playbackCompletionEventBuilder, sdkEventType, textInputEventBuilder

Constructor Detail

ConfigurationEvent

protected ConfigurationEvent(ConfigurationEvent.BuilderImpl builder)

Method Detail

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 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.

requestAttributes

public final Map<String,String> 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 prefix x-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 prefix x-amz-lex:.

responseContentType

public final String 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 the requestContentType parameter. For example, if you specify audio/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 the requestContentType parameter. For example, if you specify audio/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

public final SessionState 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 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.

welcomeMessages

public final List<Message> welcomeMessages()

A list of messages to send to the user.

If you set the welcomeMessage field, you must also set the DialogAction structure's type 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 the DialogAction structure's type field.

disablePlayback

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

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

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

public ConfigurationEvent.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ConfigurationEvent.Builder,ConfigurationEvent>

builder

public static ConfigurationEvent.Builder builder()

serializableBuilderClass

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

Specified by:

copy in interface ToCopyableBuilder<ConfigurationEvent.Builder,ConfigurationEvent>

sdkFields

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

Specified by:

sdkFields in interface SdkPojo