software.amazon.awssdk.services.quicksight.model

Interface CreateDashboardRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateDashboardRequest.Builder,CreateDashboardRequest>, QuickSightRequest.Builder, SdkBuilder<CreateDashboardRequest.Builder,CreateDashboardRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateDashboardRequest

public static interface CreateDashboardRequest.Builder
extends QuickSightRequest.Builder, SdkPojo, CopyableBuilder<CreateDashboardRequest.Builder,CreateDashboardRequest>

Method Summary

Modifier and Type	Method and Description
CreateDashboardRequest.Builder	awsAccountId(String awsAccountId) The ID of the Amazon Web Services account where you want to create the dashboard.
CreateDashboardRequest.Builder	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:
CreateDashboardRequest.Builder	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.
CreateDashboardRequest.Builder	definition(DashboardVersionDefinition definition) The definition of a dashboard.
CreateDashboardRequest.Builder	name(String name) The display name of the dashboard.
CreateDashboardRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateDashboardRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
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.
CreateDashboardRequest.Builder	parameters(Parameters parameters) The parameters for the creation of the dashboard, which you want to use to override the default settings.
CreateDashboardRequest.Builder	permissions(Collection<ResourcePermission> permissions) A structure that contains the permissions of the dashboard.
CreateDashboardRequest.Builder	permissions(Consumer<ResourcePermission.Builder>... permissions) A structure that contains the permissions of the dashboard.
CreateDashboardRequest.Builder	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.
CreateDashboardRequest.Builder	sourceEntity(DashboardSourceEntity sourceEntity) The entity that you are using as a source when you create the dashboard.
CreateDashboardRequest.Builder	tags(Collection<Tag> tags) Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.
CreateDashboardRequest.Builder	tags(Consumer<Tag.Builder>... tags) Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.
CreateDashboardRequest.Builder	tags(Tag... tags) Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.
CreateDashboardRequest.Builder	themeArn(String themeArn) The Amazon Resource Name (ARN) of the theme that is being used for this dashboard.
CreateDashboardRequest.Builder	versionDescription(String versionDescription) A description for the first version of the dashboard being created.

Methods inherited from interface software.amazon.awssdk.services.quicksight.model.QuickSightRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

awsAccountId

CreateDashboardRequest.Builder awsAccountId(String 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

CreateDashboardRequest.Builder dashboardId(String 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

CreateDashboardRequest.Builder name(String 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

CreateDashboardRequest.Builder parameters(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.

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

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. 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 the Parameters.Builder avoiding the need to create one manually via Parameters.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to parameters(Parameters).

Parameters:

parameters - a consumer that will call methods on Parameters.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

parameters(Parameters)

permissions

CreateDashboardRequest.Builder permissions(Collection<ResourcePermission> 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

CreateDashboardRequest.Builder permissions(ResourcePermission... 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

CreateDashboardRequest.Builder permissions(Consumer<ResourcePermission.Builder>... 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 the ResourcePermission.Builder avoiding the need to create one manually via ResourcePermission.builder() .

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #permissions(List).

Parameters:

permissions - a consumer that will call methods on ResourcePermission.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#permissions(java.util.Collection)

sourceEntity

CreateDashboardRequest.Builder sourceEntity(DashboardSourceEntity 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 a SourceTemplate entity. If you need to create a dashboard from an analysis, first convert the analysis to a template by using the CreateTemplate API operation. For SourceTemplate, specify the Amazon Resource Name (ARN) of the source template. The SourceTemplateARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region.

Use the DataSetReferences entity within SourceTemplate 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 a Definition 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. 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 a SourceTemplate entity. If you need to create a dashboard from an analysis, first convert the analysis to a template by using the CreateTemplate API operation. For SourceTemplate, specify the Amazon Resource Name (ARN) of the source template. The SourceTemplateARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region.

Use the DataSetReferences entity within SourceTemplate 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 a Definition 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 a SourceTemplate entity. If you need to create a dashboard from an analysis, first convert the analysis to a template by using the CreateTemplate API operation. For SourceTemplate, specify the Amazon Resource Name (ARN) of the source template. The SourceTemplateARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region.

Use the DataSetReferences entity within SourceTemplate 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 a Definition must be provided in order for the request to be valid.

This is a convenience method that creates an instance of the DashboardSourceEntity.Builder avoiding the need to create one manually via DashboardSourceEntity.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sourceEntity(DashboardSourceEntity).

Parameters:

sourceEntity - a consumer that will call methods on DashboardSourceEntity.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

sourceEntity(DashboardSourceEntity)

tags

CreateDashboardRequest.Builder tags(Collection<Tag> 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

CreateDashboardRequest.Builder tags(Tag... 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

CreateDashboardRequest.Builder tags(Consumer<Tag.Builder>... 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 the Tag.Builder avoiding the need to create one manually via Tag.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

Parameters:

tags - a consumer that will call methods on Tag.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#tags(java.util.Collection)

versionDescription

CreateDashboardRequest.Builder versionDescription(String 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 for AdHocFilteringOption - This status can be either ENABLED or DISABLED. When this is set to DISABLED, Amazon QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ENABLED by default.

• AvailabilityStatus for ExportToCSVOption - This status can be either ENABLED or DISABLED. The visual option to export data to .CSV format isn't enabled when this is set to DISABLED. This option is ENABLED by default.

• VisibilityState for SheetControlsOption - This visibility state can be either COLLAPSED or EXPANDED. This option is COLLAPSED by default.

Parameters:

dashboardPublishOptions - Options for publishing the dashboard when you create it:

• AvailabilityStatus for AdHocFilteringOption - This status can be either ENABLED or DISABLED. When this is set to DISABLED, Amazon QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ENABLED by default.

• AvailabilityStatus for ExportToCSVOption - This status can be either ENABLED or DISABLED. The visual option to export data to .CSV format isn't enabled when this is set to DISABLED. This option is ENABLED by default.

• VisibilityState for SheetControlsOption - This visibility state can be either COLLAPSED or EXPANDED. This option is COLLAPSED 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 for AdHocFilteringOption - This status can be either ENABLED or DISABLED. When this is set to DISABLED, Amazon QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ENABLED by default.

• AvailabilityStatus for ExportToCSVOption - This status can be either ENABLED or DISABLED. The visual option to export data to .CSV format isn't enabled when this is set to DISABLED. This option is ENABLED by default.

• VisibilityState for SheetControlsOption - This visibility state can be either COLLAPSED or EXPANDED. This option is COLLAPSED by default.

This is a convenience method that creates an instance of the DashboardPublishOptions.Builder avoiding the need to create one manually via DashboardPublishOptions.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to dashboardPublishOptions(DashboardPublishOptions).

Parameters:

dashboardPublishOptions - a consumer that will call methods on DashboardPublishOptions.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

dashboardPublishOptions(DashboardPublishOptions)

themeArn

CreateDashboardRequest.Builder themeArn(String 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

CreateDashboardRequest.Builder definition(DashboardVersionDefinition 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 a Definition 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 a Definition 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 SourceEntity or a Definition must be provided in order for the request to be valid.

This is a convenience method that creates an instance of the DashboardVersionDefinition.Builder avoiding the need to create one manually via DashboardVersionDefinition.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to definition(DashboardVersionDefinition).

Parameters:

definition - a consumer that will call methods on DashboardVersionDefinition.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

definition(DashboardVersionDefinition)

overrideConfiguration

CreateDashboardRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

CreateDashboardRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder