PostTextRequest (AWS Java SDK :: Services :: Amazon Lex Runtime 2.20.156 API)

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

Nested Classes
Modifier and Type	Class and Description
`static interface`	`PostTextRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<ActiveContext>`	`activeContexts()` A list of contexts active for the request.
`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)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasActiveContexts()` For responses, this returns true if the service returned a value for the ActiveContexts property.
`int`	`hashCode()`
`boolean`	`hasRequestAttributes()` For responses, this returns true if the service returned a value for the RequestAttributes property.
`boolean`	`hasSessionAttributes()` For responses, this returns true if the service returned a value for the SessionAttributes property.
`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()`
`String`	`toString()` Returns a string representation of this object.
`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
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - botName
```
public final String botName()
```
    The name of the Amazon Lex bot.
    
    Returns:
    
    The name of the Amazon Lex bot.
  - botAlias
```
public final String botAlias()
```
    The alias of the Amazon Lex bot.
    
    Returns:
    
    The alias of the Amazon Lex bot.
  - userId
```
public final 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.
  - hasSessionAttributes
```
public final boolean hasSessionAttributes()
```
    For responses, this returns true if the service returned a value for the SessionAttributes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - sessionAttributes
```
public final 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.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSessionAttributes() method.
    
    Returns:
    
    Application-specific information passed between Amazon Lex and a client application.
    
    For more information, see Setting Session Attributes.
  - hasRequestAttributes
```
public final boolean hasRequestAttributes()
```
    For responses, this returns true if the service returned a value for the RequestAttributes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - requestAttributes
```
public final 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.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRequestAttributes() method.
    
    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 final 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).
  - hasActiveContexts
```
public final boolean hasActiveContexts()
```
    For responses, this returns true if the service returned a value for the ActiveContexts property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - activeContexts
```
public final List<ActiveContext> activeContexts()
```
    A list of contexts active for the request. A context can be activated when a previous intent is fulfilled, or by including the context in the request,
    
    If you don't specify a list of contexts, Amazon Lex will use the current list of contexts for the session. If you specify an empty list, all contexts for the session are cleared.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasActiveContexts() method.
    
    Returns:
    
    A list of contexts active for the request. A context can be activated when a previous intent is fulfilled, or by including the context in the request,
    
    If you don't specify a list of contexts, Amazon Lex will use the current list of contexts for the session. If you specify an empty list, all contexts for the session are cleared.
  - toBuilder
```
public PostTextRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<PostTextRequest.Builder,PostTextRequest>
    
    Specified by:
    
    toBuilder in class LexRuntimeRequest
  - builder
```
public static PostTextRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends PostTextRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class PostTextRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

botName

botAlias

userId

hasSessionAttributes

sessionAttributes

hasRequestAttributes

requestAttributes

inputText

hasActiveContexts

activeContexts

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields