Class UpdateChatControlsConfigurationRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.qbusiness.model.QBusinessRequest
software.amazon.awssdk.services.qbusiness.model.UpdateChatControlsConfigurationRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateChatControlsConfigurationRequest.Builder,UpdateChatControlsConfigurationRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateChatControlsConfigurationRequest extends QBusinessRequest implements ToCopyableBuilder<UpdateChatControlsConfigurationRequest.Builder,UpdateChatControlsConfigurationRequest>

  • Method Details

    • applicationId

      public final String applicationId()

      The identifier of the application for which the chat controls are configured.

      Returns:
      The identifier of the application for which the chat controls are configured.

    • clientToken

      public final String clientToken()

      A token that you provide to identify the request to update a Amazon Q Business application chat configuration.

      Returns:
      A token that you provide to identify the request to update a Amazon Q Business application chat configuration.

    • responseScope

      public final ResponseScope responseScope()

      The response scope configured for your application. This determines whether your application uses its retrieval augmented generation (RAG) system to generate answers only from your enterprise data, or also uses the large language models (LLM) knowledge to respons to end user questions in chat.

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

      Returns:
      The response scope configured for your application. This determines whether your application uses its retrieval augmented generation (RAG) system to generate answers only from your enterprise data, or also uses the large language models (LLM) knowledge to respons to end user questions in chat.
      See Also:

    • responseScopeAsString

      public final String responseScopeAsString()

      The response scope configured for your application. This determines whether your application uses its retrieval augmented generation (RAG) system to generate answers only from your enterprise data, or also uses the large language models (LLM) knowledge to respons to end user questions in chat.

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

      Returns:
      The response scope configured for your application. This determines whether your application uses its retrieval augmented generation (RAG) system to generate answers only from your enterprise data, or also uses the large language models (LLM) knowledge to respons to end user questions in chat.
      See Also:

    • blockedPhrasesConfigurationUpdate

      public final BlockedPhrasesConfigurationUpdate blockedPhrasesConfigurationUpdate()

      The phrases blocked from chat by your chat control configuration.

      Returns:
      The phrases blocked from chat by your chat control configuration.

    • hasTopicConfigurationsToCreateOrUpdate

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

    • topicConfigurationsToCreateOrUpdate

      public final List<TopicConfiguration> topicConfigurationsToCreateOrUpdate()

      The configured topic specific chat controls you want to update.

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

      Returns:
      The configured topic specific chat controls you want to update.

    • hasTopicConfigurationsToDelete

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

    • topicConfigurationsToDelete

      public final List<TopicConfiguration> topicConfigurationsToDelete()

      The configured topic specific chat controls you want to delete.

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

      Returns:
      The configured topic specific chat controls you want to delete.

    • creatorModeConfiguration

      public final CreatorModeConfiguration creatorModeConfiguration()

      The configuration details for CREATOR_MODE.

      Returns:
      The configuration details for CREATOR_MODE.

    • toBuilder

      public UpdateChatControlsConfigurationRequest.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<UpdateChatControlsConfigurationRequest.Builder,UpdateChatControlsConfigurationRequest>
      Specified by:
      toBuilder in class QBusinessRequest
      Returns:
      a builder for type T

    • builder

      public static UpdateChatControlsConfigurationRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UpdateChatControlsConfigurationRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • 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.