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

Class RegisteredUserQuickSightConsoleEmbeddingConfiguration

java.lang.Object

software.amazon.awssdk.services.quicksight.model.RegisteredUserQuickSightConsoleEmbeddingConfiguration

All Implemented Interfaces:

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

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

Information about the QuickSight console that you want to embed.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RegisteredUserQuickSightConsoleEmbeddingConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static RegisteredUserQuickSightConsoleEmbeddingConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
RegisteredUserConsoleFeatureConfigurations	featureConfigurations()	The embedding configuration of an embedded QuickSight console.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	initialPath()	The initial URL path for the QuickSight console.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends RegisteredUserQuickSightConsoleEmbeddingConfiguration.Builder>	serializableBuilderClass()
RegisteredUserQuickSightConsoleEmbeddingConfiguration.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

initialPath

public final String initialPath()

The initial URL path for the QuickSight console. InitialPath is required.

The entry point URL is constrained to the following paths:

• /start

• /start/analyses

• /start/dashboards

• /start/favorites

• /dashboards/DashboardId. DashboardId is the actual ID key from the QuickSight console URL of the dashboard.

• /analyses/AnalysisId. AnalysisId is the actual ID key from the QuickSight console URL of the analysis.

Returns:

The initial URL path for the QuickSight console. InitialPath is required.

The entry point URL is constrained to the following paths:

• /start

• /start/analyses

• /start/dashboards

• /start/favorites

• /dashboards/DashboardId. DashboardId is the actual ID key from the QuickSight console URL of the dashboard.

• /analyses/AnalysisId. AnalysisId is the actual ID key from the QuickSight console URL of the analysis.

featureConfigurations

public final RegisteredUserConsoleFeatureConfigurations featureConfigurations()

The embedding configuration of an embedded QuickSight console.

Returns:

The embedding configuration of an embedded QuickSight console.

toBuilder

public RegisteredUserQuickSightConsoleEmbeddingConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RegisteredUserQuickSightConsoleEmbeddingConfiguration.Builder,RegisteredUserQuickSightConsoleEmbeddingConfiguration>

builder

public static RegisteredUserQuickSightConsoleEmbeddingConfiguration.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

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

Specified by:

sdkFieldNameToField in interface SdkPojo