com.amazonaws.services.quicksight.model

Class RegisteredUserQSearchBarEmbeddingConfiguration

java.lang.Object

com.amazonaws.services.quicksight.model.RegisteredUserQSearchBarEmbeddingConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class RegisteredUserQSearchBarEmbeddingConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo

Information about the Q search bar embedding experience.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
RegisteredUserQSearchBarEmbeddingConfiguration()

Method Summary

Modifier and Type	Method and Description
RegisteredUserQSearchBarEmbeddingConfiguration	clone()
boolean	equals(Object obj)
String	getInitialTopicId() The ID of the Q topic that you want to make the starting topic in the Q search bar.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setInitialTopicId(String initialTopicId) The ID of the Q topic that you want to make the starting topic in the Q search bar.
String	toString() Returns a string representation of this object.
RegisteredUserQSearchBarEmbeddingConfiguration	withInitialTopicId(String initialTopicId) The ID of the Q topic that you want to make the starting topic in the Q search bar.

Methods inherited from class java.lang.Object

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

Constructor Detail

RegisteredUserQSearchBarEmbeddingConfiguration

public RegisteredUserQSearchBarEmbeddingConfiguration()

Method Detail

setInitialTopicId

public void setInitialTopicId(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.

Parameters:

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.

getInitialTopicId

public String getInitialTopicId()

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.

withInitialTopicId

public RegisteredUserQSearchBarEmbeddingConfiguration withInitialTopicId(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.

Parameters:

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:

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

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo