com.amazonaws.services.quicksight.model

Class RegisteredUserEmbeddingExperienceConfiguration

java.lang.Object

com.amazonaws.services.quicksight.model.RegisteredUserEmbeddingExperienceConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

The type of experience you want to embed. For registered users, you can embed Amazon QuickSight dashboards or the Amazon QuickSight 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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
RegisteredUserEmbeddingExperienceConfiguration()

Method Summary

Modifier and Type	Method and Description
RegisteredUserEmbeddingExperienceConfiguration	clone()
boolean	equals(Object obj)
RegisteredUserDashboardEmbeddingConfiguration	getDashboard() The configuration details for providing a dashboard embedding experience.
RegisteredUserDashboardVisualEmbeddingConfiguration	getDashboardVisual() The type of embedding experience.
RegisteredUserGenerativeQnAEmbeddingConfiguration	getGenerativeQnA() The configuration details for embedding the Generative Q&A experience.
RegisteredUserQSearchBarEmbeddingConfiguration	getQSearchBar() The configuration details for embedding the Q search bar.
RegisteredUserQuickSightConsoleEmbeddingConfiguration	getQuickSightConsole() The configuration details for providing each Amazon QuickSight console embedding experience.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setDashboard(RegisteredUserDashboardEmbeddingConfiguration dashboard) The configuration details for providing a dashboard embedding experience.
void	setDashboardVisual(RegisteredUserDashboardVisualEmbeddingConfiguration dashboardVisual) The type of embedding experience.
void	setGenerativeQnA(RegisteredUserGenerativeQnAEmbeddingConfiguration generativeQnA) The configuration details for embedding the Generative Q&A experience.
void	setQSearchBar(RegisteredUserQSearchBarEmbeddingConfiguration qSearchBar) The configuration details for embedding the Q search bar.
void	setQuickSightConsole(RegisteredUserQuickSightConsoleEmbeddingConfiguration quickSightConsole) The configuration details for providing each Amazon QuickSight console embedding experience.
String	toString() Returns a string representation of this object.
RegisteredUserEmbeddingExperienceConfiguration	withDashboard(RegisteredUserDashboardEmbeddingConfiguration dashboard) The configuration details for providing a dashboard embedding experience.
RegisteredUserEmbeddingExperienceConfiguration	withDashboardVisual(RegisteredUserDashboardVisualEmbeddingConfiguration dashboardVisual) The type of embedding experience.
RegisteredUserEmbeddingExperienceConfiguration	withGenerativeQnA(RegisteredUserGenerativeQnAEmbeddingConfiguration generativeQnA) The configuration details for embedding the Generative Q&A experience.
RegisteredUserEmbeddingExperienceConfiguration	withQSearchBar(RegisteredUserQSearchBarEmbeddingConfiguration qSearchBar) The configuration details for embedding the Q search bar.
RegisteredUserEmbeddingExperienceConfiguration	withQuickSightConsole(RegisteredUserQuickSightConsoleEmbeddingConfiguration quickSightConsole) The configuration details for providing each Amazon QuickSight console embedding experience.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RegisteredUserEmbeddingExperienceConfiguration

public RegisteredUserEmbeddingExperienceConfiguration()

Method Detail

setDashboard

public void setDashboard(RegisteredUserDashboardEmbeddingConfiguration dashboard)

The configuration details for providing a dashboard embedding experience.

Parameters:

dashboard - The configuration details for providing a dashboard embedding experience.

getDashboard

public RegisteredUserDashboardEmbeddingConfiguration getDashboard()

The configuration details for providing a dashboard embedding experience.

Returns:

The configuration details for providing a dashboard embedding experience.

withDashboard

public RegisteredUserEmbeddingExperienceConfiguration withDashboard(RegisteredUserDashboardEmbeddingConfiguration dashboard)

The configuration details for providing a dashboard embedding experience.

Parameters:

dashboard - The configuration details for providing a dashboard embedding experience.

Returns:

Returns a reference to this object so that method calls can be chained together.

setQuickSightConsole

public void setQuickSightConsole(RegisteredUserQuickSightConsoleEmbeddingConfiguration quickSightConsole)

