Interface RegisteredUserQSearchBarEmbeddingConfiguration.Builder

All Superinterfaces:

Buildable, CopyableBuilder<RegisteredUserQSearchBarEmbeddingConfiguration.Builder,RegisteredUserQSearchBarEmbeddingConfiguration>, SdkBuilder<RegisteredUserQSearchBarEmbeddingConfiguration.Builder,RegisteredUserQSearchBarEmbeddingConfiguration>, SdkPojo

Enclosing class:

RegisteredUserQSearchBarEmbeddingConfiguration

@Mutable
@NotThreadSafe
public static interface RegisteredUserQSearchBarEmbeddingConfiguration.Builder
extends SdkPojo, CopyableBuilder<RegisteredUserQSearchBarEmbeddingConfiguration.Builder,RegisteredUserQSearchBarEmbeddingConfiguration>

Method Summary

Modifier and Type	Method	Description
RegisteredUserQSearchBarEmbeddingConfiguration.Builder	initialTopicId(String initialTopicId)	The ID of the legacy Q topic that you want to use as the starting topic in the Q search bar.

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

initialTopicId

RegisteredUserQSearchBarEmbeddingConfiguration.Builder initialTopicId(String initialTopicId)

The ID of the legacy Q topic that you want to use as the starting topic in the Q search bar. To locate the topic ID of the topic that you want to use, open the Quick Sight console, navigate to the Topics pane, and choose thre topic that you want to use. The TopicID is located in the URL of the topic that opens. When you select an initial topic, you can specify whether or not readers are allowed to select other topics from the list of available topics.

If you don't specify an initial topic or if you specify a new reader experience topic, a list of all shared legacy topics is shown in the Q bar.

Parameters:

initialTopicId - The ID of the legacy Q topic that you want to use as the starting topic in the Q search bar. To locate the topic ID of the topic that you want to use, open the Quick Sight console, navigate to the Topics pane, and choose thre topic that you want to use. The TopicID is located in the URL of the topic that opens. When you select an initial topic, you can specify whether or not readers are allowed to select other topics from the list of available topics.

If you don't specify an initial topic or if you specify a new reader experience topic, a list of all shared legacy topics is shown in the Q bar.

Returns:

Returns a reference to this object so that method calls can be chained together.