Class RegisteredUserEmbeddingExperienceConfiguration

java.lang.Object

software.amazon.awssdk.services.quicksight.model.RegisteredUserEmbeddingExperienceConfiguration

All Implemented Interfaces:

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

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

The type of experience you want to embed. For registered users, you can embed Quick Suite dashboards or the Amazon Quick Sight console.

Exactly one of the experience configurations is required. You can choose Dashboard or QuickSightConsole. You cannot choose more than one experience configuration.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RegisteredUserEmbeddingExperienceConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static RegisteredUserEmbeddingExperienceConfiguration.Builder	builder()
final RegisteredUserDashboardEmbeddingConfiguration	dashboard()	The configuration details for providing a dashboard embedding experience.
final RegisteredUserDashboardVisualEmbeddingConfiguration	dashboardVisual()	The type of embedding experience.
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)	Indicates whether some other object is "equal to" this one by SDK fields.
final RegisteredUserGenerativeQnAEmbeddingConfiguration	generativeQnA()	The configuration details for embedding the Generative Q&A experience.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final RegisteredUserQSearchBarEmbeddingConfiguration	qSearchBar()	The configuration details for embedding the Q search bar.
final RegisteredUserQuickChatEmbeddingConfiguration	quickChat()	The configuration details for embedding the Quick chat agent.
final RegisteredUserQuickSightConsoleEmbeddingConfiguration	quickSightConsole()	The configuration details for providing each Amazon Quick Sight console embedding experience.
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends RegisteredUserEmbeddingExperienceConfiguration.Builder>	serializableBuilderClass()
RegisteredUserEmbeddingExperienceConfiguration.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
final String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Details

dashboard

public final RegisteredUserDashboardEmbeddingConfiguration dashboard()

The configuration details for providing a dashboard embedding experience.

Returns:

The configuration details for providing a dashboard embedding experience.

quickSightConsole

public final RegisteredUserQuickSightConsoleEmbeddingConfiguration quickSightConsole()

The configuration details for providing each Amazon Quick Sight console embedding experience. This can be used along with custom permissions to restrict access to certain features. For more information, see Customizing Access to the Amazon Quick Sight Console in the Amazon Quick Suite User Guide.

Use GenerateEmbedUrlForRegisteredUser where you want to provide an authoring portal that allows users to create data sources, datasets, analyses, and dashboards. The users who accesses an embedded Amazon Quick Sight console needs to belong to the author or admin security cohort. If you want to restrict permissions to some of these features, add a custom permissions profile to the user with the UpdateUser API operation. Use the RegisterUser API operation to add a new user with a custom permission profile attached. For more information, see the following sections in the Amazon Quick Suite User Guide:

• Embedding the Full Functionality of the Amazon Quick Sight Console for Authenticated Users

• Customizing Access to the Amazon Quick Suite Console

For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon Quick Suite Developer Portal.

Returns:

The configuration details for providing each Amazon Quick Sight console embedding experience. This can be used along with custom permissions to restrict access to certain features. For more information, see Customizing Access to the Amazon Quick Sight Console in the Amazon Quick Suite User Guide.

Use GenerateEmbedUrlForRegisteredUser where you want to provide an authoring portal that allows users to create data sources, datasets, analyses, and dashboards. The users who accesses an embedded Amazon Quick Sight console needs to belong to the author or admin security cohort. If you want to restrict permissions to some of these features, add a custom permissions profile to the user with the UpdateUser API operation. Use the RegisterUser API operation to add a new user with a custom permission profile attached. For more information, see the following sections in the Amazon Quick Suite User Guide:

• Embedding the Full Functionality of the Amazon Quick Sight Console for Authenticated Users

• Customizing Access to the Amazon Quick Suite Console

For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon Quick Suite Developer Portal.

qSearchBar

public final RegisteredUserQSearchBarEmbeddingConfiguration qSearchBar()

The configuration details for embedding the Q search bar.

For more information about embedding the Q search bar, see Embedding Overview in the Amazon Quick Sight User Guide.

Returns:

The configuration details for embedding the Q search bar.

For more information about embedding the Q search bar, see Embedding Overview in the Amazon Quick Sight User Guide.

dashboardVisual

public final RegisteredUserDashboardVisualEmbeddingConfiguration dashboardVisual()

The type of embedding experience. In this case, Amazon Quick Sight visuals.

Returns:

The type of embedding experience. In this case, Amazon Quick Sight visuals.

generativeQnA

public final RegisteredUserGenerativeQnAEmbeddingConfiguration generativeQnA()

The configuration details for embedding the Generative Q&A experience.

For more information about embedding the Generative Q&A experience, see Embedding Overview in the Amazon Quick Sight User Guide.

Returns:

The configuration details for embedding the Generative Q&A experience.

For more information about embedding the Generative Q&A experience, see Embedding Overview in the Amazon Quick Sight User Guide.

quickChat

public final RegisteredUserQuickChatEmbeddingConfiguration quickChat()

The configuration details for embedding the Quick chat agent.

Returns:

The configuration details for embedding the Quick chat agent.

toBuilder

public RegisteredUserEmbeddingExperienceConfiguration.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<RegisteredUserEmbeddingExperienceConfiguration.Builder,RegisteredUserEmbeddingExperienceConfiguration>

Returns:

a builder for type T

builder

public static RegisteredUserEmbeddingExperienceConfiguration.Builder builder()

serializableBuilderClass

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

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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

Returns:

List of SdkField in this POJO. May be empty list but should never be null.

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo

Returns:

The mapping between the field name and its corresponding field.