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

Class RegisteredUserDashboardVisualEmbeddingConfiguration

java.lang.Object

software.amazon.awssdk.services.quicksight.model.RegisteredUserDashboardVisualEmbeddingConfiguration

All Implemented Interfaces:

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

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

The experience that you are embedding. You can use this object to generate a url that embeds a visual into your application.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RegisteredUserDashboardVisualEmbeddingConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static RegisteredUserDashboardVisualEmbeddingConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
DashboardVisualId	initialDashboardVisualId()	The visual ID for the visual that you want the user to embed.
List<SdkField<?>>	sdkFields()
static Class<? extends RegisteredUserDashboardVisualEmbeddingConfiguration.Builder>	serializableBuilderClass()
RegisteredUserDashboardVisualEmbeddingConfiguration.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

initialDashboardVisualId

public final DashboardVisualId initialDashboardVisualId()

The visual ID for the visual that you want the user to embed. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this visual.

The Amazon Resource Name (ARN) of the dashboard that the visual belongs to must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.

Returns:

The visual ID for the visual that you want the user to embed. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this visual.

The Amazon Resource Name (ARN) of the dashboard that the visual belongs to must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.

toBuilder

public RegisteredUserDashboardVisualEmbeddingConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RegisteredUserDashboardVisualEmbeddingConfiguration.Builder,RegisteredUserDashboardVisualEmbeddingConfiguration>

builder

public static RegisteredUserDashboardVisualEmbeddingConfiguration.Builder builder()

serializableBuilderClass

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