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

Class ConfigurationEvent

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

A configuration event activated by an end user request to select a specific chat mode.

See Also:

  • Method Details

    • chatMode

      public final ChatMode chatMode()

      The chat modes available to an Amazon Q Business end user.

      • RETRIEVAL_MODE - The default chat mode for an Amazon Q Business application. When this mode is enabled, Amazon Q Business generates responses only from data sources connected to an Amazon Q Business application.

      • CREATOR_MODE - By selecting this mode, users can choose to generate responses only from the LLM knowledge, without consulting connected data sources, for a chat request.

      • PLUGIN_MODE - By selecting this mode, users can choose to use plugins in chat.

      For more information, see Admin controls and guardrails, Plugins, and Conversation settings.

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

      Returns:
      The chat modes available to an Amazon Q Business end user.

      • RETRIEVAL_MODE - The default chat mode for an Amazon Q Business application. When this mode is enabled, Amazon Q Business generates responses only from data sources connected to an Amazon Q Business application.

      • CREATOR_MODE - By selecting this mode, users can choose to generate responses only from the LLM knowledge, without consulting connected data sources, for a chat request.

      • PLUGIN_MODE - By selecting this mode, users can choose to use plugins in chat.

      For more information, see Admin controls and guardrails, Plugins, and Conversation settings.

      See Also:

    • chatModeAsString

      public final String chatModeAsString()

      The chat modes available to an Amazon Q Business end user.

      • RETRIEVAL_MODE - The default chat mode for an Amazon Q Business application. When this mode is enabled, Amazon Q Business generates responses only from data sources connected to an Amazon Q Business application.

      • CREATOR_MODE - By selecting this mode, users can choose to generate responses only from the LLM knowledge, without consulting connected data sources, for a chat request.

      • PLUGIN_MODE - By selecting this mode, users can choose to use plugins in chat.

      For more information, see Admin controls and guardrails, Plugins, and Conversation settings.

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

      Returns:
      The chat modes available to an Amazon Q Business end user.

      • RETRIEVAL_MODE - The default chat mode for an Amazon Q Business application. When this mode is enabled, Amazon Q Business generates responses only from data sources connected to an Amazon Q Business application.

      • CREATOR_MODE - By selecting this mode, users can choose to generate responses only from the LLM knowledge, without consulting connected data sources, for a chat request.

      • PLUGIN_MODE - By selecting this mode, users can choose to use plugins in chat.

      For more information, see Admin controls and guardrails, Plugins, and Conversation settings.

      See Also:

    • chatModeConfiguration

      public final ChatModeConfiguration chatModeConfiguration()
      Returns the value of the ChatModeConfiguration property for this object.
      Returns:
      The value of the ChatModeConfiguration property for this object.

    • attributeFilter

      public final AttributeFilter attributeFilter()
      Returns the value of the AttributeFilter property for this object.
      Returns:
      The value of the AttributeFilter property for this object.

    • toBuilder

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

    • builder

      public static ConfigurationEvent.Builder builder()

    • serializableBuilderClass

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