PostTextRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.lexruntime.model.PostTextRequest

All Implemented Interfaces:: HandlerContextAware, 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()

Constructors
Constructor and Description
`PostTextRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PostTextRequest`	`addRequestAttributesEntry(String key, String value)`
`PostTextRequest`	`addSessionAttributesEntry(String key, String value)`
`PostTextRequest`	`clearRequestAttributesEntries()` Removes all the entries added into RequestAttributes.
`PostTextRequest`	`clearSessionAttributesEntries()` Removes all the entries added into SessionAttributes.
`PostTextRequest`	`clone()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals(Object obj)`
`String`	`getBotAlias()` The alias of the Amazon Lex bot.
`String`	`getBotName()` The name of the Amazon Lex bot.
`String`	`getInputText()` The text that the user entered (Amazon Lex interprets this text).
`Map<String,String>`	`getRequestAttributes()` Request-specific information passed between Amazon Lex and a client application.
`Map<String,String>`	`getSessionAttributes()` Application-specific information passed between Amazon Lex and a client application.
`String`	`getUserId()` The ID of the client application user.
`int`	`hashCode()`
`void`	`setBotAlias(String botAlias)` The alias of the Amazon Lex bot.
`void`	`setBotName(String botName)` The name of the Amazon Lex bot.
`void`	`setInputText(String inputText)` The text that the user entered (Amazon Lex interprets this text).
`void`	`setRequestAttributes(Map<String,String> requestAttributes)` Request-specific information passed between Amazon Lex and a client application.
`void`	`setSessionAttributes(Map<String,String> sessionAttributes)` Application-specific information passed between Amazon Lex and a client application.
`void`	`setUserId(String userId)` The ID of the client application user.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`PostTextRequest`	`withBotAlias(String botAlias)` The alias of the Amazon Lex bot.
`PostTextRequest`	`withBotName(String botName)` The name of the Amazon Lex bot.
`PostTextRequest`	`withInputText(String inputText)` The text that the user entered (Amazon Lex interprets this text).
`PostTextRequest`	`withRequestAttributes(Map<String,String> requestAttributes)` Request-specific information passed between Amazon Lex and a client application.
`PostTextRequest`	`withSessionAttributes(Map<String,String> sessionAttributes)` Application-specific information passed between Amazon Lex and a client application.
`PostTextRequest`	`withUserId(String userId)` The ID of the client application user.

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)
```
    The name of the Amazon Lex bot.
    
    Parameters:
    
    botName - The name of the Amazon Lex bot.
  - getBotName
```
public String getBotName()
```
    The name of the Amazon Lex bot.
    
    Returns:
    
    The name of the Amazon Lex bot.
  - withBotName
```
public PostTextRequest withBotName(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.
  - setBotAlias
```
public void setBotAlias(String botAlias)
```
    The alias of the Amazon Lex bot.
    
    Parameters:
    
    botAlias - The alias of the Amazon Lex bot.
  - getBotAlias
```
public String getBotAlias()
```
    The alias of the Amazon Lex bot.
    
    Returns:
    
    The alias of the Amazon Lex bot.
  - withBotAlias
```
public PostTextRequest withBotAlias(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.
  - setUserId
```
public void setUserId(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.
  - getUserId
```
public String getUserId()
```
    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.
  - withUserId
```
public PostTextRequest withUserId(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.
  - getSessionAttributes
```
public Map<String,String> getSessionAttributes()
```
    Application-specific information passed between Amazon Lex and a client application.
    
    For more information, see Setting Session Attributes.
    
    Returns:
    
    Application-specific information passed between Amazon Lex and a client application.
    
    For more information, see Setting Session Attributes.
  - setSessionAttributes
```
public void setSessionAttributes(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.
  - withSessionAttributes
```
public PostTextRequest withSessionAttributes(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.
  - 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.
  - getRequestAttributes
```
public Map<String,String> getRequestAttributes()
```
    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:
    
    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.
  - setRequestAttributes
```
public void setRequestAttributes(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.
  - withRequestAttributes
```
public PostTextRequest withRequestAttributes(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.
  - addRequestAttributesEntry
```
public PostTextRequest addRequestAttributesEntry(String key,
                                                 String value)
```
  - clearRequestAttributesEntries
```
public PostTextRequest clearRequestAttributesEntries()
```
    Removes all the entries added into RequestAttributes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInputText
```
public void setInputText(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).
  - getInputText
```
public String getInputText()
```
    The text that the user entered (Amazon Lex interprets this text).
    
    Returns:
    
    The text that the user entered (Amazon Lex interprets this text).
  - withInputText
```
public PostTextRequest withInputText(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.
  - 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 object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

Did this page help you?

Class PostTextRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

PostTextRequest

Method Detail

setBotName

getBotName

withBotName

setBotAlias

getBotAlias

withBotAlias

setUserId

getUserId

withUserId

getSessionAttributes

setSessionAttributes

withSessionAttributes

addSessionAttributesEntry

clearSessionAttributesEntries

getRequestAttributes

setRequestAttributes

withRequestAttributes

addRequestAttributesEntry

clearRequestAttributesEntries

setInputText

getInputText

withInputText

toString

equals

hashCode

clone