com.amazonaws.services.lexruntime.model

Class PostTextRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.lexruntime.model.PostTextRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PostTextRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
PostTextRequest()

Method Summary

Modifier and Type	Method and Description
PostTextRequest	addSessionAttributesEntry(String key, String value)
PostTextRequest	clearSessionAttributesEntries() Removes all the entries added into SessionAttributes.
PostTextRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getBotAlias() Alias of the Amazon Lex bot.
String	getBotName() Name of the Amazon Lex bot.
String	getInputText() Text user entered (Amazon Lex interprets this text).
Map<String,String>	getSessionAttributes() A session represents the dialog between a user and Amazon Lex.
String	getUserId() User ID of your client application.
int	hashCode()
void	setBotAlias(String botAlias) Alias of the Amazon Lex bot.
void	setBotName(String botName) Name of the Amazon Lex bot.
void	setInputText(String inputText) Text user entered (Amazon Lex interprets this text).
void	setSessionAttributes(Map<String,String> sessionAttributes) A session represents the dialog between a user and Amazon Lex.
void	setUserId(String userId) User ID of your client application.
String	toString() Returns a string representation of this object; useful for testing and debugging.
PostTextRequest	withBotAlias(String botAlias) Alias of the Amazon Lex bot.
PostTextRequest	withBotName(String botName) Name of the Amazon Lex bot.
PostTextRequest	withInputText(String inputText) Text user entered (Amazon Lex interprets this text).
PostTextRequest	withSessionAttributes(Map<String,String> sessionAttributes) A session represents the dialog between a user and Amazon Lex.
PostTextRequest	withUserId(String userId) User ID of your client application.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PostTextRequest

public PostTextRequest()

Method Detail

setBotName

public void setBotName(String botName)

Name of the Amazon Lex bot.

Parameters:

botName - Name of the Amazon Lex bot.

getBotName

public String getBotName()

Name of the Amazon Lex bot.

Returns:

Name of the Amazon Lex bot.

withBotName

public PostTextRequest withBotName(String botName)

Name of the Amazon Lex bot.

Parameters:

botName - Name of the Amazon Lex bot.

Returns:

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

setBotAlias

public void setBotAlias(String botAlias)

Alias of the Amazon Lex bot.

Parameters:

botAlias - Alias of the Amazon Lex bot.

getBotAlias

public String getBotAlias()

Alias of the Amazon Lex bot.

Returns:

Alias of the Amazon Lex bot.

withBotAlias

public PostTextRequest withBotAlias(String botAlias)

Alias of the Amazon Lex bot.

Parameters:

botAlias - Alias of the Amazon Lex bot.

Returns:

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

setUserId

public void setUserId(String userId)

User ID of your client application. Typically, each of your application users should have a unique ID. Note the following considerations:

• If you want a user to start a conversation on one mobile device and continue the conversation on another device, you might choose a user-specific identifier, such as a login or Amazon Cognito user ID (assuming your application is using Amazon Cognito).

• If you want the same user to be able to have two independent conversations on two different devices, you might choose a device-specific identifier, such as device ID, or some globally unique identifier.

Parameters:

userId - User ID of your client application. Typically, each of your application users should have a unique ID. Note the following considerations:

• If you want a user to start a conversation on one mobile device and continue the conversation on another device, you might choose a user-specific identifier, such as a login or Amazon Cognito user ID (assuming your application is using Amazon Cognito).

• If you want the same user to be able to have two independent conversations on two different devices, you might choose a device-specific identifier, such as device ID, or some globally unique identifier.

getUserId

public String getUserId()

User ID of your client application. Typically, each of your application users should have a unique ID. Note the following considerations:

• If you want a user to start a conversation on one mobile device and continue the conversation on another device, you might choose a user-specific identifier, such as a login or Amazon Cognito user ID (assuming your application is using Amazon Cognito).

• If you want the same user to be able to have two independent conversations on two different devices, you might choose a device-specific identifier, such as device ID, or some globally unique identifier.

Returns:

User ID of your client application. Typically, each of your application users should have a unique ID. Note the following considerations:

• If you want a user to start a conversation on one mobile device and continue the conversation on another device, you might choose a user-specific identifier, such as a login or Amazon Cognito user ID (assuming your application is using Amazon Cognito).

• If you want the same user to be able to have two independent conversations on two different devices, you might choose a device-specific identifier, such as device ID, or some globally unique identifier.

withUserId

public PostTextRequest withUserId(String userId)

User ID of your client application. Typically, each of your application users should have a unique ID. Note the following considerations:

