com.amazonaws.services.lexrts.model

Class PutSessionRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.lexrts.model.PutSessionRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class PutSessionRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Creates a new session or modifies an existing session with an Amazon Lex bot. Use this operation to enable your application to set the state of the bot.

For more information, see Managing Sessions.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PutSessionRequest()

Method Summary

Modifier and Type	Method and Description
PutSessionRequest	addsessionAttributesEntry(java.lang.String key, java.lang.String value) Map of key/value pairs representing the session-specific context information.
PutSessionRequest	clearsessionAttributesEntries() Removes all the entries added into sessionAttributes.
boolean	equals(java.lang.Object obj)
java.lang.String	getAccept() The message that Amazon Lex returns in the response can be either text or speech based depending on the value of this field.
java.lang.String	getBotAlias() The alias in use for the bot that contains the session data.
java.lang.String	getBotName() The name of the bot that contains the session data.
DialogAction	getDialogAction() Sets the next action that the bot should take to fulfill the conversation.
java.util.List<IntentSummary>	getRecentIntentSummaryView() A summary of the recent intents for the bot.
java.util.Map<java.lang.String,java.lang.String>	getSessionAttributes() Map of key/value pairs representing the session-specific context information.
java.lang.String	getUserId() The ID of the client application user.
int	hashCode()
void	setAccept(java.lang.String accept) The message that Amazon Lex returns in the response can be either text or speech based depending on the value of this field.
void	setBotAlias(java.lang.String botAlias) The alias in use for the bot that contains the session data.
void	setBotName(java.lang.String botName) The name of the bot that contains the session data.
void	setDialogAction(DialogAction dialogAction) Sets the next action that the bot should take to fulfill the conversation.
void	setRecentIntentSummaryView(java.util.Collection<IntentSummary> recentIntentSummaryView) A summary of the recent intents for the bot.
void	setSessionAttributes(java.util.Map<java.lang.String,java.lang.String> sessionAttributes) Map of key/value pairs representing the session-specific context information.
void	setUserId(java.lang.String userId) The ID of the client application user.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
PutSessionRequest	withAccept(java.lang.String accept) The message that Amazon Lex returns in the response can be either text or speech based depending on the value of this field.
PutSessionRequest	withBotAlias(java.lang.String botAlias) The alias in use for the bot that contains the session data.
PutSessionRequest	withBotName(java.lang.String botName) The name of the bot that contains the session data.
PutSessionRequest	withDialogAction(DialogAction dialogAction) Sets the next action that the bot should take to fulfill the conversation.
PutSessionRequest	withRecentIntentSummaryView(java.util.Collection<IntentSummary> recentIntentSummaryView) A summary of the recent intents for the bot.
PutSessionRequest	withRecentIntentSummaryView(IntentSummary... recentIntentSummaryView) A summary of the recent intents for the bot.
PutSessionRequest	withSessionAttributes(java.util.Map<java.lang.String,java.lang.String> sessionAttributes) Map of key/value pairs representing the session-specific context information.
PutSessionRequest	withUserId(java.lang.String userId) The ID of the client application user.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PutSessionRequest

public PutSessionRequest()

Method Detail

getBotName

public java.lang.String getBotName()

The name of the bot that contains the session data.

Returns:

The name of the bot that contains the session data.

setBotName

public void setBotName(java.lang.String botName)

The name of the bot that contains the session data.

Parameters:

botName -

The name of the bot that contains the session data.

withBotName

public PutSessionRequest withBotName(java.lang.String botName)

The name of the bot that contains the session data.

Returns a reference to this object so that method calls can be chained together.

Parameters:

botName -

The name of the bot that contains the session data.

Returns:

A reference to this updated object so that method calls can be chained together.

getBotAlias

public java.lang.String getBotAlias()

The alias in use for the bot that contains the session data.

Returns:

The alias in use for the bot that contains the session data.

setBotAlias

public void setBotAlias(java.lang.String botAlias)

The alias in use for the bot that contains the session data.

Parameters:

botAlias -

The alias in use for the bot that contains the session data.

withBotAlias

public PutSessionRequest withBotAlias(java.lang.String botAlias)

The alias in use for the bot that contains the session data.

Returns a reference to this object so that method calls can be chained together.

Parameters:

botAlias -

The alias in use for the bot that contains the session data.

Returns:

A reference to this updated object so that method calls can be chained together.

getUserId

public java.lang.String getUserId()

The ID of the client application user. Amazon Lex uses this to identify a user's conversation with your bot.

Constraints:
Length: 2 - 100
Pattern: [0-9a-zA-Z._:-]+

Returns:

The ID of the client application user. Amazon Lex uses this to identify a user's conversation with your bot.

setUserId

public void setUserId(java.lang.String userId)

The ID of the client application user. Amazon Lex uses this to identify a user's conversation with your bot.

Constraints:
Length: 2 - 100
Pattern: [0-9a-zA-Z._:-]+

Parameters:

userId -

The ID of the client application user. Amazon Lex uses this to identify a user's conversation with your bot.

withUserId

public PutSessionRequest withUserId(java.lang.String userId)

The ID of the client application user. Amazon Lex uses this to identify a user's conversation with your bot.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 2 - 100
Pattern: [0-9a-zA-Z._:-]+

Parameters:

userId -

The ID of the client application user. Amazon Lex uses this to identify a user's conversation with your bot.

Returns:

A reference to this updated object so that method calls can be chained together.

getSessionAttributes

public java.util.Map<java.lang.String,java.lang.String> getSessionAttributes()

Map of key/value pairs representing the session-specific context information. It contains application information passed between Amazon Lex and a client application.

Returns:

Map of key/value pairs representing the session-specific context information. It contains application information passed between Amazon Lex and a client application.

setSessionAttributes

public void setSessionAttributes(java.util.Map<java.lang.String,java.lang.String> sessionAttributes)

Map of key/value pairs representing the session-specific context information. It contains application information passed between Amazon Lex and a client application.

Parameters:

sessionAttributes -

Map of key/value pairs representing the session-specific context information. It contains application information passed between Amazon Lex and a client application.

withSessionAttributes

public PutSessionRequest withSessionAttributes(java.util.Map<java.lang.String,java.lang.String> sessionAttributes)

Map of key/value pairs representing the session-specific context information. It contains application information passed between Amazon Lex and a client application.

Returns a reference to this object so that method calls can be chained together.

Parameters:

sessionAttributes -

Map of key/value pairs representing the session-specific context information. It contains application information passed between Amazon Lex and a client application.

Returns:

A reference to this updated object so that method calls can be chained together.

addsessionAttributesEntry

public PutSessionRequest addsessionAttributesEntry(java.lang.String key,
                                                   java.lang.String value)

Map of key/value pairs representing the session-specific context information. It contains application information passed between Amazon Lex and a client application.

The method adds a new key-value pair into sessionAttributes parameter, and returns a reference to this object so that method calls can be chained together.

Parameters:

key - The key of the entry to be added into sessionAttributes.

value - The corresponding value of the entry to be added into sessionAttributes.

Returns:

A reference to this updated object so that method calls can be chained together.

clearsessionAttributesEntries

public PutSessionRequest clearsessionAttributesEntries()

Removes all the entries added into sessionAttributes.

Returns a reference to this object so that method calls can be chained together.

getDialogAction

public DialogAction getDialogAction()

Sets the next action that the bot should take to fulfill the conversation.

Returns:

Sets the next action that the bot should take to fulfill the conversation.

setDialogAction

public void setDialogAction(DialogAction dialogAction)

Sets the next action that the bot should take to fulfill the conversation.

Parameters:

dialogAction -

Sets the next action that the bot should take to fulfill the conversation.

withDialogAction

public PutSessionRequest withDialogAction(DialogAction dialogAction)

Sets the next action that the bot should take to fulfill the conversation.

Returns a reference to this object so that method calls can be chained together.

Parameters:

dialogAction -

Sets the next action that the bot should take to fulfill the conversation.

Returns:

A reference to this updated object so that method calls can be chained together.

getRecentIntentSummaryView

public java.util.List<IntentSummary> getRecentIntentSummaryView()

A summary of the recent intents for the bot. You can use the intent summary view to set a checkpoint label on an intent and modify attributes of intents. You can also use it to remove or add intent summary objects to the list.

An intent that you modify or add to the list must make sense for the bot. For example, the intent name must be valid for the bot. You must provide valid values for:

• intentName

• slot names

• slotToElict

If you send the recentIntentSummaryView parameter in a PutSession request, the contents of the new summary view replaces the old summary view. For example, if a GetSession request returns three intents in the summary view and you call PutSession with one intent in the summary view, the next call to GetSession will only return one intent.

Returns:

A summary of the recent intents for the bot. You can use the intent summary view to set a checkpoint label on an intent and modify attributes of intents. You can also use it to remove or add intent summary objects to the list.

