software.amazon.awssdk.services.lexruntimev2.model

Class ActiveContext

java.lang.Object

software.amazon.awssdk.services.lexruntimev2.model.ActiveContext

All Implemented Interfaces:

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

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

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ActiveContext.Builder

Method Summary

Modifier and Type	Method and Description
static ActiveContext.Builder	builder()
Map<String,String>	contextAttributes() A list of contexts active for the request.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasContextAttributes() For responses, this returns true if the service returned a value for the ContextAttributes property.
int	hashCode()
String	name() The name of the context.
List<SdkField<?>>	sdkFields()
static Class<? extends ActiveContext.Builder>	serializableBuilderClass()
ActiveContextTimeToLive	timeToLive() Indicates the number of turns or seconds that the context is 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()

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.

hasContextAttributes

public final boolean hasContextAttributes()

For responses, this returns true if the service returned a value for the ContextAttributes 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.

contextAttributes

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

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 hasContextAttributes() method.

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.

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