Package software.amazon.awssdk.services.qbusiness.model

Class ActionExecution

java.lang.Object
software.amazon.awssdk.services.qbusiness.model.ActionExecution
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ActionExecution.Builder,ActionExecution>
@Generated("software.amazon.awssdk:codegen") public final class ActionExecution extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ActionExecution.Builder,ActionExecution>

Performs an Amazon Q Business plugin action during a non-streaming chat conversation.

See Also:

  • Method Details

    • pluginId

      public final String pluginId()

      The identifier of the plugin the action is attached to.

      Returns:
      The identifier of the plugin the action is attached to.

    • 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,ActionExecutionPayloadField> payload()

      A mapping of field names to the field values in input that an end user provides to Amazon Q Business requests to perform their 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:
      A mapping of field names to the field values in input that an end user provides to Amazon Q Business requests to perform their plugin action.

    • payloadFieldNameSeparator

      public final String payloadFieldNameSeparator()

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

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

    • toBuilder

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

    • builder

      public static ActionExecution.Builder builder()

    • serializableBuilderClass

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

    • 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.