Interface RegisteredUserQuickSightConsoleEmbeddingConfiguration.Builder
-
- All Superinterfaces:
Buildable
,CopyableBuilder<RegisteredUserQuickSightConsoleEmbeddingConfiguration.Builder,RegisteredUserQuickSightConsoleEmbeddingConfiguration>
,SdkBuilder<RegisteredUserQuickSightConsoleEmbeddingConfiguration.Builder,RegisteredUserQuickSightConsoleEmbeddingConfiguration>
,SdkPojo
- Enclosing class:
- RegisteredUserQuickSightConsoleEmbeddingConfiguration
public static interface RegisteredUserQuickSightConsoleEmbeddingConfiguration.Builder extends SdkPojo, CopyableBuilder<RegisteredUserQuickSightConsoleEmbeddingConfiguration.Builder,RegisteredUserQuickSightConsoleEmbeddingConfiguration>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default RegisteredUserQuickSightConsoleEmbeddingConfiguration.Builder
featureConfigurations(Consumer<RegisteredUserConsoleFeatureConfigurations.Builder> featureConfigurations)
The embedding configuration of an embedded Amazon QuickSight console.RegisteredUserQuickSightConsoleEmbeddingConfiguration.Builder
featureConfigurations(RegisteredUserConsoleFeatureConfigurations featureConfigurations)
The embedding configuration of an embedded Amazon QuickSight console.RegisteredUserQuickSightConsoleEmbeddingConfiguration.Builder
initialPath(String initialPath)
The initial URL path for the Amazon QuickSight console.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
initialPath
RegisteredUserQuickSightConsoleEmbeddingConfiguration.Builder initialPath(String initialPath)
The initial URL path for the Amazon 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 Amazon QuickSight console URL of the dashboard. -
/analyses/AnalysisId
. AnalysisId is the actual ID key from the Amazon QuickSight console URL of the analysis.
- Parameters:
initialPath
- The initial URL path for the Amazon 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 Amazon QuickSight console URL of the dashboard. -
/analyses/AnalysisId
. AnalysisId is the actual ID key from the Amazon QuickSight console URL of the analysis.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
featureConfigurations
RegisteredUserQuickSightConsoleEmbeddingConfiguration.Builder featureConfigurations(RegisteredUserConsoleFeatureConfigurations featureConfigurations)
The embedding configuration of an embedded Amazon QuickSight console.
- Parameters:
featureConfigurations
- The embedding configuration of an embedded Amazon QuickSight console.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
featureConfigurations
default RegisteredUserQuickSightConsoleEmbeddingConfiguration.Builder featureConfigurations(Consumer<RegisteredUserConsoleFeatureConfigurations.Builder> featureConfigurations)
The embedding configuration of an embedded Amazon QuickSight console.
This is a convenience method that creates an instance of theRegisteredUserConsoleFeatureConfigurations.Builder
avoiding the need to create one manually viaRegisteredUserConsoleFeatureConfigurations.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tofeatureConfigurations(RegisteredUserConsoleFeatureConfigurations)
.- Parameters:
featureConfigurations
- a consumer that will call methods onRegisteredUserConsoleFeatureConfigurations.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
featureConfigurations(RegisteredUserConsoleFeatureConfigurations)
-
-