The configuration details for providing each Amazon QuickSight 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 QuickSight Console in the Amazon QuickSight 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 QuickSight 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 QuickSight User Guide:

• Embedding the Full Functionality of the Amazon QuickSight Console for Authenticated Users

• Customizing Access to the Amazon QuickSight 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 QuickSight Developer Portal.

Parameters:

quickSightConsole - The configuration details for providing each Amazon QuickSight 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 QuickSight Console in the Amazon QuickSight 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 QuickSight 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 QuickSight User Guide:

• Embedding the Full Functionality of the Amazon QuickSight Console for Authenticated Users

• Customizing Access to the Amazon QuickSight 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 QuickSight Developer Portal.

getQuickSightConsole

public RegisteredUserQuickSightConsoleEmbeddingConfiguration getQuickSightConsole()

The configuration details for providing each Amazon QuickSight 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 QuickSight Console in the Amazon QuickSight 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 QuickSight 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 QuickSight User Guide:

• Embedding the Full Functionality of the Amazon QuickSight Console for Authenticated Users

• Customizing Access to the Amazon QuickSight 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 QuickSight Developer Portal.

Returns:

The configuration details for providing each Amazon QuickSight 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 QuickSight Console in the Amazon QuickSight 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 QuickSight 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 QuickSight User Guide:

• Embedding the Full Functionality of the Amazon QuickSight Console for Authenticated Users

• Customizing Access to the Amazon QuickSight 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 QuickSight Developer Portal.

withQuickSightConsole

public RegisteredUserEmbeddingExperienceConfiguration withQuickSightConsole(RegisteredUserQuickSightConsoleEmbeddingConfiguration quickSightConsole)

The configuration details for providing each Amazon QuickSight 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 QuickSight Console in the Amazon QuickSight 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 QuickSight 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 QuickSight User Guide:

• Embedding the Full Functionality of the Amazon QuickSight Console for Authenticated Users

• Customizing Access to the Amazon QuickSight 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 QuickSight Developer Portal.

Parameters:

quickSightConsole - The configuration details for providing each Amazon QuickSight 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 QuickSight Console in the Amazon QuickSight 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 QuickSight 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 QuickSight User Guide:

• Embedding the Full Functionality of the Amazon QuickSight Console for Authenticated Users

• Customizing Access to the Amazon QuickSight 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 QuickSight Developer Portal.

Returns:

Returns a reference to this object so that method calls can be chained together.

setQSearchBar

public void setQSearchBar(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 QuickSight User Guide.

Parameters:

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 QuickSight User Guide.

getQSearchBar

public RegisteredUserQSearchBarEmbeddingConfiguration getQSearchBar()

The configuration details for embedding the Q search bar.

For more information about embedding the Q search bar, see Embedding Overview in the Amazon QuickSight 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 QuickSight User Guide.

withQSearchBar

public RegisteredUserEmbeddingExperienceConfiguration withQSearchBar(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 QuickSight User Guide.

Parameters:

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 QuickSight User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDashboardVisual

public void setDashboardVisual(RegisteredUserDashboardVisualEmbeddingConfiguration dashboardVisual)

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

Parameters:

dashboardVisual - The type of embedding experience. In this case, Amazon QuickSight visuals.

getDashboardVisual

public RegisteredUserDashboardVisualEmbeddingConfiguration getDashboardVisual()

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

Returns:

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

withDashboardVisual

public RegisteredUserEmbeddingExperienceConfiguration withDashboardVisual(RegisteredUserDashboardVisualEmbeddingConfiguration dashboardVisual)

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

Parameters:

dashboardVisual - The type of embedding experience. In this case, Amazon QuickSight visuals.

Returns:

Returns a reference to this object so that method calls can be chained together.

setGenerativeQnA

public void setGenerativeQnA(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 QuickSight User Guide.

Parameters:

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 QuickSight User Guide.

getGenerativeQnA

public RegisteredUserGenerativeQnAEmbeddingConfiguration getGenerativeQnA()

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 QuickSight 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 QuickSight User Guide.

withGenerativeQnA

public RegisteredUserEmbeddingExperienceConfiguration withGenerativeQnA(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 QuickSight User Guide.

Parameters:

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 QuickSight User Guide.

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