com.amazonaws.services.quicksight.model

Class RegisteredUserDashboardEmbeddingConfiguration

java.lang.Object

com.amazonaws.services.quicksight.model.RegisteredUserDashboardEmbeddingConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

Information about the dashboard you want to embed.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
RegisteredUserDashboardEmbeddingConfiguration()

Method Summary

Modifier and Type	Method and Description
RegisteredUserDashboardEmbeddingConfiguration	clone()
boolean	equals(Object obj)
String	getInitialDashboardId() The dashboard ID for the dashboard that you want the user to see first.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setInitialDashboardId(String initialDashboardId) The dashboard ID for the dashboard that you want the user to see first.
String	toString() Returns a string representation of this object.
RegisteredUserDashboardEmbeddingConfiguration	withInitialDashboardId(String initialDashboardId) The dashboard ID for the dashboard that you want the user to see first.

Methods inherited from class java.lang.Object

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

Constructor Detail

RegisteredUserDashboardEmbeddingConfiguration

public RegisteredUserDashboardEmbeddingConfiguration()

Method Detail

setInitialDashboardId

public void setInitialDashboardId(String initialDashboardId)

The dashboard ID for the dashboard that you want the user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this dashboard if the user has permissions to view it.

If the user does not have permission to view this dashboard, they see a permissions error message.

Parameters:

initialDashboardId - The dashboard ID for the dashboard that you want the user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this dashboard if the user has permissions to view it.

If the user does not have permission to view this dashboard, they see a permissions error message.

getInitialDashboardId

public String getInitialDashboardId()

The dashboard ID for the dashboard that you want the user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this dashboard if the user has permissions to view it.

If the user does not have permission to view this dashboard, they see a permissions error message.

Returns:

The dashboard ID for the dashboard that you want the user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this dashboard if the user has permissions to view it.

If the user does not have permission to view this dashboard, they see a permissions error message.

withInitialDashboardId

public RegisteredUserDashboardEmbeddingConfiguration withInitialDashboardId(String initialDashboardId)

The dashboard ID for the dashboard that you want the user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this dashboard if the user has permissions to view it.

If the user does not have permission to view this dashboard, they see a permissions error message.

Parameters:

initialDashboardId - The dashboard ID for the dashboard that you want the user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this dashboard if the user has permissions to view it.

If the user does not have permission to view this dashboard, they see a permissions error message.

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

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo