SessionSpecification (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.lexmodelsv2.model.SessionSpecification

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@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.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

SessionSpecification()

Constructors
Constructor and Description
`SessionSpecification()`

Method Summary

All Methods Instance Methods Concrete Methods
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.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SessionSpecification
```
public SessionSpecification()
```
- Method Detail
  - setBotAliasId
```
public void setBotAliasId(String botAliasId)
```
    The identifier of the alias of the bot that the session was held with.
    
    Parameters:
    
    botAliasId - The identifier of the alias of the bot that the session was held with.
  - getBotAliasId
```
public String getBotAliasId()
```
    The identifier of the alias of the bot that the session was held with.
    
    Returns:
    
    The identifier of the alias of the bot that the session was held with.
  - withBotAliasId
```
public SessionSpecification withBotAliasId(String botAliasId)
```
    The identifier of the alias of the bot that the session was held with.
    
    Parameters:
    
    botAliasId - The identifier of the alias of the bot that the session was held with.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBotVersion
```
public void setBotVersion(String botVersion)
```
    The version of the bot that the session was held with.
    
    Parameters:
    
    botVersion - The version of the bot that the session was held with.
  - getBotVersion
```
public String getBotVersion()
```
    The version of the bot that the session was held with.
    
    Returns:
    
    The version of the bot that the session was held with.
  - withBotVersion
```
public SessionSpecification withBotVersion(String botVersion)
```
    The version of the bot that the session was held with.
    
    Parameters:
    
    botVersion - The version of the bot that the session was held with.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLocaleId
```
public void setLocaleId(String localeId)
```
    The locale of the bot that the session was held with.
    
    Parameters:
    
    localeId - The locale of the bot that the session was held with.
  - getLocaleId
```
public String getLocaleId()
```
    The locale of the bot that the session was held with.
    
    Returns:
    
    The locale of the bot that the session was held with.
  - withLocaleId
```
public SessionSpecification withLocaleId(String localeId)
```
    The locale of the bot that the session was held with.
    
    Parameters:
    
    localeId - The locale of the bot that the session was held with.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setChannel
```
public void setChannel(String channel)
```
    The channel that is integrated with the bot that the session was held with.
    
    Parameters:
    
    channel - The channel that is integrated with the bot that the session was held with.
  - getChannel
```
public String getChannel()
```
    The channel that is integrated with the bot that the session was held with.
    
    Returns:
    
    The channel that is integrated with the bot that the session was held with.
  - withChannel
```
public SessionSpecification withChannel(String channel)
```
    The channel that is integrated with the bot that the session was held with.
    
    Parameters:
    
    channel - The channel that is integrated with the bot that the session was held with.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSessionId
```
public void setSessionId(String sessionId)
```
    The identifier of the session.
    
    Parameters:
    
    sessionId - The identifier of the session.
  - getSessionId
```
public String getSessionId()
```
    The identifier of the session.
    
    Returns:
    
    The identifier of the session.
  - withSessionId
```
public SessionSpecification withSessionId(String sessionId)
```
    The identifier of the session.
    
    Parameters:
    
    sessionId - The identifier of the session.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setConversationStartTime
```
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.
    
    Parameters:
    
    conversationStartTime - The date and time when the conversation began. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.
  - getConversationStartTime
```
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.
    
    Returns:
    
    The date and time when the conversation began. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.
  - withConversationStartTime
```
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.
    
    Parameters:
    
    conversationStartTime - The date and time when the conversation began. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setConversationEndTime
```
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.
    
    Parameters:
    
    conversationEndTime - The date and time when the conversation ended. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.
  - getConversationEndTime
```
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.
    
    Returns:
    
    The date and time when the conversation ended. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.
  - withConversationEndTime
```
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.
    
    Parameters:
    
    conversationEndTime - The date and time when the conversation ended. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setConversationDurationSeconds
```
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.
    
    Parameters:
    
    conversationDurationSeconds - The duration of the conversation in seconds. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.
  - getConversationDurationSeconds
```
public Long getConversationDurationSeconds()
```
    The duration of the conversation in seconds. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.
    
    Returns:
    
    The duration of the conversation in seconds. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.
  - withConversationDurationSeconds
```
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.
    
    Parameters:
    
    conversationDurationSeconds - The duration of the conversation in seconds. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setConversationEndState
```
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.
    
    Parameters:
    
    conversationEndState - The final state of the conversation. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.
    
    See Also:
    
    ConversationEndState
  - getConversationEndState
```
public String getConversationEndState()
```
    The final state of the conversation. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.
    
    Returns:
    
    The final state of the conversation. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.
    
    See Also:
    
    ConversationEndState
  - withConversationEndState
```
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.
    
    Parameters:
    
    conversationEndState - The final state of the conversation. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ConversationEndState
  - withConversationEndState
```
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.
    
    Parameters:
    
    conversationEndState - The final state of the conversation. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ConversationEndState
  - setMode
```
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.
    Parameters:
    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.
    See Also:
    
    AnalyticsModality
  - getMode
```
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.
    Returns:
    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.
    See Also:
    
    AnalyticsModality
  - withMode
```
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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AnalyticsModality
  - withMode
```
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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AnalyticsModality
  - setNumberOfTurns
```
public void setNumberOfTurns(Long numberOfTurns)
```
    The number of turns that the session took.
    
    Parameters:
    
    numberOfTurns - The number of turns that the session took.
  - getNumberOfTurns
```
public Long getNumberOfTurns()
```
    The number of turns that the session took.
    
    Returns:
    
    The number of turns that the session took.
  - withNumberOfTurns
```
public SessionSpecification withNumberOfTurns(Long numberOfTurns)
```
    The number of turns that the session took.
    
    Parameters:
    
    numberOfTurns - The number of turns that the session took.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getInvokedIntentSamples
```
public List<InvokedIntentSample> getInvokedIntentSamples()
```
    A list of objects containing the name of an intent that was invoked.
    
    Returns:
    
    A list of objects containing the name of an intent that was invoked.
  - setInvokedIntentSamples
```
public void setInvokedIntentSamples(Collection<InvokedIntentSample> invokedIntentSamples)
```
    A list of objects containing the name of an intent that was invoked.
    
    Parameters:
    
    invokedIntentSamples - A list of objects containing the name of an intent that was invoked.
  - withInvokedIntentSamples
```
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.
    
    Parameters:
    
    invokedIntentSamples - A list of objects containing the name of an intent that was invoked.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withInvokedIntentSamples
```
public SessionSpecification withInvokedIntentSamples(Collection<InvokedIntentSample> invokedIntentSamples)
```
    A list of objects containing the name of an intent that was invoked.
    
    Parameters:
    
    invokedIntentSamples - A list of objects containing the name of an intent that was invoked.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOriginatingRequestId
```
public void setOriginatingRequestId(String originatingRequestId)
```
    The identifier of the first request in a session.
    
    Parameters:
    
    originatingRequestId - The identifier of the first request in a session.
  - getOriginatingRequestId
```
public String getOriginatingRequestId()
```
    The identifier of the first request in a session.
    
    Returns:
    
    The identifier of the first request in a session.
  - withOriginatingRequestId
```
public SessionSpecification withOriginatingRequestId(String originatingRequestId)
```
    The identifier of the first request in a session.
    
    Parameters:
    
    originatingRequestId - The identifier of the first request in a session.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    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.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public SessionSpecification clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.793

Class SessionSpecification

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SessionSpecification

Method Detail

setBotAliasId

getBotAliasId

withBotAliasId

setBotVersion

getBotVersion

withBotVersion

setLocaleId

getLocaleId

withLocaleId

setChannel

getChannel

withChannel

setSessionId

getSessionId

withSessionId

setConversationStartTime

getConversationStartTime

withConversationStartTime

setConversationEndTime

getConversationEndTime

withConversationEndTime

setConversationDurationSeconds

getConversationDurationSeconds

withConversationDurationSeconds

setConversationEndState

getConversationEndState

withConversationEndState

withConversationEndState

setMode

getMode

withMode

withMode

setNumberOfTurns

getNumberOfTurns

withNumberOfTurns

getInvokedIntentSamples

setInvokedIntentSamples

withInvokedIntentSamples

withInvokedIntentSamples

setOriginatingRequestId

getOriginatingRequestId

withOriginatingRequestId

toString

equals

hashCode

clone

marshall