ActiveContext (AWS Java SDK for Amazon Lex Runtime V2 1.12.387 API)

java.lang.Object
- com.amazonaws.services.lexruntimev2.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
```
Contains information about the contexts that a user is using in a session. You can configure Amazon Lex V2 to set a context when an intent is fulfilled, or you can set a context using the , , or operations.

Use a context to indicate to Amazon Lex V2 intents that should be used as follow-up intents. For example, if the active context is order-fulfilled, only intents that have order-fulfilled configured as a trigger are considered for follow up.

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`	`addContextAttributesEntry(String key, String value)` Add a single ContextAttributes entry
`ActiveContext`	`clearContextAttributesEntries()` Removes all the entries added into ContextAttributes.
`ActiveContext`	`clone()`
`boolean`	`equals(Object obj)`
`Map<String,String>`	`getContextAttributes()` A list of contexts active for the request.
`String`	`getName()` The name of the context.
`ActiveContextTimeToLive`	`getTimeToLive()` Indicates the number of turns or seconds that the context is active.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setContextAttributes(Map<String,String> contextAttributes)` A list of contexts active for the request.
`void`	`setName(String name)` The name of the context.
`void`	`setTimeToLive(ActiveContextTimeToLive timeToLive)` Indicates the number of turns or seconds that the context is active.
`String`	`toString()` Returns a string representation of this object.
`ActiveContext`	`withContextAttributes(Map<String,String> contextAttributes)` A list of contexts active for the request.
`ActiveContext`	`withName(String name)` The name of the context.
`ActiveContext`	`withTimeToLive(ActiveContextTimeToLive timeToLive)` Indicates the number of turns or seconds that the context is active.

Methods inherited from class java.lang.Object
finalize, 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)
```
    Indicates the number of turns or seconds that the context is active. Once the time to live expires, the context is no longer returned in a response.
    
    Parameters:
    
    timeToLive - Indicates the number of turns or seconds that the context is active. Once the time to live expires, the context is no longer returned in a response.
  - getTimeToLive
```
public ActiveContextTimeToLive getTimeToLive()
```
    Indicates the number of turns or seconds that the context is active. Once the time to live expires, the context is no longer returned in a response.
    
    Returns:
    
    Indicates the number of turns or seconds that the context is active. Once the time to live expires, the context is no longer returned in a response.
  - withTimeToLive
```
public ActiveContext withTimeToLive(ActiveContextTimeToLive timeToLive)
```
    Indicates the number of turns or seconds that the context is active. Once the time to live expires, the context is no longer returned in a response.
    
    Parameters:
    
    timeToLive - Indicates the number of turns or seconds that the context is active. Once the time to live expires, the context is no longer returned in a response.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getContextAttributes
```
public Map<String,String> getContextAttributes()
```
    A list of contexts active for the request. A context can be activated when a previous intent is fulfilled, or by including the context in the request.
    
    If you don't specify a list of contexts, Amazon Lex V2 will use the current list of contexts for the session. If you specify an empty list, all contexts for the session are cleared.
    
    Returns:
    
    A list of contexts active for the request. A context can be activated when a previous intent is fulfilled, or by including the context in the request.
    
    If you don't specify a list of contexts, Amazon Lex V2 will use the current list of contexts for the session. If you specify an empty list, all contexts for the session are cleared.
  - setContextAttributes
```
public void setContextAttributes(Map<String,String> contextAttributes)
```
    A list of contexts active for the request. A context can be activated when a previous intent is fulfilled, or by including the context in the request.
    
    If you don't specify a list of contexts, Amazon Lex V2 will use the current list of contexts for the session. If you specify an empty list, all contexts for the session are cleared.
    
    Parameters:
    
    contextAttributes - A list of contexts active for the request. A context can be activated when a previous intent is fulfilled, or by including the context in the request.
    
    If you don't specify a list of contexts, Amazon Lex V2 will use the current list of contexts for the session. If you specify an empty list, all contexts for the session are cleared.
  - withContextAttributes
```
public ActiveContext withContextAttributes(Map<String,String> contextAttributes)
```
    A list of contexts active for the request. A context can be activated when a previous intent is fulfilled, or by including the context in the request.
    
    If you don't specify a list of contexts, Amazon Lex V2 will use the current list of contexts for the session. If you specify an empty list, all contexts for the session are cleared.
    
    Parameters:
    
    contextAttributes - A list of contexts active for the request. A context can be activated when a previous intent is fulfilled, or by including the context in the request.
    
    If you don't specify a list of contexts, Amazon Lex V2 will use the current list of contexts for the session. If you specify an empty list, all contexts for the session are cleared.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addContextAttributesEntry
```
public ActiveContext addContextAttributesEntry(String key,
                                               String value)
```
    Add a single ContextAttributes entry
    
    See Also:
    
    withContextAttributes(java.util.Map<java.lang.String, java.lang.String>)
  - clearContextAttributesEntries
```
public ActiveContext clearContextAttributesEntries()
```
    Removes all the entries added into ContextAttributes.
    
    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)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class ActiveContext

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ActiveContext

Method Detail

setName

getName

withName

setTimeToLive

getTimeToLive

withTimeToLive

getContextAttributes

setContextAttributes

withContextAttributes

addContextAttributesEntry

clearContextAttributesEntries

toString

equals

hashCode

clone

marshall