Interface CreateDashboardRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateDashboardRequest.Builder,
,CreateDashboardRequest> QuickSightRequest.Builder
,SdkBuilder<CreateDashboardRequest.Builder,
,CreateDashboardRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateDashboardRequest
-
Method Summary
Modifier and TypeMethodDescriptionawsAccountId
(String awsAccountId) The ID of the Amazon Web Services account where you want to create the dashboard.dashboardId
(String dashboardId) The ID for the dashboard, also added to the IAM policy.default CreateDashboardRequest.Builder
dashboardPublishOptions
(Consumer<DashboardPublishOptions.Builder> dashboardPublishOptions) Options for publishing the dashboard when you create it:dashboardPublishOptions
(DashboardPublishOptions dashboardPublishOptions) Options for publishing the dashboard when you create it:default CreateDashboardRequest.Builder
definition
(Consumer<DashboardVersionDefinition.Builder> definition) The definition of a dashboard.definition
(DashboardVersionDefinition definition) The definition of a dashboard.folderArns
(String... folderArns) When you create the dashboard, Amazon QuickSight adds the dashboard to these folders.folderArns
(Collection<String> folderArns) When you create the dashboard, Amazon QuickSight adds the dashboard to these folders.linkEntities
(String... linkEntities) A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.linkEntities
(Collection<String> linkEntities) A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.default CreateDashboardRequest.Builder
linkSharingConfiguration
(Consumer<LinkSharingConfiguration.Builder> linkSharingConfiguration) A structure that contains the permissions of a shareable link to the dashboard.linkSharingConfiguration
(LinkSharingConfiguration linkSharingConfiguration) A structure that contains the permissions of a shareable link to the dashboard.The display name of the dashboard.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.default CreateDashboardRequest.Builder
parameters
(Consumer<Parameters.Builder> parameters) The parameters for the creation of the dashboard, which you want to use to override the default settings.parameters
(Parameters parameters) The parameters for the creation of the dashboard, which you want to use to override the default settings.permissions
(Collection<ResourcePermission> permissions) A structure that contains the permissions of the dashboard.permissions
(Consumer<ResourcePermission.Builder>... permissions) A structure that contains the permissions of the dashboard.permissions
(ResourcePermission... permissions) A structure that contains the permissions of the dashboard.default CreateDashboardRequest.Builder
sourceEntity
(Consumer<DashboardSourceEntity.Builder> sourceEntity) The entity that you are using as a source when you create the dashboard.sourceEntity
(DashboardSourceEntity sourceEntity) The entity that you are using as a source when you create the dashboard.tags
(Collection<Tag> tags) Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.tags
(Consumer<Tag.Builder>... tags) Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.The Amazon Resource Name (ARN) of the theme that is being used for this dashboard.default CreateDashboardRequest.Builder
validationStrategy
(Consumer<ValidationStrategy.Builder> validationStrategy) The option to relax the validation needed to create a dashboard with definition objects.validationStrategy
(ValidationStrategy validationStrategy) The option to relax the validation needed to create a dashboard with definition objects.versionDescription
(String versionDescription) A description for the first version of the dashboard being created.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.quicksight.model.QuickSightRequest.Builder
build
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
-
awsAccountId
The ID of the Amazon Web Services account where you want to create the dashboard.
- Parameters:
awsAccountId
- The ID of the Amazon Web Services account where you want to create the dashboard.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dashboardId
The ID for the dashboard, also added to the IAM policy.
- Parameters:
dashboardId
- The ID for the dashboard, also added to the IAM policy.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
name
The display name of the dashboard.
- Parameters:
name
- The display name of the dashboard.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
parameters
The parameters for the creation of the dashboard, which you want to use to override the default settings. A dashboard can have any type of parameters, and some parameters might accept multiple values.
- Parameters:
parameters
- The parameters for the creation of the dashboard, which you want to use to override the default settings. A dashboard can have any type of parameters, and some parameters might accept multiple values.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
parameters
The parameters for the creation of the dashboard, which you want to use to override the default settings. A dashboard can have any type of parameters, and some parameters might accept multiple values.
This is a convenience method that creates an instance of theParameters.Builder
avoiding the need to create one manually viaParameters.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toparameters(Parameters)
.- Parameters:
parameters
- a consumer that will call methods onParameters.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
permissions
A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAM action information for each principal ARN.
To specify no permissions, omit the permissions list.
- Parameters:
permissions
- A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAM action information for each principal ARN.To specify no permissions, omit the permissions list.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
permissions
A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAM action information for each principal ARN.
To specify no permissions, omit the permissions list.
- Parameters:
permissions
- A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAM action information for each principal ARN.To specify no permissions, omit the permissions list.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
permissions
A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAM action information for each principal ARN.
To specify no permissions, omit the permissions list.
This is a convenience method that creates an instance of theResourcePermission.Builder
avoiding the need to create one manually viaResourcePermission.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed topermissions(List<ResourcePermission>)
.- Parameters:
permissions
- a consumer that will call methods onResourcePermission.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
sourceEntity
The entity that you are using as a source when you create the dashboard. In
SourceEntity
, you specify the type of object you're using as source. You can only create a dashboard from a template, so you use aSourceTemplate
entity. If you need to create a dashboard from an analysis, first convert the analysis to a template by using theCreateTemplate
API operation. ForSourceTemplate
, specify the Amazon Resource Name (ARN) of the source template. TheSourceTemplate
ARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region.Use the
DataSetReferences
entity withinSourceTemplate
to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.Either a
SourceEntity
or aDefinition
must be provided in order for the request to be valid.- Parameters:
sourceEntity
- The entity that you are using as a source when you create the dashboard. InSourceEntity
, you specify the type of object you're using as source. You can only create a dashboard from a template, so you use aSourceTemplate
entity. If you need to create a dashboard from an analysis, first convert the analysis to a template by using theCreateTemplate
API operation. ForSourceTemplate
, specify the Amazon Resource Name (ARN) of the source template. TheSourceTemplate
ARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region.Use the
DataSetReferences
entity withinSourceTemplate
to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.Either a
SourceEntity
or aDefinition
must be provided in order for the request to be valid.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sourceEntity
default CreateDashboardRequest.Builder sourceEntity(Consumer<DashboardSourceEntity.Builder> sourceEntity) The entity that you are using as a source when you create the dashboard. In
SourceEntity
, you specify the type of object you're using as source. You can only create a dashboard from a template, so you use aSourceTemplate
entity. If you need to create a dashboard from an analysis, first convert the analysis to a template by using theCreateTemplate
API operation. ForSourceTemplate
, specify the Amazon Resource Name (ARN) of the source template. TheSourceTemplate
ARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region.Use the
DataSetReferences
entity withinSourceTemplate
to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.Either a
This is a convenience method that creates an instance of theSourceEntity
or aDefinition
must be provided in order for the request to be valid.DashboardSourceEntity.Builder
avoiding the need to create one manually viaDashboardSourceEntity.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosourceEntity(DashboardSourceEntity)
.- Parameters:
sourceEntity
- a consumer that will call methods onDashboardSourceEntity.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
tags
Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.
- Parameters:
tags
- Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.
- Parameters:
tags
- Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.
This is a convenience method that creates an instance of theTag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<Tag>)
.- Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
versionDescription
A description for the first version of the dashboard being created.
- Parameters:
versionDescription
- A description for the first version of the dashboard being created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dashboardPublishOptions
CreateDashboardRequest.Builder dashboardPublishOptions(DashboardPublishOptions dashboardPublishOptions) Options for publishing the dashboard when you create it:
-
AvailabilityStatus
forAdHocFilteringOption
- This status can be eitherENABLED
orDISABLED
. When this is set toDISABLED
, Amazon QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option isENABLED
by default. -
AvailabilityStatus
forExportToCSVOption
- This status can be eitherENABLED
orDISABLED
. The visual option to export data to .CSV format isn't enabled when this is set toDISABLED
. This option isENABLED
by default. -
VisibilityState
forSheetControlsOption
- This visibility state can be eitherCOLLAPSED
orEXPANDED
. This option isCOLLAPSED
by default.
- Parameters:
dashboardPublishOptions
- Options for publishing the dashboard when you create it:-
AvailabilityStatus
forAdHocFilteringOption
- This status can be eitherENABLED
orDISABLED
. When this is set toDISABLED
, Amazon QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option isENABLED
by default. -
AvailabilityStatus
forExportToCSVOption
- This status can be eitherENABLED
orDISABLED
. The visual option to export data to .CSV format isn't enabled when this is set toDISABLED
. This option isENABLED
by default. -
VisibilityState
forSheetControlsOption
- This visibility state can be eitherCOLLAPSED
orEXPANDED
. This option isCOLLAPSED
by default.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
dashboardPublishOptions
default CreateDashboardRequest.Builder dashboardPublishOptions(Consumer<DashboardPublishOptions.Builder> dashboardPublishOptions) Options for publishing the dashboard when you create it:
-
AvailabilityStatus
forAdHocFilteringOption
- This status can be eitherENABLED
orDISABLED
. When this is set toDISABLED
, Amazon QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option isENABLED
by default. -
AvailabilityStatus
forExportToCSVOption
- This status can be eitherENABLED
orDISABLED
. The visual option to export data to .CSV format isn't enabled when this is set toDISABLED
. This option isENABLED
by default. -
VisibilityState
forSheetControlsOption
- This visibility state can be eitherCOLLAPSED
orEXPANDED
. This option isCOLLAPSED
by default.
DashboardPublishOptions.Builder
avoiding the need to create one manually viaDashboardPublishOptions.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todashboardPublishOptions(DashboardPublishOptions)
.- Parameters:
dashboardPublishOptions
- a consumer that will call methods onDashboardPublishOptions.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
themeArn
The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that is used in the source entity. The theme ARN must exist in the same Amazon Web Services account where you create the dashboard.
- Parameters:
themeArn
- The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that is used in the source entity. The theme ARN must exist in the same Amazon Web Services account where you create the dashboard.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
definition
The definition of a dashboard.
A definition is the data model of all features in a Dashboard, Template, or Analysis.
Either a
SourceEntity
or aDefinition
must be provided in order for the request to be valid.- Parameters:
definition
- The definition of a dashboard.A definition is the data model of all features in a Dashboard, Template, or Analysis.
Either a
SourceEntity
or aDefinition
must be provided in order for the request to be valid.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
definition
default CreateDashboardRequest.Builder definition(Consumer<DashboardVersionDefinition.Builder> definition) The definition of a dashboard.
A definition is the data model of all features in a Dashboard, Template, or Analysis.
Either a
This is a convenience method that creates an instance of theSourceEntity
or aDefinition
must be provided in order for the request to be valid.DashboardVersionDefinition.Builder
avoiding the need to create one manually viaDashboardVersionDefinition.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todefinition(DashboardVersionDefinition)
.- Parameters:
definition
- a consumer that will call methods onDashboardVersionDefinition.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
validationStrategy
The option to relax the validation needed to create a dashboard with definition objects. This option skips the validation step for specific errors.
- Parameters:
validationStrategy
- The option to relax the validation needed to create a dashboard with definition objects. This option skips the validation step for specific errors.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
validationStrategy
default CreateDashboardRequest.Builder validationStrategy(Consumer<ValidationStrategy.Builder> validationStrategy) The option to relax the validation needed to create a dashboard with definition objects. This option skips the validation step for specific errors.
This is a convenience method that creates an instance of theValidationStrategy.Builder
avoiding the need to create one manually viaValidationStrategy.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tovalidationStrategy(ValidationStrategy)
.- Parameters:
validationStrategy
- a consumer that will call methods onValidationStrategy.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
folderArns
When you create the dashboard, Amazon QuickSight adds the dashboard to these folders.
- Parameters:
folderArns
- When you create the dashboard, Amazon QuickSight adds the dashboard to these folders.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
folderArns
When you create the dashboard, Amazon QuickSight adds the dashboard to these folders.
- Parameters:
folderArns
- When you create the dashboard, Amazon QuickSight adds the dashboard to these folders.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
linkSharingConfiguration
CreateDashboardRequest.Builder linkSharingConfiguration(LinkSharingConfiguration linkSharingConfiguration) A structure that contains the permissions of a shareable link to the dashboard.
- Parameters:
linkSharingConfiguration
- A structure that contains the permissions of a shareable link to the dashboard.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
linkSharingConfiguration
default CreateDashboardRequest.Builder linkSharingConfiguration(Consumer<LinkSharingConfiguration.Builder> linkSharingConfiguration) A structure that contains the permissions of a shareable link to the dashboard.
This is a convenience method that creates an instance of theLinkSharingConfiguration.Builder
avoiding the need to create one manually viaLinkSharingConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tolinkSharingConfiguration(LinkSharingConfiguration)
.- Parameters:
linkSharingConfiguration
- a consumer that will call methods onLinkSharingConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
linkEntities
A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.
- Parameters:
linkEntities
- A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
linkEntities
A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.
- Parameters:
linkEntities
- A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
CreateDashboardRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreateDashboardRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-