Package software.amazon.awssdk.services.quicksight.model

Class RegisteredUserQSearchBarEmbeddingConfiguration

java.lang.Object

software.amazon.awssdk.services.quicksight.model.RegisteredUserQSearchBarEmbeddingConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<RegisteredUserQSearchBarEmbeddingConfiguration.Builder,RegisteredUserQSearchBarEmbeddingConfiguration>

@Generated("software.amazon.awssdk:codegen")
public final class RegisteredUserQSearchBarEmbeddingConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<RegisteredUserQSearchBarEmbeddingConfiguration.Builder,RegisteredUserQSearchBarEmbeddingConfiguration>

Information about the Q search bar embedding experience.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RegisteredUserQSearchBarEmbeddingConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static RegisteredUserQSearchBarEmbeddingConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	initialTopicId()	The ID of the Q topic that you want to make the starting topic in the Q search bar.
List<SdkField<?>>	sdkFields()
static Class<? extends RegisteredUserQSearchBarEmbeddingConfiguration.Builder>	serializableBuilderClass()
RegisteredUserQSearchBarEmbeddingConfiguration.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

initialTopicId

public final String initialTopicId()

The ID of the Q topic that you want to make the starting topic in the Q search bar. You can find a topic ID by navigating to the Topics pane in the Amazon QuickSight application and opening a topic. The ID is in the URL for the topic that you open.

If you don't specify an initial topic, a list of all shared topics is shown in the Q bar for your readers. When you select an initial topic, you can specify whether or not readers are allowed to select other topics from the available ones in the list.

Returns:

The ID of the Q topic that you want to make the starting topic in the Q search bar. You can find a topic ID by navigating to the Topics pane in the Amazon QuickSight application and opening a topic. The ID is in the URL for the topic that you open.

If you don't specify an initial topic, a list of all shared topics is shown in the Q bar for your readers. When you select an initial topic, you can specify whether or not readers are allowed to select other topics from the available ones in the list.

toBuilder

public RegisteredUserQSearchBarEmbeddingConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RegisteredUserQSearchBarEmbeddingConfiguration.Builder,RegisteredUserQSearchBarEmbeddingConfiguration>

builder

public static RegisteredUserQSearchBarEmbeddingConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends RegisteredUserQSearchBarEmbeddingConfiguration.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