com.amazonaws.services.lexrts.model

Class ActiveContext

java.lang.Object

com.amazonaws.services.lexrts.model.ActiveContext

All Implemented Interfaces:

java.io.Serializable

public class ActiveContext
extends java.lang.Object
implements java.io.Serializable

A context is a variable that contains information about the current state of the conversation between a user and Amazon Lex. Context can be set automatically by Amazon Lex when an intent is fulfilled, or it can be set at runtime using the PutContent, PutText, or PutSession operation.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ActiveContext()

Method Summary

Modifier and Type	Method and Description
ActiveContext	addparametersEntry(java.lang.String key, java.lang.String value) State variables for the current context.
ActiveContext	clearparametersEntries() Removes all the entries added into parameters.
boolean	equals(java.lang.Object obj)
java.lang.String	getName() The name of the context.
java.util.Map<java.lang.String,java.lang.String>	getParameters() State variables for the current context.
ActiveContextTimeToLive	getTimeToLive() The length of time or number of turns that a context remains active.
int	hashCode()
void	setName(java.lang.String name) The name of the context.
void	setParameters(java.util.Map<java.lang.String,java.lang.String> parameters) State variables for the current context.
void	setTimeToLive(ActiveContextTimeToLive timeToLive) The length of time or number of turns that a context remains active.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
ActiveContext	withName(java.lang.String name) The name of the context.
ActiveContext	withParameters(java.util.Map<java.lang.String,java.lang.String> parameters) State variables for the current context.
ActiveContext	withTimeToLive(ActiveContextTimeToLive timeToLive) The length of time or number of turns that a context remains active.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ActiveContext

public ActiveContext()

Method Detail

getName

public java.lang.String getName()

The name of the context.

Constraints:
Length: 1 - 100
Pattern: ^([A-Za-z]_?)+$

Returns:

The name of the context.

setName

public void setName(java.lang.String name)

The name of the context.

Constraints:
Length: 1 - 100
Pattern: ^([A-Za-z]_?)+$

Parameters:

name -

The name of the context.

withName

public ActiveContext withName(java.lang.String name)

The name of the context.

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

Constraints:
Length: 1 - 100
Pattern: ^([A-Za-z]_?)+$

Parameters:

name -

The name of the context.

Returns:

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

getTimeToLive

public ActiveContextTimeToLive getTimeToLive()

The length of time or number of turns that a context remains active.

Returns:

The length of time or number of turns that a context remains active.

setTimeToLive

public void setTimeToLive(ActiveContextTimeToLive timeToLive)

The length of time or number of turns that a context remains active.

Parameters:

timeToLive -

The length of time or number of turns that a context remains active.

withTimeToLive

public ActiveContext withTimeToLive(ActiveContextTimeToLive timeToLive)

The length of time or number of turns that a context remains active.

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

Parameters:

timeToLive -

The length of time or number of turns that a context remains active.

Returns:

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

getParameters

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

State variables for the current context. You can use these values as default values for slots in subsequent events.

Returns:

State variables for the current context. You can use these values as default values for slots in subsequent events.

setParameters

public void setParameters(java.util.Map<java.lang.String,java.lang.String> parameters)

State variables for the current context. You can use these values as default values for slots in subsequent events.

Parameters:

parameters -

State variables for the current context. You can use these values as default values for slots in subsequent events.

withParameters

public ActiveContext withParameters(java.util.Map<java.lang.String,java.lang.String> parameters)

State variables for the current context. You can use these values as default values for slots in subsequent events.

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

Parameters:

parameters -

State variables for the current context. You can use these values as default values for slots in subsequent events.

Returns:

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

addparametersEntry

public ActiveContext addparametersEntry(java.lang.String key,
                                        java.lang.String value)

State variables for the current context. You can use these values as default values for slots in subsequent events.

The method adds a new key-value pair into parameters 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 parameters.

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

Returns:

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

clearparametersEntries

public ActiveContext clearparametersEntries()

Removes all the entries added into parameters.

Returns a reference to this 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