Class ActionSummary

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

Summary information for an Amazon Q Business plugin action.

See Also:

  • Method Details

    • actionIdentifier

      public final String actionIdentifier()

      The identifier of an Amazon Q Business plugin action.

      Returns:
      The identifier of an Amazon Q Business plugin action.

    • displayName

      public final String displayName()

      The display name assigned by Amazon Q Business to a plugin action. You can't modify this value.

      Returns:
      The display name assigned by Amazon Q Business to a plugin action. You can't modify this value.

    • instructionExample

      public final String instructionExample()

      An Amazon Q Business suggested prompt and end user can use to invoke a plugin action. This value can be modified and sent as input to initiate an action. For example:

      • Create a Jira task

      • Create a chat assistant task to find the root cause of a specific incident

      Returns:
      An Amazon Q Business suggested prompt and end user can use to invoke a plugin action. This value can be modified and sent as input to initiate an action. For example:

      • Create a Jira task

      • Create a chat assistant task to find the root cause of a specific incident

    • description

      public final String description()

      The description of an Amazon Q Business plugin action.

      Returns:
      The description of an Amazon Q Business plugin action.

    • toBuilder

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

    • builder

      public static ActionSummary.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

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