An intent that you modify or add to the list must make sense for the bot. For example, the intent name must be valid for the bot. You must provide valid values for:

• intentName

• slot names

• slotToElict

If you send the recentIntentSummaryView parameter in a PutSession request, the contents of the new summary view replaces the old summary view. For example, if a GetSession request returns three intents in the summary view and you call PutSession with one intent in the summary view, the next call to GetSession will only return one intent.

setRecentIntentSummaryView

public void setRecentIntentSummaryView(java.util.Collection<IntentSummary> recentIntentSummaryView)

A summary of the recent intents for the bot. You can use the intent summary view to set a checkpoint label on an intent and modify attributes of intents. You can also use it to remove or add intent summary objects to the list.

An intent that you modify or add to the list must make sense for the bot. For example, the intent name must be valid for the bot. You must provide valid values for:

• intentName

• slot names

• slotToElict

If you send the recentIntentSummaryView parameter in a PutSession request, the contents of the new summary view replaces the old summary view. For example, if a GetSession request returns three intents in the summary view and you call PutSession with one intent in the summary view, the next call to GetSession will only return one intent.

Parameters:

recentIntentSummaryView -

A summary of the recent intents for the bot. You can use the intent summary view to set a checkpoint label on an intent and modify attributes of intents. You can also use it to remove or add intent summary objects to the list.

An intent that you modify or add to the list must make sense for the bot. For example, the intent name must be valid for the bot. You must provide valid values for:

• intentName

• slot names

• slotToElict

If you send the recentIntentSummaryView parameter in a PutSession request, the contents of the new summary view replaces the old summary view. For example, if a GetSession request returns three intents in the summary view and you call PutSession with one intent in the summary view, the next call to GetSession will only return one intent.

withRecentIntentSummaryView

public PutSessionRequest withRecentIntentSummaryView(IntentSummary... recentIntentSummaryView)

A summary of the recent intents for the bot. You can use the intent summary view to set a checkpoint label on an intent and modify attributes of intents. You can also use it to remove or add intent summary objects to the list.

An intent that you modify or add to the list must make sense for the bot. For example, the intent name must be valid for the bot. You must provide valid values for:

• intentName

• slot names

• slotToElict

If you send the recentIntentSummaryView parameter in a PutSession request, the contents of the new summary view replaces the old summary view. For example, if a GetSession request returns three intents in the summary view and you call PutSession with one intent in the summary view, the next call to GetSession will only return one intent.

Returns a reference to this object so that method calls can be chained together.

Parameters:

recentIntentSummaryView -

A summary of the recent intents for the bot. You can use the intent summary view to set a checkpoint label on an intent and modify attributes of intents. You can also use it to remove or add intent summary objects to the list.

An intent that you modify or add to the list must make sense for the bot. For example, the intent name must be valid for the bot. You must provide valid values for:

• intentName

• slot names

• slotToElict

If you send the recentIntentSummaryView parameter in a PutSession request, the contents of the new summary view replaces the old summary view. For example, if a GetSession request returns three intents in the summary view and you call PutSession with one intent in the summary view, the next call to GetSession will only return one intent.

Returns:

A reference to this updated object so that method calls can be chained together.

withRecentIntentSummaryView

public PutSessionRequest withRecentIntentSummaryView(java.util.Collection<IntentSummary> recentIntentSummaryView)

A summary of the recent intents for the bot. You can use the intent summary view to set a checkpoint label on an intent and modify attributes of intents. You can also use it to remove or add intent summary objects to the list.

An intent that you modify or add to the list must make sense for the bot. For example, the intent name must be valid for the bot. You must provide valid values for:

• intentName

• slot names

• slotToElict

If you send the recentIntentSummaryView parameter in a PutSession request, the contents of the new summary view replaces the old summary view. For example, if a GetSession request returns three intents in the summary view and you call PutSession with one intent in the summary view, the next call to GetSession will only return one intent.

Returns a reference to this object so that method calls can be chained together.

Parameters:

recentIntentSummaryView -

A summary of the recent intents for the bot. You can use the intent summary view to set a checkpoint label on an intent and modify attributes of intents. You can also use it to remove or add intent summary objects to the list.

An intent that you modify or add to the list must make sense for the bot. For example, the intent name must be valid for the bot. You must provide valid values for:

• intentName

• slot names

• slotToElict

If you send the recentIntentSummaryView parameter in a PutSession request, the contents of the new summary view replaces the old summary view. For example, if a GetSession request returns three intents in the summary view and you call PutSession with one intent in the summary view, the next call to GetSession will only return one intent.

