Interface AnonymousUserDashboardVisualEmbeddingConfiguration.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<AnonymousUserDashboardVisualEmbeddingConfiguration.Builder,
,AnonymousUserDashboardVisualEmbeddingConfiguration> SdkBuilder<AnonymousUserDashboardVisualEmbeddingConfiguration.Builder,
,AnonymousUserDashboardVisualEmbeddingConfiguration> SdkPojo
- Enclosing class:
AnonymousUserDashboardVisualEmbeddingConfiguration
-
Method Summary
Modifier and TypeMethodDescriptioninitialDashboardVisualId
(Consumer<DashboardVisualId.Builder> initialDashboardVisualId) The visual ID for the visual that you want the user to see.initialDashboardVisualId
(DashboardVisualId initialDashboardVisualId) The visual ID for the visual that you want the user to see.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 Details
-
initialDashboardVisualId
AnonymousUserDashboardVisualEmbeddingConfiguration.Builder initialDashboardVisualId(DashboardVisualId initialDashboardVisualId) The visual ID for the visual that you want the user to see. 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 withInvalidParameterValueException
.- Parameters:
initialDashboardVisualId
- The visual ID for the visual that you want the user to see. 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 withInvalidParameterValueException
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
initialDashboardVisualId
default AnonymousUserDashboardVisualEmbeddingConfiguration.Builder initialDashboardVisualId(Consumer<DashboardVisualId.Builder> initialDashboardVisualId) The visual ID for the visual that you want the user to see. 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
This is a convenience method that creates an instance of theAuthorizedResourceArns
parameter. Otherwise, the request will fail withInvalidParameterValueException
.DashboardVisualId.Builder
avoiding the need to create one manually viaDashboardVisualId.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toinitialDashboardVisualId(DashboardVisualId)
.- Parameters:
initialDashboardVisualId
- a consumer that will call methods onDashboardVisualId.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-