• If you want a user to start a conversation on one mobile device and continue the conversation on another device, you might choose a user-specific identifier, such as a login or Amazon Cognito user ID (assuming your application is using Amazon Cognito).

• If you want the same user to be able to have two independent conversations on two different devices, you might choose a device-specific identifier, such as device ID, or some globally unique identifier.

Parameters:

userId - User ID of your client application. Typically, each of your application users should have a unique ID. Note the following considerations:

• If you want a user to start a conversation on one mobile device and continue the conversation on another device, you might choose a user-specific identifier, such as a login or Amazon Cognito user ID (assuming your application is using Amazon Cognito).

• If you want the same user to be able to have two independent conversations on two different devices, you might choose a device-specific identifier, such as device ID, or some globally unique identifier.

Returns:

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

getSessionAttributes

public Map<String,String> getSessionAttributes()

A session represents the dialog between a user and Amazon Lex. At runtime, a client application can pass contextual information (session attributes) in the request. For example, "FirstName" : "Joe". Amazon Lex passes these session attributes to the AWS Lambda functions configured for the intent (see dialogCodeHook and fulfillmentActivity.codeHook in CreateIntent).

In your Lambda function, you can use the session attributes for customization. Some examples are:

• In a pizza ordering application, if you can pass user location as a session attribute (for example, "Location" : "111 Maple street"), your Lambda function might use this information to determine the closest pizzeria to place the order.

• Use session attributes to personalize prompts. For example, you pass in user name as a session attribute ( "FirstName" : "Joe"), you might configure subsequent prompts to refer to this attribute, as $session.FirstName". At runtime, Amazon Lex substitutes a real value when it generates a prompt, such as "Hello Joe, what would you like to order?"

Amazon Lex does not persist session attributes.

If the intent is configured without a Lambda function to process the intent (that is, the client application to process the intent), Amazon Lex simply returns the session attributes back to the client application.

If the intent is configured with a Lambda function to process the intent, Amazon Lex passes the incoming session attributes to the Lambda function. The Lambda function must return these session attributes if you want Amazon Lex to return them back to the client.

Returns:

A session represents the dialog between a user and Amazon Lex. At runtime, a client application can pass contextual information (session attributes) in the request. For example, "FirstName" : "Joe" . Amazon Lex passes these session attributes to the AWS Lambda functions configured for the intent (see dialogCodeHook and fulfillmentActivity.codeHook in CreateIntent).

In your Lambda function, you can use the session attributes for customization. Some examples are:

• In a pizza ordering application, if you can pass user location as a session attribute (for example, "Location" : "111 Maple street"), your Lambda function might use this information to determine the closest pizzeria to place the order.

• Use session attributes to personalize prompts. For example, you pass in user name as a session attribute ("FirstName" : "Joe"), you might configure subsequent prompts to refer to this attribute, as $session.FirstName". At runtime, Amazon Lex substitutes a real value when it generates a prompt, such as "Hello Joe, what would you like to order?"

Amazon Lex does not persist session attributes.

If the intent is configured without a Lambda function to process the intent (that is, the client application to process the intent), Amazon Lex simply returns the session attributes back to the client application.

If the intent is configured with a Lambda function to process the intent, Amazon Lex passes the incoming session attributes to the Lambda function. The Lambda function must return these session attributes if you want Amazon Lex to return them back to the client.

setSessionAttributes

public void setSessionAttributes(Map<String,String> sessionAttributes)

A session represents the dialog between a user and Amazon Lex. At runtime, a client application can pass contextual information (session attributes) in the request. For example, "FirstName" : "Joe". Amazon Lex passes these session attributes to the AWS Lambda functions configured for the intent (see dialogCodeHook and fulfillmentActivity.codeHook in CreateIntent).

In your Lambda function, you can use the session attributes for customization. Some examples are:

• In a pizza ordering application, if you can pass user location as a session attribute (for example, "Location" : "111 Maple street"), your Lambda function might use this information to determine the closest pizzeria to place the order.

• Use session attributes to personalize prompts. For example, you pass in user name as a session attribute ( "FirstName" : "Joe"), you might configure subsequent prompts to refer to this attribute, as $session.FirstName". At runtime, Amazon Lex substitutes a real value when it generates a prompt, such as "Hello Joe, what would you like to order?"

Amazon Lex does not persist session attributes.

If the intent is configured without a Lambda function to process the intent (that is, the client application to process the intent), Amazon Lex simply returns the session attributes back to the client application.

If the intent is configured with a Lambda function to process the intent, Amazon Lex passes the incoming session attributes to the Lambda function. The Lambda function must return these session attributes if you want Amazon Lex to return them back to the client.

Parameters:

