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

Class RegisteredUserDashboardEmbeddingConfiguration

java.lang.Object

software.amazon.awssdk.services.quicksight.model.RegisteredUserDashboardEmbeddingConfiguration

All Implemented Interfaces:

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

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

Information about the dashboard you want to embed.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RegisteredUserDashboardEmbeddingConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static RegisteredUserDashboardEmbeddingConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
RegisteredUserDashboardFeatureConfigurations	featureConfigurations()	The feature configurations of an embbedded Amazon QuickSight dashboard.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	initialDashboardId()	The dashboard ID for the dashboard that you want the user to see first.
List<SdkField<?>>	sdkFields()
static Class<? extends RegisteredUserDashboardEmbeddingConfiguration.Builder>	serializableBuilderClass()
RegisteredUserDashboardEmbeddingConfiguration.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

initialDashboardId

public final 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.

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.

featureConfigurations

public final RegisteredUserDashboardFeatureConfigurations featureConfigurations()

The feature configurations of an embbedded Amazon QuickSight dashboard.

Returns:

The feature configurations of an embbedded Amazon QuickSight dashboard.

toBuilder

public RegisteredUserDashboardEmbeddingConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RegisteredUserDashboardEmbeddingConfiguration.Builder,RegisteredUserDashboardEmbeddingConfiguration>

builder

public static RegisteredUserDashboardEmbeddingConfiguration.Builder builder()

serializableBuilderClass

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