Class ChatResponseConfiguration

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

Configuration details that define how Amazon Q Business generates and formats responses to user queries in chat interactions. This configuration allows administrators to customize response characteristics to meet specific organizational needs and communication standards.

See Also:

  • Method Details

    • chatResponseConfigurationId

      public final String chatResponseConfigurationId()

      A unique identifier for your chat response configuration settings, used to reference and manage the configuration within the Amazon Q Business service.

      Returns:
      A unique identifier for your chat response configuration settings, used to reference and manage the configuration within the Amazon Q Business service.

    • chatResponseConfigurationArn

      public final String chatResponseConfigurationArn()

      The Amazon Resource Name (ARN) of the chat response configuration, which uniquely identifies the resource across all Amazon Web Services services and accounts.

      Returns:
      The Amazon Resource Name (ARN) of the chat response configuration, which uniquely identifies the resource across all Amazon Web Services services and accounts.

    • displayName

      public final String displayName()

      A human-readable name for the chat response configuration, making it easier to identify and manage multiple configurations within an organization.

      Returns:
      A human-readable name for the chat response configuration, making it easier to identify and manage multiple configurations within an organization.

    • responseConfigurationSummary

      public final String responseConfigurationSummary()

      A summary of the response configuration settings, providing a concise overview of the key parameters that define how responses are generated and formatted.

      Returns:
      A summary of the response configuration settings, providing a concise overview of the key parameters that define how responses are generated and formatted.

    • 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 in chat interactions.

      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 in chat interactions.
      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 in chat interactions.

      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 in chat interactions.
      See Also:

    • createdAt

      public final Instant createdAt()

      The timestamp indicating when the chat response configuration was initially created, useful for tracking the lifecycle of configuration resources.

      Returns:
      The timestamp indicating when the chat response configuration was initially created, useful for tracking the lifecycle of configuration resources.

    • updatedAt

      public final Instant updatedAt()

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

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

    • toBuilder

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

    • builder

      public static ChatResponseConfiguration.Builder builder()

    • serializableBuilderClass

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