PostContentResponse (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.core.SdkResponse
- - software.amazon.awssdk.awscore.AwsResponse
  - - software.amazon.awssdk.services.lexruntime.model.LexRuntimeResponse
    - - software.amazon.awssdk.services.lexruntime.model.PostContentResponse

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<PostContentResponse.Builder,PostContentResponse>

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface PostContentResponse.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static PostContentResponse.Builder`	`builder()`
`String`	`contentType()` Content type as specified in the `Accept` HTTP header in the request.
`DialogState`	`dialogState()` Identifies the current state of the user interaction.
`String`	`dialogStateAsString()` Identifies the current state of the user interaction.
`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 `SdkResponse`.
`int`	`hashCode()`
`String`	`inputTranscript()` The text used to process the request.
`String`	`intentName()` Current user intent that Amazon Lex is aware of.
`String`	`message()` The message to convey to the user.
`MessageFormatType`	`messageFormat()` The format of the response message.
`String`	`messageFormatAsString()` The format of the response message.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends PostContentResponse.Builder>`	`serializableBuilderClass()`
`String`	`sessionAttributes()` Map of key/value pairs representing the session-specific context information.
`String`	`slots()` Map of zero or more intent slots (name/value pairs) Amazon Lex detected from the user input during the conversation.
`String`	`slotToElicit()` If the `dialogState` value is `ElicitSlot`, returns the name of the slot for which Amazon Lex is eliciting a value.
`PostContentResponse.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`

Methods inherited from class software.amazon.awssdk.services.lexruntime.model.LexRuntimeResponse
responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse

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
  - contentType
```
public String contentType()
```
    Content type as specified in the Accept HTTP header in the request.
    
    Returns:
    
    Content type as specified in the Accept HTTP header in the request.
  - intentName
```
public String intentName()
```
    Current user intent that Amazon Lex is aware of.
    
    Returns:
    
    Current user intent that Amazon Lex is aware of.
  - slots
```
public String slots()
```
    Map of zero or more intent slots (name/value pairs) Amazon Lex detected from the user input during the conversation.
    
    Amazon Lex creates a resolution list containing likely values for a slot. The value that it returns is determined by the valueSelectionStrategy selected when the slot type was created or updated. If valueSelectionStrategy is set to ORIGINAL_VALUE, the value provided by the user is returned, if the user value is similar to the slot values. If valueSelectionStrategy is set to TOP_RESOLUTION Amazon Lex returns the first value in the resolution list or, if there is no resolution list, null. If you don't specify a valueSelectionStrategy, the default is ORIGINAL_VALUE.
    
    Returns:
    
    Map of zero or more intent slots (name/value pairs) Amazon Lex detected from the user input during the conversation.
    
    Amazon Lex creates a resolution list containing likely values for a slot. The value that it returns is determined by the valueSelectionStrategy selected when the slot type was created or updated. If valueSelectionStrategy is set to ORIGINAL_VALUE, the value provided by the user is returned, if the user value is similar to the slot values. If valueSelectionStrategy is set to TOP_RESOLUTION Amazon Lex returns the first value in the resolution list or, if there is no resolution list, null. If you don't specify a valueSelectionStrategy, the default is ORIGINAL_VALUE.
  - sessionAttributes
```
public String sessionAttributes()
```
    Map of key/value pairs representing the session-specific context information.
    
    Returns:
    
    Map of key/value pairs representing the session-specific context information.
  - message
```
public String message()
```
    The message to convey to the user. The message can come from the bot's configuration or from a Lambda function.
    
    If the intent is not configured with a Lambda function, or if the Lambda function returned Delegate as the dialogAction.type its response, Amazon Lex decides on the next course of action and selects an appropriate message from the bot's configuration based on the current interaction context. For example, if Amazon Lex isn't able to understand user input, it uses a clarification prompt message.
    
    When you create an intent you can assign messages to groups. When messages are assigned to groups Amazon Lex returns one message from each group in the response. The message field is an escaped JSON string containing the messages. For more information about the structure of the JSON string returned, see msg-prompts-formats.
    
    If the Lambda function returns a message, Amazon Lex passes it to the client in its response.
    
    Returns:
    
    The message to convey to the user. The message can come from the bot's configuration or from a Lambda function.
    
    If the intent is not configured with a Lambda function, or if the Lambda function returned Delegate as the dialogAction.type its response, Amazon Lex decides on the next course of action and selects an appropriate message from the bot's configuration based on the current interaction context. For example, if Amazon Lex isn't able to understand user input, it uses a clarification prompt message.
    
    When you create an intent you can assign messages to groups. When messages are assigned to groups Amazon Lex returns one message from each group in the response. The message field is an escaped JSON string containing the messages. For more information about the structure of the JSON string returned, see msg-prompts-formats.
    
    If the Lambda function returns a message, Amazon Lex passes it to the client in its response.
  - messageFormat
```
public MessageFormatType messageFormat()
```
    The format of the response message. One of the following values:
    - PlainText - The message contains plain UTF-8 text.
    - CustomPayload - The message is a custom format for the client.
    - SSML - The message contains text formatted for voice output.
    - Composite - The message contains an escaped JSON object containing one or more messages from the groups that messages were assigned to when the intent was created.
    If the service returns an enum value that is not available in the current SDK version, messageFormat will return MessageFormatType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from messageFormatAsString().
    Returns:
    The format of the response message. One of the following values:
    
    PlainText - The message contains plain UTF-8 text.
    
    CustomPayload - The message is a custom format for the client.
    
    SSML - The message contains text formatted for voice output.
    
    Composite - The message contains an escaped JSON object containing one or more messages from the groups that messages were assigned to when the intent was created.
    See Also:
    
    MessageFormatType
  - messageFormatAsString
```
public String messageFormatAsString()
```
    The format of the response message. One of the following values:
    - PlainText - The message contains plain UTF-8 text.
    - CustomPayload - The message is a custom format for the client.
    - SSML - The message contains text formatted for voice output.
    - Composite - The message contains an escaped JSON object containing one or more messages from the groups that messages were assigned to when the intent was created.
    If the service returns an enum value that is not available in the current SDK version, messageFormat will return MessageFormatType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from messageFormatAsString().
    Returns:
    The format of the response message. One of the following values:
    
    PlainText - The message contains plain UTF-8 text.
    
    CustomPayload - The message is a custom format for the client.
    
    SSML - The message contains text formatted for voice output.
    
    Composite - The message contains an escaped JSON object containing one or more messages from the groups that messages were assigned to when the intent was created.
    See Also:
    
    MessageFormatType
  - dialogState
```
public DialogState dialogState()
```
    Identifies the current state of the user interaction. Amazon Lex returns one of the following values as dialogState. The client can optionally use this information to customize the user interface.
    - ElicitIntent - Amazon Lex wants to elicit the user's intent. Consider the following examples:
      
      For example, a user might utter an intent ("I want to order a pizza"). If Amazon Lex cannot infer the user intent from this utterance, it will return this dialog state.
    - ConfirmIntent - Amazon Lex is expecting a "yes" or "no" response.
      
      For example, Amazon Lex wants user confirmation before fulfilling an intent. Instead of a simple "yes" or "no" response, a user might respond with additional information. For example, "yes, but make it a thick crust pizza" or "no, I want to order a drink." Amazon Lex can process such additional information (in these examples, update the crust type slot or change the intent from OrderPizza to OrderDrink).
    - ElicitSlot - Amazon Lex is expecting the value of a slot for the current intent.
      
      For example, suppose that in the response Amazon Lex sends this message: "What size pizza would you like?". A user might reply with the slot value (e.g., "medium"). The user might also provide additional information in the response (e.g., "medium thick crust pizza"). Amazon Lex can process such additional information appropriately.
    - Fulfilled - Conveys that the Lambda function has successfully fulfilled the intent.
    - ReadyForFulfillment - Conveys that the client has to fulfill the request.
    - Failed - Conveys that the conversation with the user failed.
      
      This can happen for various reasons, including that the user does not provide an appropriate response to prompts from the service (you can configure how many times Amazon Lex can prompt a user for specific information), or if the Lambda function fails to fulfill the intent.
    If the service returns an enum value that is not available in the current SDK version, dialogState will return DialogState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dialogStateAsString().
    Returns:
    Identifies the current state of the user interaction. Amazon Lex returns one of the following values as dialogState. The client can optionally use this information to customize the user interface.
    
    ElicitIntent - Amazon Lex wants to elicit the user's intent. Consider the following examples:
    
    For example, a user might utter an intent ("I want to order a pizza"). If Amazon Lex cannot infer the user intent from this utterance, it will return this dialog state.
    
    ConfirmIntent - Amazon Lex is expecting a "yes" or "no" response.
    
    For example, Amazon Lex wants user confirmation before fulfilling an intent. Instead of a simple "yes" or "no" response, a user might respond with additional information. For example, "yes, but make it a thick crust pizza" or "no, I want to order a drink." Amazon Lex can process such additional information (in these examples, update the crust type slot or change the intent from OrderPizza to OrderDrink).
    
    ElicitSlot - Amazon Lex is expecting the value of a slot for the current intent.
    
    For example, suppose that in the response Amazon Lex sends this message: "What size pizza would you like?". A user might reply with the slot value (e.g., "medium"). The user might also provide additional information in the response (e.g., "medium thick crust pizza"). Amazon Lex can process such additional information appropriately.
    
    Fulfilled - Conveys that the Lambda function has successfully fulfilled the intent.
    
    ReadyForFulfillment - Conveys that the client has to fulfill the request.
    
    Failed - Conveys that the conversation with the user failed.
    
    This can happen for various reasons, including that the user does not provide an appropriate response to prompts from the service (you can configure how many times Amazon Lex can prompt a user for specific information), or if the Lambda function fails to fulfill the intent.
    See Also:
    
    DialogState
  - dialogStateAsString
```
public String dialogStateAsString()
```
    Identifies the current state of the user interaction. Amazon Lex returns one of the following values as dialogState. The client can optionally use this information to customize the user interface.
    - ElicitIntent - Amazon Lex wants to elicit the user's intent. Consider the following examples:
      
      For example, a user might utter an intent ("I want to order a pizza"). If Amazon Lex cannot infer the user intent from this utterance, it will return this dialog state.
    - ConfirmIntent - Amazon Lex is expecting a "yes" or "no" response.
      
      For example, Amazon Lex wants user confirmation before fulfilling an intent. Instead of a simple "yes" or "no" response, a user might respond with additional information. For example, "yes, but make it a thick crust pizza" or "no, I want to order a drink." Amazon Lex can process such additional information (in these examples, update the crust type slot or change the intent from OrderPizza to OrderDrink).
    - ElicitSlot - Amazon Lex is expecting the value of a slot for the current intent.
      
      For example, suppose that in the response Amazon Lex sends this message: "What size pizza would you like?". A user might reply with the slot value (e.g., "medium"). The user might also provide additional information in the response (e.g., "medium thick crust pizza"). Amazon Lex can process such additional information appropriately.
    - Fulfilled - Conveys that the Lambda function has successfully fulfilled the intent.
    - ReadyForFulfillment - Conveys that the client has to fulfill the request.
    - Failed - Conveys that the conversation with the user failed.
      
      This can happen for various reasons, including that the user does not provide an appropriate response to prompts from the service (you can configure how many times Amazon Lex can prompt a user for specific information), or if the Lambda function fails to fulfill the intent.
    If the service returns an enum value that is not available in the current SDK version, dialogState will return DialogState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dialogStateAsString().
    Returns:
    Identifies the current state of the user interaction. Amazon Lex returns one of the following values as dialogState. The client can optionally use this information to customize the user interface.
    
    ElicitIntent - Amazon Lex wants to elicit the user's intent. Consider the following examples:
    
    For example, a user might utter an intent ("I want to order a pizza"). If Amazon Lex cannot infer the user intent from this utterance, it will return this dialog state.
    
    ConfirmIntent - Amazon Lex is expecting a "yes" or "no" response.
    
    For example, Amazon Lex wants user confirmation before fulfilling an intent. Instead of a simple "yes" or "no" response, a user might respond with additional information. For example, "yes, but make it a thick crust pizza" or "no, I want to order a drink." Amazon Lex can process such additional information (in these examples, update the crust type slot or change the intent from OrderPizza to OrderDrink).
    
    ElicitSlot - Amazon Lex is expecting the value of a slot for the current intent.
    
    For example, suppose that in the response Amazon Lex sends this message: "What size pizza would you like?". A user might reply with the slot value (e.g., "medium"). The user might also provide additional information in the response (e.g., "medium thick crust pizza"). Amazon Lex can process such additional information appropriately.
    
    Fulfilled - Conveys that the Lambda function has successfully fulfilled the intent.
    
    ReadyForFulfillment - Conveys that the client has to fulfill the request.
    
    Failed - Conveys that the conversation with the user failed.
    
    This can happen for various reasons, including that the user does not provide an appropriate response to prompts from the service (you can configure how many times Amazon Lex can prompt a user for specific information), or if the Lambda function fails to fulfill the intent.
    See Also:
    
    DialogState
  - slotToElicit
```
public String slotToElicit()
```
    If the dialogState value is ElicitSlot, returns the name of the slot for which Amazon Lex is eliciting a value.
    
    Returns:
    
    If the dialogState value is ElicitSlot, returns the name of the slot for which Amazon Lex is eliciting a value.
  - inputTranscript
```
public String inputTranscript()
```
    The text used to process the request.
    
    If the input was an audio stream, the inputTranscript field contains the text extracted from the audio stream. This is the text that is actually processed to recognize intents and slot values. You can use this information to determine if Amazon Lex is correctly processing the audio that you send.
    
    Returns:
    
    The text used to process the request.
    
    If the input was an audio stream, the inputTranscript field contains the text extracted from the audio stream. This is the text that is actually processed to recognize intents and slot values. You can use this information to determine if Amazon Lex is correctly processing the audio that you send.
  - toBuilder
```
public PostContentResponse.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<PostContentResponse.Builder,PostContentResponse>
    
    Specified by:
    
    toBuilder in class AwsResponse
    
    Returns:
    
    a builder for type T
  - builder
```
public static PostContentResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends PostContentResponse.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: SdkResponse
    
    Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.
    
    Overrides:
    
    getValueForField in class SdkResponse
    
    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.

Class PostContentResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.lexruntime.model.LexRuntimeResponse

Methods inherited from class software.amazon.awssdk.core.SdkResponse

Methods inherited from class java.lang.Object

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

Method Detail

contentType

intentName

slots

sessionAttributes

message

messageFormat

messageFormatAsString

dialogState

dialogStateAsString

slotToElicit

inputTranscript

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields