Class TopicConfiguration

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

The topic specific controls configured for an Amazon Q Business application.

See Also:

  • Method Details

    • name

      public final String name()

      A name for your topic control configuration.

      Returns:
      A name for your topic control configuration.

    • description

      public final String description()

      A description for your topic control configuration. Use this to outline how the large language model (LLM) should use this topic control configuration.

      Returns:
      A description for your topic control configuration. Use this to outline how the large language model (LLM) should use this topic control configuration.

    • hasExampleChatMessages

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

    • exampleChatMessages

      public final List<String> exampleChatMessages()

      A list of example phrases that you expect the end user to use in relation to the topic.

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

      Returns:
      A list of example phrases that you expect the end user to use in relation to the topic.

    • hasRules

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

    • rules

      public final List<Rule> rules()

      Rules defined for a topic configuration.

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

      Returns:
      Rules defined for a topic configuration.

    • toBuilder

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

    • builder

      public static TopicConfiguration.Builder builder()

    • serializableBuilderClass

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