software.amazon.awssdk.services.lexruntime.model

Interface PostTextRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<PostTextRequest.Builder,PostTextRequest>, LexRuntimeRequest.Builder, SdkBuilder<PostTextRequest.Builder,PostTextRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

PostTextRequest

public static interface PostTextRequest.Builder
extends LexRuntimeRequest.Builder, SdkPojo, CopyableBuilder<PostTextRequest.Builder,PostTextRequest>

Method Summary

Modifier and Type	Method and Description
PostTextRequest.Builder	botAlias(String botAlias) The alias of the Amazon Lex bot.
PostTextRequest.Builder	botName(String botName) The name of the Amazon Lex bot.
PostTextRequest.Builder	inputText(String inputText) The text that the user entered (Amazon Lex interprets this text).
PostTextRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
PostTextRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
PostTextRequest.Builder	requestAttributes(Map<String,String> requestAttributes) Request-specific information passed between Amazon Lex and a client application.
PostTextRequest.Builder	sessionAttributes(Map<String,String> sessionAttributes) Application-specific information passed between Amazon Lex and a client application.
PostTextRequest.Builder	userId(String userId) The ID of the client application user.

Methods inherited from interface software.amazon.awssdk.services.lexruntime.model.LexRuntimeRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

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

botName

PostTextRequest.Builder botName(String botName)

The name of the Amazon Lex bot.

Parameters:

botName - The name of the Amazon Lex bot.

Returns:

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

botAlias

PostTextRequest.Builder botAlias(String botAlias)

The alias of the Amazon Lex bot.

Parameters:

botAlias - The alias of the Amazon Lex bot.

Returns:

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

userId

PostTextRequest.Builder userId(String userId)

The ID of the client application user. Amazon Lex uses this to identify a user's conversation with your bot. At runtime, each request must contain the userID field.

To decide the user ID to use for your application, consider the following factors.

• The userID field must not contain any personally identifiable information of the user, for example, name, personal identification numbers, or other end user personal information.

• If you want a user to start a conversation on one device and continue on another device, use a user-specific identifier.

• If you want the same user to be able to have two independent conversations on two different devices, choose a device-specific identifier.

• A user can't have two independent conversations with two different versions of the same bot. For example, a user can't have a conversation with the PROD and BETA versions of the same bot. If you anticipate that a user will need to have conversation with two different versions, for example, while testing, include the bot alias in the user ID to separate the two conversations.

Parameters:

userId - The ID of the client application user. Amazon Lex uses this to identify a user's conversation with your bot. At runtime, each request must contain the userID field.

To decide the user ID to use for your application, consider the following factors.

• The userID field must not contain any personally identifiable information of the user, for example, name, personal identification numbers, or other end user personal information.

• If you want a user to start a conversation on one device and continue on another device, use a user-specific identifier.

• If you want the same user to be able to have two independent conversations on two different devices, choose a device-specific identifier.

• A user can't have two independent conversations with two different versions of the same bot. For example, a user can't have a conversation with the PROD and BETA versions of the same bot. If you anticipate that a user will need to have conversation with two different versions, for example, while testing, include the bot alias in the user ID to separate the two conversations.

Returns:

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

sessionAttributes

PostTextRequest.Builder sessionAttributes(Map<String,String> sessionAttributes)

Application-specific information passed between Amazon Lex and a client application.

For more information, see Setting Session Attributes.

Parameters:

sessionAttributes - Application-specific information passed between Amazon Lex and a client application.

For more information, see Setting Session Attributes.

Returns:

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

requestAttributes

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

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

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

For more information, see Setting Request Attributes.

Parameters:

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

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

For more information, see Setting Request Attributes.

Returns:

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

inputText

PostTextRequest.Builder inputText(String inputText)

The text that the user entered (Amazon Lex interprets this text).

Parameters:

inputText - The text that the user entered (Amazon Lex interprets this text).

Returns:

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

overrideConfiguration

PostTextRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

PostTextRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.