@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class SessionSpecification extends Object implements Serializable, Cloneable, StructuredPojo
An object containing information about a specific session.
Constructor and Description |
---|
SessionSpecification() |
Modifier and Type | Method and Description |
---|---|
SessionSpecification |
clone() |
boolean |
equals(Object obj) |
String |
getBotAliasId()
The identifier of the alias of the bot that the session was held with.
|
String |
getBotVersion()
The version of the bot that the session was held with.
|
String |
getChannel()
The channel that is integrated with the bot that the session was held with.
|
Long |
getConversationDurationSeconds()
The duration of the conversation in seconds.
|
String |
getConversationEndState()
The final state of the conversation.
|
Date |
getConversationEndTime()
The date and time when the conversation ended.
|
Date |
getConversationStartTime()
The date and time when the conversation began.
|
List<InvokedIntentSample> |
getInvokedIntentSamples()
A list of objects containing the name of an intent that was invoked.
|
String |
getLocaleId()
The locale of the bot that the session was held with.
|
String |
getMode()
The mode of the session.
|
Long |
getNumberOfTurns()
The number of turns that the session took.
|
String |
getOriginatingRequestId()
The identifier of the first request in a session.
|
String |
getSessionId()
The identifier of the session.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setBotAliasId(String botAliasId)
The identifier of the alias of the bot that the session was held with.
|
void |
setBotVersion(String botVersion)
The version of the bot that the session was held with.
|
void |
setChannel(String channel)
The channel that is integrated with the bot that the session was held with.
|
void |
setConversationDurationSeconds(Long conversationDurationSeconds)
The duration of the conversation in seconds.
|
void |
setConversationEndState(String conversationEndState)
The final state of the conversation.
|
void |
setConversationEndTime(Date conversationEndTime)
The date and time when the conversation ended.
|
void |
setConversationStartTime(Date conversationStartTime)
The date and time when the conversation began.
|
void |
setInvokedIntentSamples(Collection<InvokedIntentSample> invokedIntentSamples)
A list of objects containing the name of an intent that was invoked.
|
void |
setLocaleId(String localeId)
The locale of the bot that the session was held with.
|
void |
setMode(String mode)
The mode of the session.
|
void |
setNumberOfTurns(Long numberOfTurns)
The number of turns that the session took.
|
void |
setOriginatingRequestId(String originatingRequestId)
The identifier of the first request in a session.
|
void |
setSessionId(String sessionId)
The identifier of the session.
|
String |
toString()
Returns a string representation of this object.
|
SessionSpecification |
withBotAliasId(String botAliasId)
The identifier of the alias of the bot that the session was held with.
|
SessionSpecification |
withBotVersion(String botVersion)
The version of the bot that the session was held with.
|
SessionSpecification |
withChannel(String channel)
The channel that is integrated with the bot that the session was held with.
|
SessionSpecification |
withConversationDurationSeconds(Long conversationDurationSeconds)
The duration of the conversation in seconds.
|
SessionSpecification |
withConversationEndState(ConversationEndState conversationEndState)
The final state of the conversation.
|
SessionSpecification |
withConversationEndState(String conversationEndState)
The final state of the conversation.
|
SessionSpecification |
withConversationEndTime(Date conversationEndTime)
The date and time when the conversation ended.
|
SessionSpecification |
withConversationStartTime(Date conversationStartTime)
The date and time when the conversation began.
|
SessionSpecification |
withInvokedIntentSamples(Collection<InvokedIntentSample> invokedIntentSamples)
A list of objects containing the name of an intent that was invoked.
|
SessionSpecification |
withInvokedIntentSamples(InvokedIntentSample... invokedIntentSamples)
A list of objects containing the name of an intent that was invoked.
|
SessionSpecification |
withLocaleId(String localeId)
The locale of the bot that the session was held with.
|
SessionSpecification |
withMode(AnalyticsModality mode)
The mode of the session.
|
SessionSpecification |
withMode(String mode)
The mode of the session.
|
SessionSpecification |
withNumberOfTurns(Long numberOfTurns)
The number of turns that the session took.
|
SessionSpecification |
withOriginatingRequestId(String originatingRequestId)
The identifier of the first request in a session.
|
SessionSpecification |
withSessionId(String sessionId)
The identifier of the session.
|
public void setBotAliasId(String botAliasId)
The identifier of the alias of the bot that the session was held with.
botAliasId
- The identifier of the alias of the bot that the session was held with.public String getBotAliasId()
The identifier of the alias of the bot that the session was held with.
public SessionSpecification withBotAliasId(String botAliasId)
The identifier of the alias of the bot that the session was held with.
botAliasId
- The identifier of the alias of the bot that the session was held with.public void setBotVersion(String botVersion)
The version of the bot that the session was held with.
botVersion
- The version of the bot that the session was held with.public String getBotVersion()
The version of the bot that the session was held with.
public SessionSpecification withBotVersion(String botVersion)
The version of the bot that the session was held with.
botVersion
- The version of the bot that the session was held with.public void setLocaleId(String localeId)
The locale of the bot that the session was held with.
localeId
- The locale of the bot that the session was held with.public String getLocaleId()
The locale of the bot that the session was held with.
public SessionSpecification withLocaleId(String localeId)
The locale of the bot that the session was held with.
localeId
- The locale of the bot that the session was held with.public void setChannel(String channel)
The channel that is integrated with the bot that the session was held with.
channel
- The channel that is integrated with the bot that the session was held with.public String getChannel()
The channel that is integrated with the bot that the session was held with.
public SessionSpecification withChannel(String channel)
The channel that is integrated with the bot that the session was held with.
channel
- The channel that is integrated with the bot that the session was held with.public void setSessionId(String sessionId)
The identifier of the session.
sessionId
- The identifier of the session.public String getSessionId()
The identifier of the session.
public SessionSpecification withSessionId(String sessionId)
The identifier of the session.
sessionId
- The identifier of the session.public void setConversationStartTime(Date conversationStartTime)
The date and time when the conversation began. A conversation is defined as a unique combination of a
sessionId
and an originatingRequestId
.
conversationStartTime
- The date and time when the conversation began. A conversation is defined as a unique combination of a
sessionId
and an originatingRequestId
.public Date getConversationStartTime()
The date and time when the conversation began. A conversation is defined as a unique combination of a
sessionId
and an originatingRequestId
.
sessionId
and an originatingRequestId
.public SessionSpecification withConversationStartTime(Date conversationStartTime)
The date and time when the conversation began. A conversation is defined as a unique combination of a
sessionId
and an originatingRequestId
.
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 setConversationEndTime(Date conversationEndTime)
The date and time when the conversation ended. A conversation is defined as a unique combination of a
sessionId
and an originatingRequestId
.
conversationEndTime
- The date and time when the conversation ended. A conversation is defined as a unique combination of a
sessionId
and an originatingRequestId
.public Date getConversationEndTime()
The date and time when the conversation ended. A conversation is defined as a unique combination of a
sessionId
and an originatingRequestId
.
sessionId
and an originatingRequestId
.public SessionSpecification withConversationEndTime(Date conversationEndTime)
The date and time when the conversation ended. A conversation is defined as a unique combination of a
sessionId
and an originatingRequestId
.
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 setConversationDurationSeconds(Long conversationDurationSeconds)
The duration of the conversation in seconds. A conversation is defined as a unique combination of a
sessionId
and an originatingRequestId
.
conversationDurationSeconds
- The duration of the conversation in seconds. A conversation is defined as a unique combination of a
sessionId
and an originatingRequestId
.public Long getConversationDurationSeconds()
The duration of the conversation in seconds. A conversation is defined as a unique combination of a
sessionId
and an originatingRequestId
.
sessionId
and an originatingRequestId
.public SessionSpecification withConversationDurationSeconds(Long conversationDurationSeconds)
The duration of the conversation in seconds. A conversation is defined as a unique combination of a
sessionId
and an originatingRequestId
.
conversationDurationSeconds
- The duration of the conversation in seconds. A conversation is defined as a unique combination of a
sessionId
and an originatingRequestId
.public void setConversationEndState(String conversationEndState)
The final state of the conversation. A conversation is defined as a unique combination of a
sessionId
and an originatingRequestId
.
conversationEndState
- The final state of the conversation. A conversation is defined as a unique combination of a
sessionId
and an originatingRequestId
.ConversationEndState
public String getConversationEndState()
The final state of the conversation. A conversation is defined as a unique combination of a
sessionId
and an originatingRequestId
.
sessionId
and an originatingRequestId
.ConversationEndState
public SessionSpecification withConversationEndState(String conversationEndState)
The final state of the conversation. A conversation is defined as a unique combination of a
sessionId
and an originatingRequestId
.
conversationEndState
- The final state of the conversation. A conversation is defined as a unique combination of a
sessionId
and an originatingRequestId
.ConversationEndState
public SessionSpecification withConversationEndState(ConversationEndState conversationEndState)
The final state of the conversation. A conversation is defined as a unique combination of a
sessionId
and an originatingRequestId
.
conversationEndState
- The final state of the conversation. A conversation is defined as a unique combination of a
sessionId
and an originatingRequestId
.ConversationEndState
public void setMode(String mode)
The mode of the session. The possible values are as follows:
Speech
– The session was spoken.
Text
– The session was written.
DTMF
– The session used a touch-tone keypad (Dual Tone Multi-Frequency).
MultiMode
– The session used multiple modes.
mode
- The mode of the session. The possible values are as follows:
Speech
– The session was spoken.
Text
– The session was written.
DTMF
– The session used a touch-tone keypad (Dual Tone Multi-Frequency).
MultiMode
– The session used multiple modes.
AnalyticsModality
public String getMode()
The mode of the session. The possible values are as follows:
Speech
– The session was spoken.
Text
– The session was written.
DTMF
– The session used a touch-tone keypad (Dual Tone Multi-Frequency).
MultiMode
– The session used multiple modes.
Speech
– The session was spoken.
Text
– The session was written.
DTMF
– The session used a touch-tone keypad (Dual Tone Multi-Frequency).
MultiMode
– The session used multiple modes.
AnalyticsModality
public SessionSpecification withMode(String mode)
The mode of the session. The possible values are as follows:
Speech
– The session was spoken.
Text
– The session was written.
DTMF
– The session used a touch-tone keypad (Dual Tone Multi-Frequency).
MultiMode
– The session used multiple modes.
mode
- The mode of the session. The possible values are as follows:
Speech
– The session was spoken.
Text
– The session was written.
DTMF
– The session used a touch-tone keypad (Dual Tone Multi-Frequency).
MultiMode
– The session used multiple modes.
AnalyticsModality
public SessionSpecification withMode(AnalyticsModality mode)
The mode of the session. The possible values are as follows:
Speech
– The session was spoken.
Text
– The session was written.
DTMF
– The session used a touch-tone keypad (Dual Tone Multi-Frequency).
MultiMode
– The session used multiple modes.
mode
- The mode of the session. The possible values are as follows:
Speech
– The session was spoken.
Text
– The session was written.
DTMF
– The session used a touch-tone keypad (Dual Tone Multi-Frequency).
MultiMode
– The session used multiple modes.
AnalyticsModality
public void setNumberOfTurns(Long numberOfTurns)
The number of turns that the session took.
numberOfTurns
- The number of turns that the session took.public Long getNumberOfTurns()
The number of turns that the session took.
public SessionSpecification withNumberOfTurns(Long numberOfTurns)
The number of turns that the session took.
numberOfTurns
- The number of turns that the session took.public List<InvokedIntentSample> getInvokedIntentSamples()
A list of objects containing the name of an intent that was invoked.
public void setInvokedIntentSamples(Collection<InvokedIntentSample> invokedIntentSamples)
A list of objects containing the name of an intent that was invoked.
invokedIntentSamples
- A list of objects containing the name of an intent that was invoked.public SessionSpecification withInvokedIntentSamples(InvokedIntentSample... invokedIntentSamples)
A list of objects containing the name of an intent that was invoked.
NOTE: This method appends the values to the existing list (if any). Use
setInvokedIntentSamples(java.util.Collection)
or withInvokedIntentSamples(java.util.Collection)
if you want to override the existing values.
invokedIntentSamples
- A list of objects containing the name of an intent that was invoked.public SessionSpecification withInvokedIntentSamples(Collection<InvokedIntentSample> invokedIntentSamples)
A list of objects containing the name of an intent that was invoked.
invokedIntentSamples
- A list of objects containing the name of an intent that was invoked.public void setOriginatingRequestId(String originatingRequestId)
The identifier of the first request in a session.
originatingRequestId
- The identifier of the first request in a session.public String getOriginatingRequestId()
The identifier of the first request in a session.
public SessionSpecification withOriginatingRequestId(String originatingRequestId)
The identifier of the first request in a session.
originatingRequestId
- The identifier of the first request in a session.public String toString()
toString
in class Object
Object.toString()
public SessionSpecification clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.