Class UpdateChatControlsConfigurationRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<UpdateChatControlsConfigurationRequest.Builder,
UpdateChatControlsConfigurationRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The identifier of the application for which the chat controls are configured.The phrases blocked from chat by your chat control configuration.builder()
final String
A token that you provide to identify the request to update a Amazon Q Business application chat configuration.final CreatorModeConfiguration
The configuration details forCREATOR_MODE
.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the TopicConfigurationsToCreateOrUpdate property.final boolean
For responses, this returns true if the service returned a value for the TopicConfigurationsToDelete property.final ResponseScope
The response scope configured for your application.final String
The response scope configured for your application.static Class
<? extends UpdateChatControlsConfigurationRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final List
<TopicConfiguration> The configured topic specific chat controls you want to update.final List
<TopicConfiguration> The configured topic specific chat controls you want to delete.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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
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 returnResponseScope.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromresponseScopeAsString()
.- 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
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 returnResponseScope.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromresponseScopeAsString()
.- 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
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 theisEmpty()
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
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 theisEmpty()
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
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
The configuration details for
CREATOR_MODE
.- Returns:
- The configuration details for
CREATOR_MODE
.
-
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 interfaceToCopyableBuilder<UpdateChatControlsConfigurationRequest.Builder,
UpdateChatControlsConfigurationRequest> - Specified by:
toBuilder
in classQBusinessRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends UpdateChatControlsConfigurationRequest.Builder> serializableBuilderClass() -
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-