/* * 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.lexmodelsv2.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *

* An object containing information about a specific session. *

* * @see AWS * API Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class SessionSpecification implements Serializable, Cloneable, StructuredPojo { /** *

* The identifier of the alias of the bot that the session was held with. *

*/ private String botAliasId; /** *

* The version of the bot that the session was held with. *

*/ private String botVersion; /** *

* The locale of the bot that the session was held with. *

*/ private String localeId; /** *

* The channel that is integrated with the bot that the session was held with. *

*/ private String channel; /** *

* The identifier of the session. *

*/ private String sessionId; /** *

* The date and time when the conversation began. A conversation is defined as a unique combination of a * sessionId and an originatingRequestId. *

*/ private java.util.Date conversationStartTime; /** *

* The date and time when the conversation ended. A conversation is defined as a unique combination of a * sessionId and an originatingRequestId. *

*/ private java.util.Date conversationEndTime; /** *

* The duration of the conversation in seconds. A conversation is defined as a unique combination of a * sessionId and an originatingRequestId. *

*/ private Long conversationDurationSeconds; /** *

* The final state of the conversation. A conversation is defined as a unique combination of a * sessionId and an originatingRequestId. *

*/ private String conversationEndState; /** *

* The mode of the session. The possible values are as follows: *

* */ private String mode; /** *

* The number of turns that the session took. *

*/ private Long numberOfTurns; /** *

* A list of objects containing the name of an intent that was invoked. *

*/ private java.util.List invokedIntentSamples; /** *

* The identifier of the first request in a session. *

*/ private String originatingRequestId; /** *

* The identifier of the alias of the bot that the session was held with. *

* * @param botAliasId * The identifier of the alias of the bot that the session was held with. */ public void setBotAliasId(String botAliasId) { this.botAliasId = botAliasId; } /** *

* The identifier of the alias of the bot that the session was held with. *

* * @return The identifier of the alias of the bot that the session was held with. */ public String getBotAliasId() { return this.botAliasId; } /** *

* The identifier of the alias of the bot that the session was held with. *

* * @param botAliasId * The identifier of the alias of the bot that the session was held with. * @return Returns a reference to this object so that method calls can be chained together. */ public SessionSpecification withBotAliasId(String botAliasId) { setBotAliasId(botAliasId); return this; } /** *

* The version of the bot that the session was held with. *

* * @param botVersion * The version of the bot that the session was held with. */ public void setBotVersion(String botVersion) { this.botVersion = botVersion; } /** *

* The version of the bot that the session was held with. *

* * @return The version of the bot that the session was held with. */ public String getBotVersion() { return this.botVersion; } /** *

* The version of the bot that the session was held with. *

* * @param botVersion * The version of the bot that the session was held with. * @return Returns a reference to this object so that method calls can be chained together. */ public SessionSpecification withBotVersion(String botVersion) { setBotVersion(botVersion); return this; } /** *

* The locale of the bot that the session was held with. *

* * @param localeId * The locale of the bot that the session was held with. */ public void setLocaleId(String localeId) { this.localeId = localeId; } /** *

* The locale of the bot that the session was held with. *

* * @return The locale of the bot that the session was held with. */ public String getLocaleId() { return this.localeId; } /** *

* The locale of the bot that the session was held with. *

* * @param localeId * The locale of the bot that the session was held with. * @return Returns a reference to this object so that method calls can be chained together. */ public SessionSpecification withLocaleId(String localeId) { setLocaleId(localeId); return this; } /** *

* The channel that is integrated with the bot that the session was held with. *

* * @param channel * The channel that is integrated with the bot that the session was held with. */ public void setChannel(String channel) { this.channel = channel; } /** *

* The channel that is integrated with the bot that the session was held with. *

* * @return The channel that is integrated with the bot that the session was held with. */ public String getChannel() { return this.channel; } /** *

* The channel that is integrated with the bot that the session was held with. *

* * @param channel * The channel that is integrated with the bot that the session was held with. * @return Returns a reference to this object so that method calls can be chained together. */ public SessionSpecification withChannel(String channel) { setChannel(channel); return this; } /** *

* The identifier of the session. *

* * @param sessionId * The identifier of the session. */ public void setSessionId(String sessionId) { this.sessionId = sessionId; } /** *

* The identifier of the session. *

* * @return The identifier of the session. */ public String getSessionId() { return this.sessionId; } /** *

* The identifier of the session. *

* * @param sessionId * The identifier of the session. * @return Returns a reference to this object so that method calls can be chained together. */ public SessionSpecification withSessionId(String sessionId) { setSessionId(sessionId); return this; } /** *

* The date and time when the conversation began. A conversation is defined as a unique combination of a * sessionId and an originatingRequestId. *

* * @param conversationStartTime * The date and time when the conversation began. A conversation is defined as a unique combination of a * sessionId and an originatingRequestId. */ public void setConversationStartTime(java.util.Date conversationStartTime) { this.conversationStartTime = conversationStartTime; } /** *

* The date and time when the conversation began. A conversation is defined as a unique combination of a * sessionId and an originatingRequestId. *

* * @return The date and time when the conversation began. A conversation is defined as a unique combination of a * sessionId and an originatingRequestId. */ public java.util.Date getConversationStartTime() { return this.conversationStartTime; } /** *

* The date and time when the conversation began. A conversation is defined as a unique combination of a * sessionId and an originatingRequestId. *

* * @param conversationStartTime * The date and time when the conversation began. A conversation is defined as a unique combination of a * sessionId and an originatingRequestId. * @return Returns a reference to this object so that method calls can be chained together. */ public SessionSpecification withConversationStartTime(java.util.Date conversationStartTime) { setConversationStartTime(conversationStartTime); return this; } /** *

* The date and time when the conversation ended. A conversation is defined as a unique combination of a * sessionId and an originatingRequestId. *

* * @param conversationEndTime * The date and time when the conversation ended. A conversation is defined as a unique combination of a * sessionId and an originatingRequestId. */ public void setConversationEndTime(java.util.Date conversationEndTime) { this.conversationEndTime = conversationEndTime; } /** *

* The date and time when the conversation ended. A conversation is defined as a unique combination of a * sessionId and an originatingRequestId. *

* * @return The date and time when the conversation ended. A conversation is defined as a unique combination of a * sessionId and an originatingRequestId. */ public java.util.Date getConversationEndTime() { return this.conversationEndTime; } /** *

* The date and time when the conversation ended. A conversation is defined as a unique combination of a * sessionId and an originatingRequestId. *

* * @param conversationEndTime * The date and time when the conversation ended. A conversation is defined as a unique combination of a * sessionId and an originatingRequestId. * @return Returns a reference to this object so that method calls can be chained together. */ public SessionSpecification withConversationEndTime(java.util.Date conversationEndTime) { setConversationEndTime(conversationEndTime); return this; } /** *

* The duration of the conversation in seconds. A conversation is defined as a unique combination of a * sessionId and an originatingRequestId. *

* * @param conversationDurationSeconds * The duration of the conversation in seconds. A conversation is defined as a unique combination of a * sessionId and an originatingRequestId. */ public void setConversationDurationSeconds(Long conversationDurationSeconds) { this.conversationDurationSeconds = conversationDurationSeconds; } /** *

* The duration of the conversation in seconds. A conversation is defined as a unique combination of a * sessionId and an originatingRequestId. *

* * @return The duration of the conversation in seconds. A conversation is defined as a unique combination of a * sessionId and an originatingRequestId. */ public Long getConversationDurationSeconds() { return this.conversationDurationSeconds; } /** *

* The duration of the conversation in seconds. A conversation is defined as a unique combination of a * sessionId and an originatingRequestId. *

* * @param conversationDurationSeconds * The duration of the conversation in seconds. A conversation is defined as a unique combination of a * sessionId and an originatingRequestId. * @return Returns a reference to this object so that method calls can be chained together. */ public SessionSpecification withConversationDurationSeconds(Long conversationDurationSeconds) { setConversationDurationSeconds(conversationDurationSeconds); return this; } /** *

* The final state of the conversation. A conversation is defined as a unique combination of a * sessionId and an originatingRequestId. *

* * @param conversationEndState * The final state of the conversation. A conversation is defined as a unique combination of a * sessionId and an originatingRequestId. * @see ConversationEndState */ public void setConversationEndState(String conversationEndState) { this.conversationEndState = conversationEndState; } /** *

* The final state of the conversation. A conversation is defined as a unique combination of a * sessionId and an originatingRequestId. *

* * @return The final state of the conversation. A conversation is defined as a unique combination of a * sessionId and an originatingRequestId. * @see ConversationEndState */ public String getConversationEndState() { return this.conversationEndState; } /** *

* The final state of the conversation. A conversation is defined as a unique combination of a * sessionId and an originatingRequestId. *

* * @param conversationEndState * The final state of the conversation. A conversation is defined as a unique combination of a * sessionId and an originatingRequestId. * @return Returns a reference to this object so that method calls can be chained together. * @see ConversationEndState */ public SessionSpecification withConversationEndState(String conversationEndState) { setConversationEndState(conversationEndState); return this; } /** *

* The final state of the conversation. A conversation is defined as a unique combination of a * sessionId and an originatingRequestId. *

* * @param conversationEndState * The final state of the conversation. A conversation is defined as a unique combination of a * sessionId and an originatingRequestId. * @return Returns a reference to this object so that method calls can be chained together. * @see ConversationEndState */ public SessionSpecification withConversationEndState(ConversationEndState conversationEndState) { this.conversationEndState = conversationEndState.toString(); return this; } /** *

* The mode of the session. The possible values are as follows: *

* * * @param mode * The mode of the session. The possible values are as follows:

*