ActiveContext (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.lexruntime.model.ActiveContext

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ActiveContext
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ActiveContext()

Constructors
Constructor and Description
`ActiveContext()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ActiveContext`	`addParametersEntry(String key, String value)` Add a single Parameters entry
`ActiveContext`	`clearParametersEntries()` Removes all the entries added into Parameters.
`ActiveContext`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getName()` The name of the context.
`Map<String,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`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setName(String name)` The name of the context.
`void`	`setParameters(Map<String,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.
`String`	`toString()` Returns a string representation of this object.
`ActiveContext`	`withName(String name)` The name of the context.
`ActiveContext`	`withParameters(Map<String,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
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ActiveContext
```
public ActiveContext()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The name of the context.
    
    Parameters:
    
    name - The name of the context.
  - getName
```
public String getName()
```
    The name of the context.
    
    Returns:
    
    The name of the context.
  - withName
```
public ActiveContext withName(String name)
```
    The name of the context.
    
    Parameters:
    
    name - The name of the context.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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.
  - 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.
  - withTimeToLive
```
public ActiveContext withTimeToLive(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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getParameters
```
public Map<String,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(Map<String,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(Map<String,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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addParametersEntry
```
public ActiveContext addParametersEntry(String key,
                                        String value)
```
    Add a single Parameters entry
    
    See Also:
    
    withParameters(java.util.Map<java.lang.String, java.lang.String>)
  - clearParametersEntries
```
public ActiveContext clearParametersEntries()
```
    Removes all the entries added into Parameters.
    
    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 ActiveContext 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.

Did this page help you?

Class ActiveContext

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ActiveContext

Method Detail

setName

getName

withName

setTimeToLive

getTimeToLive

withTimeToLive

getParameters

setParameters

withParameters

addParametersEntry

clearParametersEntries

toString

equals

hashCode

clone

marshall