TopicConfiguration (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.qbusiness.model.TopicConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class TopicConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo
```
The topic specific controls configured for an Amazon Q Business application.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

TopicConfiguration()

Constructors
Constructor and Description
`TopicConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TopicConfiguration`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getDescription()` A description for your topic control configuration.
`List<String>`	`getExampleChatMessages()` A list of example phrases that you expect the end user to use in relation to the topic.
`String`	`getName()` A name for your topic control configuration.
`List<Rule>`	`getRules()` Rules defined for a topic configuration.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDescription(String description)` A description for your topic control configuration.
`void`	`setExampleChatMessages(Collection<String> exampleChatMessages)` A list of example phrases that you expect the end user to use in relation to the topic.
`void`	`setName(String name)` A name for your topic control configuration.
`void`	`setRules(Collection<Rule> rules)` Rules defined for a topic configuration.
`String`	`toString()` Returns a string representation of this object.
`TopicConfiguration`	`withDescription(String description)` A description for your topic control configuration.
`TopicConfiguration`	`withExampleChatMessages(Collection<String> exampleChatMessages)` A list of example phrases that you expect the end user to use in relation to the topic.
`TopicConfiguration`	`withExampleChatMessages(String... exampleChatMessages)` A list of example phrases that you expect the end user to use in relation to the topic.
`TopicConfiguration`	`withName(String name)` A name for your topic control configuration.
`TopicConfiguration`	`withRules(Collection<Rule> rules)` Rules defined for a topic configuration.
`TopicConfiguration`	`withRules(Rule... rules)` Rules defined for a topic configuration.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - TopicConfiguration
```
public TopicConfiguration()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    A name for your topic control configuration.
    
    Parameters:
    
    name - A name for your topic control configuration.
  - getName
```
public String getName()
```
    A name for your topic control configuration.
    
    Returns:
    
    A name for your topic control configuration.
  - withName
```
public TopicConfiguration withName(String name)
```
    A name for your topic control configuration.
    
    Parameters:
    
    name - A name for your topic control configuration.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(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.
    
    Parameters:
    
    description - A description for your topic control configuration. Use this to outline how the large language model (LLM) should use this topic control configuration.
  - getDescription
```
public String getDescription()
```
    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.
  - withDescription
```
public TopicConfiguration withDescription(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - getExampleChatMessages
```
public List<String> getExampleChatMessages()
```
    A list of example phrases that you expect the end user to use in relation to the topic.
    
    Returns:
    
    A list of example phrases that you expect the end user to use in relation to the topic.
  - setExampleChatMessages
```
public void setExampleChatMessages(Collection<String> exampleChatMessages)
```
    A list of example phrases that you expect the end user to use in relation to the topic.
    
    Parameters:
    
    exampleChatMessages - A list of example phrases that you expect the end user to use in relation to the topic.
  - withExampleChatMessages
```
public TopicConfiguration withExampleChatMessages(String... exampleChatMessages)
```
    A list of example phrases that you expect the end user to use in relation to the topic.
    
    NOTE: This method appends the values to the existing list (if any). Use setExampleChatMessages(java.util.Collection) or withExampleChatMessages(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    exampleChatMessages - A list of example phrases that you expect the end user to use in relation to the topic.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withExampleChatMessages
```
public TopicConfiguration withExampleChatMessages(Collection<String> exampleChatMessages)
```
    A list of example phrases that you expect the end user to use in relation to the topic.
    
    Parameters:
    
    exampleChatMessages - A list of example phrases that you expect the end user to use in relation to the topic.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getRules
```
public List<Rule> getRules()
```
    Rules defined for a topic configuration.
    
    Returns:
    
    Rules defined for a topic configuration.
  - setRules
```
public void setRules(Collection<Rule> rules)
```
    Rules defined for a topic configuration.
    
    Parameters:
    
    rules - Rules defined for a topic configuration.
  - withRules
```
public TopicConfiguration withRules(Rule... rules)
```
    Rules defined for a topic configuration.
    
    NOTE: This method appends the values to the existing list (if any). Use setRules(java.util.Collection) or withRules(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    rules - Rules defined for a topic configuration.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withRules
```
public TopicConfiguration withRules(Collection<Rule> rules)
```
    Rules defined for a topic configuration.
    
    Parameters:
    
    rules - Rules defined for a topic configuration.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public TopicConfiguration clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.793

Class TopicConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TopicConfiguration

Method Detail

setName

getName

withName

setDescription

getDescription

withDescription

getExampleChatMessages

setExampleChatMessages

withExampleChatMessages

withExampleChatMessages

getRules

setRules

withRules

withRules

toString

equals

hashCode

clone

marshall