software.amazon.awssdk.services.lexruntime.model

Class PostTextRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.lexruntime.model.LexRuntimeRequest

software.amazon.awssdk.services.lexruntime.model.PostTextRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<PostTextRequest.Builder,PostTextRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class PostTextRequest
extends LexRuntimeRequest
implements ToCopyableBuilder<PostTextRequest.Builder,PostTextRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PostTextRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	botAlias() The alias of the Amazon Lex bot.
String	botName() The name of the Amazon Lex bot.
static PostTextRequest.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
String	inputText() The text that the user entered (Amazon Lex interprets this text).
Map<String,String>	requestAttributes() Request-specific information passed between Amazon Lex and a client application.
List<SdkField<?>>	sdkFields()
static Class<? extends PostTextRequest.Builder>	serializableBuilderClass()
Map<String,String>	sessionAttributes() Application-specific information passed between Amazon Lex and a client application.
PostTextRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	userId() The ID of the client application user.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

botName

public String botName()

The name of the Amazon Lex bot.

Returns:

The name of the Amazon Lex bot.

botAlias

public String botAlias()

The alias of the Amazon Lex bot.

Returns:

The alias of the Amazon Lex bot.

userId

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

Returns:

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.

sessionAttributes

public Map<String,String> sessionAttributes()

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

For more information, see Setting Session Attributes.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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

For more information, see Setting Session Attributes.

requestAttributes

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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.

inputText

public String inputText()

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

Returns:

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

toBuilder

public PostTextRequest.Builder 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 interface ToCopyableBuilder<PostTextRequest.Builder,PostTextRequest>

Specified by:

toBuilder in class LexRuntimeRequest

Returns:

a builder for type T

builder

public static PostTextRequest.Builder builder()

serializableBuilderClass

public static Class<? extends PostTextRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.