sessionAttributes - A session represents the dialog between a user and Amazon Lex. At runtime, a client application can pass contextual information (session attributes) in the request. For example, "FirstName" : "Joe". Amazon Lex passes these session attributes to the AWS Lambda functions configured for the intent (see dialogCodeHook and fulfillmentActivity.codeHook in CreateIntent).

In your Lambda function, you can use the session attributes for customization. Some examples are:

• In a pizza ordering application, if you can pass user location as a session attribute (for example, "Location" : "111 Maple street"), your Lambda function might use this information to determine the closest pizzeria to place the order.

• Use session attributes to personalize prompts. For example, you pass in user name as a session attribute ( "FirstName" : "Joe"), you might configure subsequent prompts to refer to this attribute, as $session.FirstName". At runtime, Amazon Lex substitutes a real value when it generates a prompt, such as "Hello Joe, what would you like to order?"

Amazon Lex does not persist session attributes.

If the intent is configured without a Lambda function to process the intent (that is, the client application to process the intent), Amazon Lex simply returns the session attributes back to the client application.

If the intent is configured with a Lambda function to process the intent, Amazon Lex passes the incoming session attributes to the Lambda function. The Lambda function must return these session attributes if you want Amazon Lex to return them back to the client.

withSessionAttributes

public PostTextRequest withSessionAttributes(Map<String,String> sessionAttributes)

A session represents the dialog between a user and Amazon Lex. At runtime, a client application can pass contextual information (session attributes) in the request. For example, "FirstName" : "Joe". Amazon Lex passes these session attributes to the AWS Lambda functions configured for the intent (see dialogCodeHook and fulfillmentActivity.codeHook in CreateIntent).

In your Lambda function, you can use the session attributes for customization. Some examples are:

• In a pizza ordering application, if you can pass user location as a session attribute (for example, "Location" : "111 Maple street"), your Lambda function might use this information to determine the closest pizzeria to place the order.

• Use session attributes to personalize prompts. For example, you pass in user name as a session attribute ( "FirstName" : "Joe"), you might configure subsequent prompts to refer to this attribute, as $session.FirstName". At runtime, Amazon Lex substitutes a real value when it generates a prompt, such as "Hello Joe, what would you like to order?"

Amazon Lex does not persist session attributes.

If the intent is configured without a Lambda function to process the intent (that is, the client application to process the intent), Amazon Lex simply returns the session attributes back to the client application.

If the intent is configured with a Lambda function to process the intent, Amazon Lex passes the incoming session attributes to the Lambda function. The Lambda function must return these session attributes if you want Amazon Lex to return them back to the client.

Parameters:

sessionAttributes - A session represents the dialog between a user and Amazon Lex. At runtime, a client application can pass contextual information (session attributes) in the request. For example, "FirstName" : "Joe". Amazon Lex passes these session attributes to the AWS Lambda functions configured for the intent (see dialogCodeHook and fulfillmentActivity.codeHook in CreateIntent).

In your Lambda function, you can use the session attributes for customization. Some examples are:

• In a pizza ordering application, if you can pass user location as a session attribute (for example, "Location" : "111 Maple street"), your Lambda function might use this information to determine the closest pizzeria to place the order.

• Use session attributes to personalize prompts. For example, you pass in user name as a session attribute ( "FirstName" : "Joe"), you might configure subsequent prompts to refer to this attribute, as $session.FirstName". At runtime, Amazon Lex substitutes a real value when it generates a prompt, such as "Hello Joe, what would you like to order?"

Amazon Lex does not persist session attributes.

If the intent is configured without a Lambda function to process the intent (that is, the client application to process the intent), Amazon Lex simply returns the session attributes back to the client application.

If the intent is configured with a Lambda function to process the intent, Amazon Lex passes the incoming session attributes to the Lambda function. The Lambda function must return these session attributes if you want Amazon Lex to return them back to the client.

Returns:

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

addSessionAttributesEntry

public PostTextRequest addSessionAttributesEntry(String key,
                                                 String value)

clearSessionAttributesEntries

public PostTextRequest clearSessionAttributesEntries()

Removes all the entries added into SessionAttributes.

Returns:

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

setInputText

public void setInputText(String inputText)

Text user entered (Amazon Lex interprets this text).

Parameters:

inputText - Text user entered (Amazon Lex interprets this text).

getInputText

public String getInputText()

Text user entered (Amazon Lex interprets this text).

Returns:

Text user entered (Amazon Lex interprets this text).

withInputText

public PostTextRequest withInputText(String inputText)

Text user entered (Amazon Lex interprets this text).

Parameters:

inputText - Text user entered (Amazon Lex interprets this text).

Returns:

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

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public PostTextRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()