com.amazonaws.services.lexruntime.model.PutSessionResult Maven / Gradle / Ivy
/*
* 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:
*
*
* -
*
* 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.
*
*
*
*/
private String messageFormat;
/**
*
*
* -
*
* ConfirmIntent - Amazon Lex is expecting a "yes" or "no" response to confirm the intent before
* fulfilling an intent.
*
*
* -
*
* ElicitIntent - Amazon Lex wants to elicit the user's intent.
*
*
* -
*
* ElicitSlot - Amazon Lex is expecting the value of a slot for the current intent.
*
*
* -
*
* Failed - Conveys that the conversation with the user has failed. This can happen for various
* reasons, including the user does not provide an appropriate response to prompts from the service, or if the
* Lambda function fails to fulfill the intent.
*
*
* -
*
* Fulfilled - Conveys that the Lambda function has sucessfully fulfilled the intent.
*
*
* -
*
* ReadyForFulfillment - Conveys that the client has to fulfill the intent.
*
*
*
*/
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:
*
*
* -
*
* 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.
*
*
*
*
* @param 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.
*
*
* @see MessageFormatType
*/
public void setMessageFormat(String messageFormat) {
this.messageFormat = 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.
*
*
*
*
* @return 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 MessageFormatType
*/
public String getMessageFormat() {
return this.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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see MessageFormatType
*/
public PutSessionResult withMessageFormat(String messageFormat) {
setMessageFormat(messageFormat);
return this;
}
/**
*
* 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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see MessageFormatType
*/
public PutSessionResult withMessageFormat(MessageFormatType messageFormat) {
this.messageFormat = messageFormat.toString();
return this;
}
/**
*
*
* -
*
* ConfirmIntent - Amazon Lex is expecting a "yes" or "no" response to confirm the intent before
* fulfilling an intent.
*
*
* -
*
* ElicitIntent - Amazon Lex wants to elicit the user's intent.
*
*
* -
*
* ElicitSlot - Amazon Lex is expecting the value of a slot for the current intent.
*
*
* -
*
* Failed - Conveys that the conversation with the user has failed. This can happen for various
* reasons, including the user does not provide an appropriate response to prompts from the service, or if the
* Lambda function fails to fulfill the intent.
*
*
* -
*
* Fulfilled - Conveys that the Lambda function has sucessfully fulfilled the intent.
*
*
* -
*
* ReadyForFulfillment - Conveys that the client has to fulfill the intent.
*
*
*
*
* @param dialogState
*
* -
*
* ConfirmIntent - Amazon Lex is expecting a "yes" or "no" response to confirm the intent before
* fulfilling an intent.
*
* -
*
* ElicitIntent - Amazon Lex wants to elicit the user's intent.
*
* -
*
* ElicitSlot - Amazon Lex is expecting the value of a slot for the current intent.
*
* -
*
* Failed - Conveys that the conversation with the user has failed. This can happen for various
* reasons, including the user does not provide an appropriate response to prompts from the service, or if
* the Lambda function fails to fulfill the intent.
*
* -
*
* Fulfilled - Conveys that the Lambda function has sucessfully fulfilled the intent.
*
* -
*
* ReadyForFulfillment - Conveys that the client has to fulfill the intent.
*
*
* @see DialogState
*/
public void setDialogState(String dialogState) {
this.dialogState = dialogState;
}
/**
*
*
* -
*
* ConfirmIntent - Amazon Lex is expecting a "yes" or "no" response to confirm the intent before
* fulfilling an intent.
*
*
* -
*
* ElicitIntent - Amazon Lex wants to elicit the user's intent.
*
*
* -
*
* ElicitSlot - Amazon Lex is expecting the value of a slot for the current intent.
*
*
* -
*
* Failed - Conveys that the conversation with the user has failed. This can happen for various
* reasons, including the user does not provide an appropriate response to prompts from the service, or if the
* Lambda function fails to fulfill the intent.
*
*
* -
*
* Fulfilled - Conveys that the Lambda function has sucessfully fulfilled the intent.
*
*
* -
*
* ReadyForFulfillment - Conveys that the client has to fulfill the intent.
*
*
*
*
* @return
* -
*
* ConfirmIntent - Amazon Lex is expecting a "yes" or "no" response to confirm the intent
* before fulfilling an intent.
*
* -
*
* ElicitIntent - Amazon Lex wants to elicit the user's intent.
*
* -
*
* ElicitSlot - Amazon Lex is expecting the value of a slot for the current intent.
*
* -
*
* Failed - Conveys that the conversation with the user has failed. This can happen for various
* reasons, including the user does not provide an appropriate response to prompts from the service, or if
* the Lambda function fails to fulfill the intent.
*
* -
*
* Fulfilled - Conveys that the Lambda function has sucessfully fulfilled the intent.
*
* -
*
* ReadyForFulfillment - Conveys that the client has to fulfill the intent.
*
*
* @see DialogState
*/
public String getDialogState() {
return this.dialogState;
}
/**
*
*
* -
*
* ConfirmIntent - Amazon Lex is expecting a "yes" or "no" response to confirm the intent before
* fulfilling an intent.
*
*
* -
*
* ElicitIntent - Amazon Lex wants to elicit the user's intent.
*
*
* -
*
* ElicitSlot - Amazon Lex is expecting the value of a slot for the current intent.
*
*
* -
*
* Failed - Conveys that the conversation with the user has failed. This can happen for various
* reasons, including the user does not provide an appropriate response to prompts from the service, or if the
* Lambda function fails to fulfill the intent.
*
*
* -
*
* Fulfilled - Conveys that the Lambda function has sucessfully fulfilled the intent.
*
*
* -
*
* ReadyForFulfillment - Conveys that the client has to fulfill the intent.
*
*
*
*
* @param dialogState
*
* -
*
* ConfirmIntent - Amazon Lex is expecting a "yes" or "no" response to confirm the intent before
* fulfilling an intent.
*
* -
*
* ElicitIntent - Amazon Lex wants to elicit the user's intent.
*
* -
*
* ElicitSlot - Amazon Lex is expecting the value of a slot for the current intent.
*
* -
*
* Failed - Conveys that the conversation with the user has failed. This can happen for various
* reasons, including the user does not provide an appropriate response to prompts from the service, or if
* the Lambda function fails to fulfill the intent.
*
* -
*
* Fulfilled - Conveys that the Lambda function has sucessfully fulfilled the intent.
*
* -
*
* ReadyForFulfillment - Conveys that the client has to fulfill the intent.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see DialogState
*/
public PutSessionResult withDialogState(String dialogState) {
setDialogState(dialogState);
return this;
}
/**
*
*
* -
*
* ConfirmIntent - Amazon Lex is expecting a "yes" or "no" response to confirm the intent before
* fulfilling an intent.
*
*
* -
*
* ElicitIntent - Amazon Lex wants to elicit the user's intent.
*
*
* -
*
* ElicitSlot - Amazon Lex is expecting the value of a slot for the current intent.
*
*
* -
*
* Failed - Conveys that the conversation with the user has failed. This can happen for various
* reasons, including the user does not provide an appropriate response to prompts from the service, or if the
* Lambda function fails to fulfill the intent.
*
*
* -
*
* Fulfilled - Conveys that the Lambda function has sucessfully fulfilled the intent.
*
*
* -
*
* ReadyForFulfillment - Conveys that the client has to fulfill the intent.
*
*
*
*
* @param dialogState
*
* -
*
* ConfirmIntent - Amazon Lex is expecting a "yes" or "no" response to confirm the intent before
* fulfilling an intent.
*
* -
*
* ElicitIntent - Amazon Lex wants to elicit the user's intent.
*
* -
*
* ElicitSlot - Amazon Lex is expecting the value of a slot for the current intent.
*
* -
*
* Failed - Conveys that the conversation with the user has failed. This can happen for various
* reasons, including the user does not provide an appropriate response to prompts from the service, or if
* the Lambda function fails to fulfill the intent.
*
* -
*
* Fulfilled - Conveys that the Lambda function has sucessfully fulfilled the intent.
*
* -
*
* ReadyForFulfillment - Conveys that the client has to fulfill the intent.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see DialogState
*/
public PutSessionResult withDialogState(DialogState dialogState) {
this.dialogState = dialogState.toString();
return this;
}
/**
*
* If the dialogState is ElicitSlot, returns the name of the slot for which Amazon Lex is
* eliciting a value.
*
*
* @param slotToElicit
* If the dialogState is ElicitSlot, returns the name of the slot for which Amazon
* Lex is eliciting a value.
*/
public void setSlotToElicit(String slotToElicit) {
this.slotToElicit = slotToElicit;
}
/**
*
* If the dialogState is ElicitSlot, returns the name of the slot for which Amazon Lex is
* eliciting a value.
*
*
* @return If the dialogState is ElicitSlot, returns the name of the slot for which Amazon
* Lex is eliciting a value.
*/
public String getSlotToElicit() {
return this.slotToElicit;
}
/**
*
* If the dialogState is ElicitSlot, returns the name of the slot for which Amazon Lex is
* eliciting a value.
*
*
* @param slotToElicit
* If the dialogState is ElicitSlot, returns the name of the slot for which Amazon
* Lex is eliciting a value.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutSessionResult withSlotToElicit(String slotToElicit) {
setSlotToElicit(slotToElicit);
return this;
}
/**
*
* The audio version of the message to convey to the user.
*
*
* @param audioStream
* The audio version of the message to convey to the user.
*/
public void setAudioStream(java.io.InputStream audioStream) {
this.audioStream = audioStream;
}
/**
*
* The audio version of the message to convey to the user.
*
*
* @return The audio version of the message to convey to the user.
*/
public java.io.InputStream getAudioStream() {
return this.audioStream;
}
/**
*
* The audio version of the message to convey to the user.
*
*
* @param audioStream
* The audio version of the message to convey to the user.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutSessionResult withAudioStream(java.io.InputStream audioStream) {
setAudioStream(audioStream);
return this;
}
/**
*
* A unique identifier for the session.
*
*
* @param sessionId
* A unique identifier for the session.
*/
public void setSessionId(String sessionId) {
this.sessionId = sessionId;
}
/**
*
* A unique identifier for the session.
*
*
* @return A unique identifier for the session.
*/
public String getSessionId() {
return this.sessionId;
}
/**
*
* A unique identifier for the session.
*
*
* @param sessionId
* A unique identifier for the session.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutSessionResult withSessionId(String sessionId) {
setSessionId(sessionId);
return this;
}
/**
*
* A list of active contexts for the session.
*
*
* 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 activeContexts
* A list of active contexts for the session.
*/
public void setActiveContexts(String activeContexts) {
this.activeContexts = activeContexts;
}
/**
*
* A list of active contexts for the session.
*
*
* This field's value will be valid JSON according to RFC 7159, including the opening and closing braces. For
* example: '{"key": "value"}'.
*
*
* @return A list of active contexts for the session.
*/
public String getActiveContexts() {
return this.activeContexts;
}
/**
*
* A list of active contexts for the session.
*
*
* 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 activeContexts
* A list of active contexts for the session.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutSessionResult withActiveContexts(String activeContexts) {
setActiveContexts(activeContexts);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getContentType() != null)
sb.append("ContentType: ").append(getContentType()).append(",");
if (getIntentName() != null)
sb.append("IntentName: ").append(getIntentName()).append(",");
if (getSlots() != null)
sb.append("Slots: ").append(getSlots()).append(",");
if (getSessionAttributes() != null)
sb.append("SessionAttributes: ").append(getSessionAttributes()).append(",");
if (getMessage() != null)
sb.append("Message: ").append("***Sensitive Data Redacted***").append(",");
if (getEncodedMessage() != null)
sb.append("EncodedMessage: ").append("***Sensitive Data Redacted***").append(",");
if (getMessageFormat() != null)
sb.append("MessageFormat: ").append(getMessageFormat()).append(",");
if (getDialogState() != null)
sb.append("DialogState: ").append(getDialogState()).append(",");
if (getSlotToElicit() != null)
sb.append("SlotToElicit: ").append(getSlotToElicit()).append(",");
if (getAudioStream() != null)
sb.append("AudioStream: ").append(getAudioStream()).append(",");
if (getSessionId() != null)
sb.append("SessionId: ").append(getSessionId()).append(",");
if (getActiveContexts() != null)
sb.append("ActiveContexts: ").append("***Sensitive Data Redacted***");
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof PutSessionResult == false)
return false;
PutSessionResult other = (PutSessionResult) obj;
if (other.getContentType() == null ^ this.getContentType() == null)
return false;
if (other.getContentType() != null && other.getContentType().equals(this.getContentType()) == false)
return false;
if (other.getIntentName() == null ^ this.getIntentName() == null)
return false;
if (other.getIntentName() != null && other.getIntentName().equals(this.getIntentName()) == false)
return false;
if (other.getSlots() == null ^ this.getSlots() == null)
return false;
if (other.getSlots() != null && other.getSlots().equals(this.getSlots()) == false)
return false;
if (other.getSessionAttributes() == null ^ this.getSessionAttributes() == null)
return false;
if (other.getSessionAttributes() != null && other.getSessionAttributes().equals(this.getSessionAttributes()) == false)
return false;
if (other.getMessage() == null ^ this.getMessage() == null)
return false;
if (other.getMessage() != null && other.getMessage().equals(this.getMessage()) == false)
return false;
if (other.getEncodedMessage() == null ^ this.getEncodedMessage() == null)
return false;
if (other.getEncodedMessage() != null && other.getEncodedMessage().equals(this.getEncodedMessage()) == false)
return false;
if (other.getMessageFormat() == null ^ this.getMessageFormat() == null)
return false;
if (other.getMessageFormat() != null && other.getMessageFormat().equals(this.getMessageFormat()) == false)
return false;
if (other.getDialogState() == null ^ this.getDialogState() == null)
return false;
if (other.getDialogState() != null && other.getDialogState().equals(this.getDialogState()) == false)
return false;
if (other.getSlotToElicit() == null ^ this.getSlotToElicit() == null)
return false;
if (other.getSlotToElicit() != null && other.getSlotToElicit().equals(this.getSlotToElicit()) == false)
return false;
if (other.getAudioStream() == null ^ this.getAudioStream() == null)
return false;
if (other.getAudioStream() != null && other.getAudioStream().equals(this.getAudioStream()) == false)
return false;
if (other.getSessionId() == null ^ this.getSessionId() == null)
return false;
if (other.getSessionId() != null && other.getSessionId().equals(this.getSessionId()) == false)
return false;
if (other.getActiveContexts() == null ^ this.getActiveContexts() == null)
return false;
if (other.getActiveContexts() != null && other.getActiveContexts().equals(this.getActiveContexts()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getContentType() == null) ? 0 : getContentType().hashCode());
hashCode = prime * hashCode + ((getIntentName() == null) ? 0 : getIntentName().hashCode());
hashCode = prime * hashCode + ((getSlots() == null) ? 0 : getSlots().hashCode());
hashCode = prime * hashCode + ((getSessionAttributes() == null) ? 0 : getSessionAttributes().hashCode());
hashCode = prime * hashCode + ((getMessage() == null) ? 0 : getMessage().hashCode());
hashCode = prime * hashCode + ((getEncodedMessage() == null) ? 0 : getEncodedMessage().hashCode());
hashCode = prime * hashCode + ((getMessageFormat() == null) ? 0 : getMessageFormat().hashCode());
hashCode = prime * hashCode + ((getDialogState() == null) ? 0 : getDialogState().hashCode());
hashCode = prime * hashCode + ((getSlotToElicit() == null) ? 0 : getSlotToElicit().hashCode());
hashCode = prime * hashCode + ((getAudioStream() == null) ? 0 : getAudioStream().hashCode());
hashCode = prime * hashCode + ((getSessionId() == null) ? 0 : getSessionId().hashCode());
hashCode = prime * hashCode + ((getActiveContexts() == null) ? 0 : getActiveContexts().hashCode());
return hashCode;
}
@Override
public PutSessionResult clone() {
try {
return (PutSessionResult) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}