Package software.amazon.awssdk.services.qbusiness.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TopicConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static TopicConfiguration.Builder	builder()
String	description()	A description for your topic control configuration.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<String>	exampleChatMessages()	A list of example phrases that you expect the end user to use in relation to the topic.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasExampleChatMessages()	For responses, this returns true if the service returned a value for the ExampleChatMessages property.
int	hashCode()
boolean	hasRules()	For responses, this returns true if the service returned a value for the Rules property.
String	name()	A name for your topic control configuration.
List<Rule>	rules()	Rules defined for a topic configuration.
List<SdkField<?>>	sdkFields()
static Class<? extends TopicConfiguration.Builder>	serializableBuilderClass()
TopicConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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()

Specified by:

toBuilder in interface ToCopyableBuilder<TopicConfiguration.Builder,TopicConfiguration>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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