Class ActionReviewEvent

java.lang.Object
software.amazon.awssdk.services.qbusiness.model.ActionReviewEvent
All Implemented Interfaces:
Serializable, SdkPojo, ChatOutputStream, ToCopyableBuilder<ActionReviewEvent.Builder,ActionReviewEvent>
Direct Known Subclasses:
DefaultActionReviewEvent
@Generated("software.amazon.awssdk:codegen") public class ActionReviewEvent extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ActionReviewEvent.Builder,ActionReviewEvent>, ChatOutputStream

An output event that Amazon Q Business returns to an user who wants to perform a plugin action during a streaming chat conversation. It contains information about the selected action with a list of possible user input fields, some pre-populated by Amazon Q Business.

See Also:

  • Method Details

    • conversationId

      public final String conversationId()

      The identifier of the conversation with which the action review event is associated.

      Returns:
      The identifier of the conversation with which the action review event is associated.

    • userMessageId

      public final String userMessageId()

      The identifier of the conversation with which the plugin action is associated.

      Returns:
      The identifier of the conversation with which the plugin action is associated.

    • systemMessageId

      public final String systemMessageId()

      The identifier of an Amazon Q Business AI generated associated with the action review event.

      Returns:
      The identifier of an Amazon Q Business AI generated associated with the action review event.

    • pluginId

      public final String pluginId()

      The identifier of the plugin associated with the action review event.

      Returns:
      The identifier of the plugin associated with the action review event.

    • pluginType

      public final PluginType pluginType()

      The type of plugin.

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

      Returns:
      The type of plugin.
      See Also:

    • pluginTypeAsString

      public final String pluginTypeAsString()

      The type of plugin.

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

      Returns:
      The type of plugin.
      See Also:

    • hasPayload

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

    • payload

      public final Map<String,ActionReviewPayloadField> payload()

      Field values that an end user needs to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.

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

      Returns:
      Field values that an end user needs to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.

    • payloadFieldNameSeparator

      public final String payloadFieldNameSeparator()

      A string used to retain information about the hierarchical contexts within an action review event payload.

      Returns:
      A string used to retain information about the hierarchical contexts within an action review event payload.

    • toBuilder

      public ActionReviewEvent.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<ActionReviewEvent.Builder,ActionReviewEvent>
      Returns:
      a builder for type T

    • builder

      public static ActionReviewEvent.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ActionReviewEvent.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 ActionReviewEvent copy(Consumer<? super ActionReviewEvent.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<ActionReviewEvent.Builder,ActionReviewEvent>
      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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.

    • accept

      public void accept(ChatResponseHandler.Visitor visitor)
      Calls the appropriate visit method depending on the subtype of ActionReviewEvent.
      Specified by:
      accept in interface ChatOutputStream
      Parameters:
      visitor - Visitor to invoke.