software.amazon.awssdk.services.lexruntimev2.model

Class IntentResultEvent

java.lang.Object

software.amazon.awssdk.services.lexruntimev2.model.IntentResultEvent

All Implemented Interfaces:

Serializable, SdkPojo, StartConversationResponseEventStream, ToCopyableBuilder<IntentResultEvent.Builder,IntentResultEvent>

Direct Known Subclasses:

DefaultIntentResultEvent

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

Contains the current state of the conversation between the client application and Amazon Lex.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	IntentResultEvent.Builder
protected static class	IntentResultEvent.BuilderImpl

Nested classes/interfaces inherited from interface software.amazon.awssdk.services.lexruntimev2.model.StartConversationResponseEventStream

StartConversationResponseEventStream.EventType

Field Summary

Fields inherited from interface software.amazon.awssdk.services.lexruntimev2.model.StartConversationResponseEventStream

UNKNOWN

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IntentResultEvent(IntentResultEvent.BuilderImpl builder)

Method Summary

Modifier and Type	Method and Description
void	accept(StartConversationResponseHandler.Visitor visitor) Calls the appropriate visit method depending on the subtype of IntentResultEvent.
static IntentResultEvent.Builder	builder()
IntentResultEvent	copy(Consumer<? super IntentResultEvent.Builder> modifier)
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	eventId() A unique identifier of the event sent by Amazon Lex.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasInterpretations() Returns true if the Interpretations property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasRequestAttributes() Returns true if the RequestAttributes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
InputMode	inputMode() Indicates whether the input to the operation was text or speech.
String	inputModeAsString() Indicates whether the input to the operation was text or speech.
List<Interpretation>	interpretations() A list of intents that Amazon Lex determined might satisfy the user's utterance.
Map<String,String>	requestAttributes() The attributes sent in the request.
List<SdkField<?>>	sdkFields()
static Class<? extends IntentResultEvent.Builder>	serializableBuilderClass()
String	sessionId() The identifier of the session in use.
SessionState	sessionState() Returns the value of the SessionState property for this object.
IntentResultEvent.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.services.lexruntimev2.model.StartConversationResponseEventStream

audioResponseEventBuilder, heartbeatEventBuilder, intentResultEventBuilder, playbackInterruptionEventBuilder, sdkEventType, textResponseEventBuilder, transcriptEventBuilder

Constructor Detail

IntentResultEvent

protected IntentResultEvent(IntentResultEvent.BuilderImpl builder)

Method Detail

inputMode

public final InputMode inputMode()

Indicates whether the input to the operation was text or speech.

If the service returns an enum value that is not available in the current SDK version, inputMode will return InputMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from inputModeAsString().

Returns:

Indicates whether the input to the operation was text or speech.

See Also:

InputMode

inputModeAsString

public final String inputModeAsString()

Indicates whether the input to the operation was text or speech.

If the service returns an enum value that is not available in the current SDK version, inputMode will return InputMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from inputModeAsString().

Returns:

Indicates whether the input to the operation was text or speech.

See Also:

InputMode

hasInterpretations

public final boolean hasInterpretations()

Returns true if the Interpretations property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

interpretations

public final List<Interpretation> interpretations()

A list of intents that Amazon Lex determined might satisfy the user's utterance.

Each interpretation includes the intent, a score that indicates how confident Amazon Lex is that the interpretation is the correct one, and an optional sentiment response that indicates the sentiment expressed in the utterance.

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

You can use hasInterpretations() to see if a value was sent in this field.

Returns:

A list of intents that Amazon Lex determined might satisfy the user's utterance.

Each interpretation includes the intent, a score that indicates how confident Amazon Lex is that the interpretation is the correct one, and an optional sentiment response that indicates the sentiment expressed in the utterance.

sessionState

public final SessionState sessionState()

Returns the value of the SessionState property for this object.

Returns:

The value of the SessionState property for this object.

hasRequestAttributes

public final boolean hasRequestAttributes()

Returns true if the RequestAttributes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

requestAttributes

public final Map<String,String> requestAttributes()

The attributes sent in the request.

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

You can use hasRequestAttributes() to see if a value was sent in this field.

Returns:

The attributes sent in the request.

sessionId

public final String sessionId()

The identifier of the session in use.

Returns:

The identifier of the session in use.

eventId

public final String eventId()

A unique identifier of the event sent by Amazon Lex. The identifier is in the form RESPONSE-N, where N is a number starting with one and incremented for each event sent by Amazon Lex in the current session.

Returns:

A unique identifier of the event sent by Amazon Lex. The identifier is in the form RESPONSE-N, where N is a number starting with one and incremented for each event sent by Amazon Lex in the current session.

toBuilder

public IntentResultEvent.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<IntentResultEvent.Builder,IntentResultEvent>

builder

public static IntentResultEvent.Builder builder()

serializableBuilderClass

public static Class<? extends IntentResultEvent.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)

copy

public final IntentResultEvent copy(Consumer<? super IntentResultEvent.Builder> modifier)

Specified by:

copy in interface ToCopyableBuilder<IntentResultEvent.Builder,IntentResultEvent>

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

accept

public void accept(StartConversationResponseHandler.Visitor visitor)

Calls the appropriate visit method depending on the subtype of IntentResultEvent.

Specified by:

accept in interface StartConversationResponseEventStream

Parameters:

visitor - Visitor to invoke.