/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.lexruntime.model; import java.io.Serializable; import javax.annotation.Generated; /** * * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class PutSessionResult extends com.amazonaws.AmazonWebServiceResult implements Serializable, Cloneable { /** *

* Content type as specified in the Accept HTTP header in the request. *

*/ private String contentType; /** *

* The name of the current intent. *

*/ private String intentName; /** *

* Map of zero or more intent slots 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. *

*/ private String slots; /** *

* Map of key/value pairs representing session-specific context information. *

*/ private String sessionAttributes; /** *

* The next message that should be presented to the user. *

*

* You can only use this field in the de-DE, en-AU, en-GB, en-US, es-419, es-ES, es-US, fr-CA, fr-FR, and it-IT * locales. In all other locales, the message field is null. You should use the * encodedMessage field instead. *

*/ @Deprecated private String message; /** *

* The next message that should be presented to the user. *

*

* The encodedMessage field is base-64 encoded. You must decode the field before you can use the value. *

*/ private String encodedMessage; /** *

* The format of the response message. One of the following values: *

* */ private String messageFormat; /** *

*

*/ private String dialogState; /** *

* If the dialogState is ElicitSlot, returns the name of the slot for which Amazon Lex is * eliciting a value. *

*/ private String slotToElicit; /** *

* The audio version of the message to convey to the user. *

*/ private java.io.InputStream audioStream; /** *

* A unique identifier for the session. *

*/ private String sessionId; /** *

* A list of active contexts for the session. *

*/ private String activeContexts; /** *

* Content type as specified in the Accept HTTP header in the request. *

* * @param contentType * Content type as specified in the Accept HTTP header in the request. */ public void setContentType(String contentType) { this.contentType = contentType; } /** *

* Content type as specified in the Accept HTTP header in the request. *

* * @return Content type as specified in the Accept HTTP header in the request. */ public String getContentType() { return this.contentType; } /** *

* Content type as specified in the Accept HTTP header in the request. *

* * @param contentType * Content type as specified in the Accept HTTP header in the request. * @return Returns a reference to this object so that method calls can be chained together. */ public PutSessionResult withContentType(String contentType) { setContentType(contentType); return this; } /** *

* The name of the current intent. *

* * @param intentName * The name of the current intent. */ public void setIntentName(String intentName) { this.intentName = intentName; } /** *

* The name of the current intent. *

* * @return The name of the current intent. */ public String getIntentName() { return this.intentName; } /** *

* The name of the current intent. *

* * @param intentName * The name of the current intent. * @return Returns a reference to this object so that method calls can be chained together. */ public PutSessionResult withIntentName(String intentName) { setIntentName(intentName); return this; } /** *

* Map of zero or more intent slots 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. *

*

* This field's value must be valid JSON according to RFC 7159, including the opening and closing braces. For * example: '{"key": "value"}'. *

*

* The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. * Users of the SDK should not perform Base64 encoding on this field. *

* * @param slots * Map of zero or more intent slots 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. */ public void setSlots(String slots) { this.slots = slots; } /** *

* Map of zero or more intent slots 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. *

*

* This field's value will be valid JSON according to RFC 7159, including the opening and closing braces. For * example: '{"key": "value"}'. *

* * @return Map of zero or more intent slots 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. */ public String getSlots() { return this.slots; } /** *

* Map of zero or more intent slots 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. *

*

* This field's value must be valid JSON according to RFC 7159, including the opening and closing braces. For * example: '{"key": "value"}'. *

*

* The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. * Users of the SDK should not perform Base64 encoding on this field. *

* * @param slots * Map of zero or more intent slots 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. * @return Returns a reference to this object so that method calls can be chained together. */ public PutSessionResult withSlots(String slots) { setSlots(slots); return this; } /** *

* Map of key/value pairs representing session-specific context information. *

*

* This field's value must be valid JSON according to RFC 7159, including the opening and closing braces. For * example: '{"key": "value"}'. *

*

* The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. * Users of the SDK should not perform Base64 encoding on this field. *

* * @param sessionAttributes * Map of key/value pairs representing session-specific context information. */ public void setSessionAttributes(String sessionAttributes) { this.sessionAttributes = sessionAttributes; } /** *

* Map of key/value pairs representing session-specific context information. *

*

* This field's value will be valid JSON according to RFC 7159, including the opening and closing braces. For * example: '{"key": "value"}'. *

* * @return Map of key/value pairs representing session-specific context information. */ public String getSessionAttributes() { return this.sessionAttributes; } /** *

* Map of key/value pairs representing session-specific context information. *

*

* This field's value must be valid JSON according to RFC 7159, including the opening and closing braces. For * example: '{"key": "value"}'. *

*

* The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. * Users of the SDK should not perform Base64 encoding on this field. *

* * @param sessionAttributes * Map of key/value pairs representing session-specific context information. * @return Returns a reference to this object so that method calls can be chained together. */ public PutSessionResult withSessionAttributes(String sessionAttributes) { setSessionAttributes(sessionAttributes); return this; } /** *

* The next message that should be presented to the user. *

*

* You can only use this field in the de-DE, en-AU, en-GB, en-US, es-419, es-ES, es-US, fr-CA, fr-FR, and it-IT * locales. In all other locales, the message field is null. You should use the * encodedMessage field instead. *

* * @param message * The next message that should be presented to the user.

*

* You can only use this field in the de-DE, en-AU, en-GB, en-US, es-419, es-ES, es-US, fr-CA, fr-FR, and * it-IT locales. In all other locales, the message field is null. You should use the * encodedMessage field instead. */ @Deprecated public void setMessage(String message) { this.message = message; } /** *

* The next message that should be presented to the user. *

*

* You can only use this field in the de-DE, en-AU, en-GB, en-US, es-419, es-ES, es-US, fr-CA, fr-FR, and it-IT * locales. In all other locales, the message field is null. You should use the * encodedMessage field instead. *

* * @return The next message that should be presented to the user.

*

* You can only use this field in the de-DE, en-AU, en-GB, en-US, es-419, es-ES, es-US, fr-CA, fr-FR, and * it-IT locales. In all other locales, the message field is null. You should use the * encodedMessage field instead. */ @Deprecated public String getMessage() { return this.message; } /** *

* The next message that should be presented to the user. *

*

* You can only use this field in the de-DE, en-AU, en-GB, en-US, es-419, es-ES, es-US, fr-CA, fr-FR, and it-IT * locales. In all other locales, the message field is null. You should use the * encodedMessage field instead. *

* * @param message * The next message that should be presented to the user.

*

* You can only use this field in the de-DE, en-AU, en-GB, en-US, es-419, es-ES, es-US, fr-CA, fr-FR, and * it-IT locales. In all other locales, the message field is null. You should use the * encodedMessage field instead. * @return Returns a reference to this object so that method calls can be chained together. */ @Deprecated public PutSessionResult withMessage(String message) { setMessage(message); return this; } /** *

* The next message that should be presented to the user. *

*

* The encodedMessage field is base-64 encoded. You must decode the field before you can use the value. *

* * @param encodedMessage * The next message that should be presented to the user.

*

* The encodedMessage field is base-64 encoded. You must decode the field before you can use the * value. */ public void setEncodedMessage(String encodedMessage) { this.encodedMessage = encodedMessage; } /** *

* The next message that should be presented to the user. *

*

* The encodedMessage field is base-64 encoded. You must decode the field before you can use the value. *

* * @return The next message that should be presented to the user.

*

* The encodedMessage field is base-64 encoded. You must decode the field before you can use * the value. */ public String getEncodedMessage() { return this.encodedMessage; } /** *

* The next message that should be presented to the user. *

*

* The encodedMessage field is base-64 encoded. You must decode the field before you can use the value. *

* * @param encodedMessage * The next message that should be presented to the user.

*

* The encodedMessage field is base-64 encoded. You must decode the field before you can use the * value. * @return Returns a reference to this object so that method calls can be chained together. */ public PutSessionResult withEncodedMessage(String encodedMessage) { setEncodedMessage(encodedMessage); return this; } /** *

* The format of the response message. One of the following values: *

* * * @param messageFormat * The format of the response message. One of the following values:

*