Returns:

A reference to this updated object so that method calls can be chained together.

getAccept

public java.lang.String getAccept()

The message that Amazon Lex returns in the response can be either text or speech based depending on the value of this field.

• If the value is text/plain; charset=utf-8, Amazon Lex returns text in the response.

• If the value begins with audio/, Amazon Lex returns speech in the response. Amazon Lex uses Amazon Polly to generate the speech in the configuration that you specify. For example, if you specify audio/mpeg as the value, Amazon Lex returns speech in the MPEG format.

• If the value is audio/pcm, the speech is returned as audio/pcm in 16-bit, little endian format.

• The following are the accepted values:

  • audio/mpeg

  • audio/ogg

  • audio/pcm

  • audio/* (defaults to mpeg)

  • text/plain; charset=utf-8

Returns:

The message that Amazon Lex returns in the response can be either text or speech based depending on the value of this field.

• If the value is text/plain; charset=utf-8, Amazon Lex returns text in the response.

• If the value begins with audio/, Amazon Lex returns speech in the response. Amazon Lex uses Amazon Polly to generate the speech in the configuration that you specify. For example, if you specify audio/mpeg as the value, Amazon Lex returns speech in the MPEG format.

• If the value is audio/pcm, the speech is returned as audio/pcm in 16-bit, little endian format.

• The following are the accepted values:

  • audio/mpeg

  • audio/ogg

  • audio/pcm

  • audio/* (defaults to mpeg)

  • text/plain; charset=utf-8

setAccept

public void setAccept(java.lang.String accept)

The message that Amazon Lex returns in the response can be either text or speech based depending on the value of this field.

• If the value is text/plain; charset=utf-8, Amazon Lex returns text in the response.

• If the value begins with audio/, Amazon Lex returns speech in the response. Amazon Lex uses Amazon Polly to generate the speech in the configuration that you specify. For example, if you specify audio/mpeg as the value, Amazon Lex returns speech in the MPEG format.

• If the value is audio/pcm, the speech is returned as audio/pcm in 16-bit, little endian format.

• The following are the accepted values:

  • audio/mpeg

  • audio/ogg

  • audio/pcm

  • audio/* (defaults to mpeg)

  • text/plain; charset=utf-8

Parameters:

accept -

The message that Amazon Lex returns in the response can be either text or speech based depending on the value of this field.

• If the value is text/plain; charset=utf-8, Amazon Lex returns text in the response.

• If the value begins with audio/, Amazon Lex returns speech in the response. Amazon Lex uses Amazon Polly to generate the speech in the configuration that you specify. For example, if you specify audio/mpeg as the value, Amazon Lex returns speech in the MPEG format.

• If the value is audio/pcm, the speech is returned as audio/pcm in 16-bit, little endian format.

• The following are the accepted values:

  • audio/mpeg

  • audio/ogg

  • audio/pcm

  • audio/* (defaults to mpeg)

  • text/plain; charset=utf-8

withAccept

public PutSessionRequest withAccept(java.lang.String accept)

The message that Amazon Lex returns in the response can be either text or speech based depending on the value of this field.

• If the value is text/plain; charset=utf-8, Amazon Lex returns text in the response.

• If the value begins with audio/, Amazon Lex returns speech in the response. Amazon Lex uses Amazon Polly to generate the speech in the configuration that you specify. For example, if you specify audio/mpeg as the value, Amazon Lex returns speech in the MPEG format.

• If the value is audio/pcm, the speech is returned as audio/pcm in 16-bit, little endian format.

• The following are the accepted values:

  • audio/mpeg

  • audio/ogg

  • audio/pcm

  • audio/* (defaults to mpeg)

  • text/plain; charset=utf-8

Returns a reference to this object so that method calls can be chained together.

Parameters:

accept -

The message that Amazon Lex returns in the response can be either text or speech based depending on the value of this field.

• If the value is text/plain; charset=utf-8, Amazon Lex returns text in the response.

• If the value begins with audio/, Amazon Lex returns speech in the response. Amazon Lex uses Amazon Polly to generate the speech in the configuration that you specify. For example, if you specify audio/mpeg as the value, Amazon Lex returns speech in the MPEG format.

• If the value is audio/pcm, the speech is returned as audio/pcm in 16-bit, little endian format.

• The following are the accepted values:

  • audio/mpeg

  • audio/ogg

  • audio/pcm

  • audio/* (defaults to mpeg)

  • text/plain; charset=utf-8

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object