software.amazon.awssdk.services.lexruntimev2.model

Interface ConfigurationEvent.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ConfigurationEvent.Builder,ConfigurationEvent>, SdkBuilder<ConfigurationEvent.Builder,ConfigurationEvent>, SdkPojo

All Known Subinterfaces:

DefaultConfigurationEvent.Builder

All Known Implementing Classes:

ConfigurationEvent.BuilderImpl

Enclosing class:

ConfigurationEvent

public static interface ConfigurationEvent.Builder
extends SdkPojo, CopyableBuilder<ConfigurationEvent.Builder,ConfigurationEvent>

Method Summary

Modifier and Type	Method and Description
ConfigurationEvent.Builder	clientTimestampMillis(Long clientTimestampMillis) A timestamp set by the client of the date and time that the event was sent to Amazon Lex.
ConfigurationEvent.Builder	disablePlayback(Boolean disablePlayback) Determines whether Amazon Lex should send audio responses to the client application.
ConfigurationEvent.Builder	eventId(String eventId) A unique identifier that your application assigns to the event.
ConfigurationEvent.Builder	requestAttributes(Map<String,String> requestAttributes) Request-specific information passed between the client application and Amazon Lex.
ConfigurationEvent.Builder	responseContentType(String responseContentType) The message that Amazon Lex returns in the response can be either text or speech based on the responseContentType value.
default ConfigurationEvent.Builder	sessionState(Consumer<SessionState.Builder> sessionState) Sets the value of the SessionState property for this object.
ConfigurationEvent.Builder	sessionState(SessionState sessionState) Sets the value of the SessionState property for this object.
ConfigurationEvent.Builder	welcomeMessages(Collection<Message> welcomeMessages) A list of messages to send to the user.
ConfigurationEvent.Builder	welcomeMessages(Consumer<Message.Builder>... welcomeMessages) A list of messages to send to the user.
ConfigurationEvent.Builder	welcomeMessages(Message... welcomeMessages) A list of messages to send to the user.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

requestAttributes

ConfigurationEvent.Builder requestAttributes(Map<String,String> requestAttributes)

Request-specific information passed between the client application and Amazon Lex.

The namespace x-amz-lex: is reserved for special attributes. Don't create any request attributes for prefix x-amz-lex:.

Parameters:

requestAttributes - Request-specific information passed between the client application and Amazon Lex.

The namespace x-amz-lex: is reserved for special attributes. Don't create any request attributes for prefix x-amz-lex:.

Returns:

Returns a reference to this object so that method calls can be chained together.

responseContentType

ConfigurationEvent.Builder responseContentType(String responseContentType)

The message that Amazon Lex 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 returns text in the response.

• If the value begins with audio/, Amazon Lex returns speech in the response. Amazon Lex 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 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

Parameters:

responseContentType - The message that Amazon Lex 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 returns text in the response.

• If the value begins with audio/, Amazon Lex returns speech in the response. Amazon Lex 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 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:

Returns a reference to this object so that method calls can be chained together.

sessionState

ConfigurationEvent.Builder sessionState(SessionState sessionState)

Sets the value of the SessionState property for this object.

Parameters:

sessionState - The new value for the SessionState property for this object.

Returns:

Returns a reference to this object so that method calls can be chained together.

sessionState

default ConfigurationEvent.Builder sessionState(Consumer<SessionState.Builder> sessionState)

Sets the value of the SessionState property for this object. This is a convenience that creates an instance of the SessionState.Builder avoiding the need to create one manually via SessionState.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sessionState(SessionState).

Parameters:

sessionState - a consumer that will call methods on SessionState.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

sessionState(SessionState)

welcomeMessages

ConfigurationEvent.Builder welcomeMessages(Collection<Message> welcomeMessages)

A list of messages to send to the user.

Parameters:

welcomeMessages - A list of messages to send to the user.

Returns:

Returns a reference to this object so that method calls can be chained together.

welcomeMessages

ConfigurationEvent.Builder welcomeMessages(Message... welcomeMessages)

A list of messages to send to the user.

Parameters:

welcomeMessages - A list of messages to send to the user.

Returns:

Returns a reference to this object so that method calls can be chained together.

welcomeMessages

ConfigurationEvent.Builder welcomeMessages(Consumer<Message.Builder>... welcomeMessages)

A list of messages to send to the user.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #welcomeMessages(List).

Parameters:

welcomeMessages - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#welcomeMessages(List)

disablePlayback

ConfigurationEvent.Builder disablePlayback(Boolean disablePlayback)

Determines whether Amazon Lex should send audio responses to the client application. When this parameter if false, the client application needs to create responses for the user.

Parameters:

disablePlayback - Determines whether Amazon Lex should send audio responses to the client application. When this parameter if false, the client application needs to create responses for the user.

Returns:

Returns a reference to this object so that method calls can be chained together.

eventId

ConfigurationEvent.Builder eventId(String eventId)

A unique identifier that your application assigns to the event. You can use this to identify events in logs.

Parameters:

eventId - A unique identifier that your application assigns to the event. You can use this to identify events in logs.

Returns:

Returns a reference to this object so that method calls can be chained together.

clientTimestampMillis

ConfigurationEvent.Builder clientTimestampMillis(Long clientTimestampMillis)

A timestamp set by the client of the date and time that the event was sent to Amazon Lex.

Parameters:

clientTimestampMillis - A timestamp set by the client of the date and time that the event was sent to Amazon Lex.

Returns:

Returns a reference to this object so that method calls can be chained together.