com.amazonaws.services.quicksight.model

Class AnonymousUserQSearchBarEmbeddingConfiguration

java.lang.Object

com.amazonaws.services.quicksight.model.AnonymousUserQSearchBarEmbeddingConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

The settings that you want to use with the Q search bar.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
AnonymousUserQSearchBarEmbeddingConfiguration()

Method Summary

Modifier and Type	Method and Description
AnonymousUserQSearchBarEmbeddingConfiguration	clone()
boolean	equals(Object obj)
String	getInitialTopicId() The QuickSight Q topic ID of the topic that you want the anonymous user to see first.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setInitialTopicId(String initialTopicId) The QuickSight Q topic ID of the topic that you want the anonymous user to see first.
String	toString() Returns a string representation of this object.
AnonymousUserQSearchBarEmbeddingConfiguration	withInitialTopicId(String initialTopicId) The QuickSight Q topic ID of the topic that you want the anonymous user to see first.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AnonymousUserQSearchBarEmbeddingConfiguration

public AnonymousUserQSearchBarEmbeddingConfiguration()

Method Detail

setInitialTopicId

public void setInitialTopicId(String initialTopicId)

The QuickSight Q topic ID of the topic that you want the anonymous user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders the Q search bar with this topic pre-selected.

The Amazon Resource Name (ARN) of this Q topic must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.

Parameters:

initialTopicId - The QuickSight Q topic ID of the topic that you want the anonymous user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders the Q search bar with this topic pre-selected.

The Amazon Resource Name (ARN) of this Q topic must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.

getInitialTopicId

public String getInitialTopicId()

The QuickSight Q topic ID of the topic that you want the anonymous user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders the Q search bar with this topic pre-selected.

The Amazon Resource Name (ARN) of this Q topic must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.

Returns:

The QuickSight Q topic ID of the topic that you want the anonymous user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders the Q search bar with this topic pre-selected.

The Amazon Resource Name (ARN) of this Q topic must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.

withInitialTopicId

public AnonymousUserQSearchBarEmbeddingConfiguration withInitialTopicId(String initialTopicId)

The QuickSight Q topic ID of the topic that you want the anonymous user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders the Q search bar with this topic pre-selected.

The Amazon Resource Name (ARN) of this Q topic must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.

Parameters:

initialTopicId - The QuickSight Q topic ID of the topic that you want the anonymous user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders the Q search bar with this topic pre-selected.

The Amazon Resource Name (ARN) of this Q topic must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.

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 AnonymousUserQSearchBarEmbeddingConfiguration 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.