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

Class AnonymousUserQSearchBarEmbeddingConfiguration

java.lang.Object

software.amazon.awssdk.services.quicksight.model.AnonymousUserQSearchBarEmbeddingConfiguration

All Implemented Interfaces:

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

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

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AnonymousUserQSearchBarEmbeddingConfiguration.Builder

Method Summary

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

toBuilder

public AnonymousUserQSearchBarEmbeddingConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AnonymousUserQSearchBarEmbeddingConfiguration.Builder,AnonymousUserQSearchBarEmbeddingConfiguration>

builder

public static AnonymousUserQSearchBarEmbeddingConfiguration.Builder builder()

serializableBuilderClass

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