Class ChatResponseConfigurationDetail

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

Detailed information about a chat response configuration, including comprehensive settings and parameters that define how Amazon Q Business generates and formats responses.

See Also:

  • Method Details

    • responseConfigurations

      public final Map<ResponseConfigurationType,ResponseConfiguration> responseConfigurations()

      A collection of specific response configuration settings that collectively define how responses are generated, formatted, and presented to users in chat interactions.

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

      Returns:
      A collection of specific response configuration settings that collectively define how responses are generated, formatted, and presented to users in chat interactions.

    • hasResponseConfigurations

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

    • responseConfigurationsAsStrings

      public final Map<String,ResponseConfiguration> responseConfigurationsAsStrings()

      A collection of specific response configuration settings that collectively define how responses are generated, formatted, and presented to users in chat interactions.

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

      Returns:
      A collection of specific response configuration settings that collectively define how responses are generated, formatted, and presented to users in chat interactions.

    • responseConfigurationSummary

      public final String responseConfigurationSummary()

      A summary of the response configuration details, providing a concise overview of the key parameters and settings that define the response generation behavior.

      Returns:
      A summary of the response configuration details, providing a concise overview of the key parameters and settings that define the response generation behavior.

    • status

      public final ChatResponseConfigurationStatus status()

      The current status of the chat response configuration, indicating whether it is active, pending, or in another state that affects its availability for use.

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

      Returns:
      The current status of the chat response configuration, indicating whether it is active, pending, or in another state that affects its availability for use.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the chat response configuration, indicating whether it is active, pending, or in another state that affects its availability for use.

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

      Returns:
      The current status of the chat response configuration, indicating whether it is active, pending, or in another state that affects its availability for use.
      See Also:

    • error

      public final ErrorDetail error()
      Returns the value of the Error property for this object.
      Returns:
      The value of the Error property for this object.

    • updatedAt

      public final Instant updatedAt()

      The timestamp indicating when the detailed chat response configuration was last modified, helping administrators track changes and maintain version awareness.

      Returns:
      The timestamp indicating when the detailed chat response configuration was last modified, helping administrators track changes and maintain version awareness.

    • toBuilder

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

    • builder

      public static ChatResponseConfigurationDetail.Builder builder()

    • serializableBuilderClass

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