Package software.amazon.awssdk.services.lexruntime.model

Class ActiveContext

java.lang.Object

software.amazon.awssdk.services.lexruntime.model.ActiveContext

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ActiveContext.Builder,ActiveContext>

@Generated("software.amazon.awssdk:codegen")
public final class ActiveContext
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ActiveContext.Builder,ActiveContext>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ActiveContext.Builder

Method Summary

Modifier and Type	Method	Description
static ActiveContext.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasParameters()	For responses, this returns true if the service returned a value for the Parameters property.
String	name()	The name of the context.
Map<String,String>	parameters()	State variables for the current context.
List<SdkField<?>>	sdkFields()
static Class<? extends ActiveContext.Builder>	serializableBuilderClass()
ActiveContextTimeToLive	timeToLive()	The length of time or number of turns that a context remains active.
ActiveContext.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

name

public final String name()

The name of the context.

Returns:

The name of the context.

timeToLive

public final ActiveContextTimeToLive timeToLive()

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.

hasParameters

public final boolean hasParameters()

For responses, this returns true if the service returned a value for the Parameters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

parameters

public final Map<String,String> parameters()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasParameters() method.

Returns:

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

toBuilder

public ActiveContext.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ActiveContext.Builder,ActiveContext>

builder

public static ActiveContext.Builder builder()

serializableBuilderClass

public static Class<? extends ActiveContext.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo