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("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 V2.

See Also:
  • Method Details

    • inputMode

      public final InputMode inputMode()

      Indicates whether the input to the operation was text, speech, or from a touch-tone keypad.

      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, speech, or from a touch-tone keypad.
      See Also:
    • inputModeAsString

      public final String inputModeAsString()

      Indicates whether the input to the operation was text, speech, or from a touch-tone keypad.

      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, speech, or from a touch-tone keypad.
      See Also:
    • hasInterpretations

      public final boolean hasInterpretations()
      For responses, this returns true if the service returned a value for the Interpretations 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.
    • interpretations

      public final List<Interpretation> interpretations()

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

      Each interpretation includes the intent, a score that indicates how confident Amazon Lex V2 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.

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

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

      Each interpretation includes the intent, a score that indicates how confident Amazon Lex V2 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()
      For responses, this returns true if the service returned a value for the RequestAttributes 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.
    • 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.

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

      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 V2. 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 V2 in the current session.

      Returns:
      A unique identifier of the event sent by Amazon Lex V2. 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 V2 in the current session.
    • recognizedBotMember

      public final RecognizedBotMember recognizedBotMember()

      The bot member that is processing the intent.

      Returns:
      The bot member that is processing the intent.
    • toBuilder

      public IntentResultEvent.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<IntentResultEvent.Builder,IntentResultEvent>
      Returns:
      a builder for type T
    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.
    • 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)
      Description copied from interface: ToCopyableBuilder
      A convenience method for calling ToCopyableBuilder.toBuilder(), updating the returned builder and then calling SdkBuilder.build(). This is useful for making small modifications to the existing object.
      Specified by:
      copy in interface ToCopyableBuilder<IntentResultEvent.Builder,IntentResultEvent>
      Parameters:
      modifier - A function that mutates this immutable object using the provided builder.
      Returns:
      A new copy of this object with the requested modifications.
    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.
    • 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.