Interface CreateDataSetRequest.Builder

All Superinterfaces:

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

Enclosing class:

CreateDataSetRequest

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

Method Summary

Modifier and Type	Method	Description
CreateDataSetRequest.Builder	awsAccountId(String awsAccountId)	The Amazon Web Services account ID.
CreateDataSetRequest.Builder	columnGroups(Collection<ColumnGroup> columnGroups)	Groupings of columns that work together in certain Amazon QuickSight features.
CreateDataSetRequest.Builder	columnGroups(Consumer<ColumnGroup.Builder>... columnGroups)	Groupings of columns that work together in certain Amazon QuickSight features.
CreateDataSetRequest.Builder	columnGroups(ColumnGroup... columnGroups)	Groupings of columns that work together in certain Amazon QuickSight features.
CreateDataSetRequest.Builder	columnLevelPermissionRules(Collection<ColumnLevelPermissionRule> columnLevelPermissionRules)	A set of one or more definitions of a ColumnLevelPermissionRule .
CreateDataSetRequest.Builder	columnLevelPermissionRules(Consumer<ColumnLevelPermissionRule.Builder>... columnLevelPermissionRules)	A set of one or more definitions of a ColumnLevelPermissionRule .
CreateDataSetRequest.Builder	columnLevelPermissionRules(ColumnLevelPermissionRule... columnLevelPermissionRules)	A set of one or more definitions of a ColumnLevelPermissionRule .
CreateDataSetRequest.Builder	dataSetId(String dataSetId)	An ID for the dataset that you want to create.
CreateDataSetRequest.Builder	datasetParameters(Collection<DatasetParameter> datasetParameters)	The parameter declarations of the dataset.
CreateDataSetRequest.Builder	datasetParameters(Consumer<DatasetParameter.Builder>... datasetParameters)	The parameter declarations of the dataset.
CreateDataSetRequest.Builder	datasetParameters(DatasetParameter... datasetParameters)	The parameter declarations of the dataset.
default CreateDataSetRequest.Builder	dataSetUsageConfiguration(Consumer<DataSetUsageConfiguration.Builder> dataSetUsageConfiguration)	Sets the value of the DataSetUsageConfiguration property for this object.
CreateDataSetRequest.Builder	dataSetUsageConfiguration(DataSetUsageConfiguration dataSetUsageConfiguration)	Sets the value of the DataSetUsageConfiguration property for this object.
CreateDataSetRequest.Builder	fieldFolders(Map<String,FieldFolder> fieldFolders)	The folder that contains fields and nested subfolders for your dataset.
CreateDataSetRequest.Builder	folderArns(String... folderArns)	When you create the dataset, Amazon QuickSight adds the dataset to these folders.
CreateDataSetRequest.Builder	folderArns(Collection<String> folderArns)	When you create the dataset, Amazon QuickSight adds the dataset to these folders.
CreateDataSetRequest.Builder	importMode(String importMode)	Indicates whether you want to import the data into SPICE.
CreateDataSetRequest.Builder	importMode(DataSetImportMode importMode)	Indicates whether you want to import the data into SPICE.
CreateDataSetRequest.Builder	logicalTableMap(Map<String,LogicalTable> logicalTableMap)	Configures the combination and transformation of the data from the physical tables.
CreateDataSetRequest.Builder	name(String name)	The display name for the dataset.
CreateDataSetRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateDataSetRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
CreateDataSetRequest.Builder	permissions(Collection<ResourcePermission> permissions)	A list of resource permissions on the dataset.
CreateDataSetRequest.Builder	permissions(Consumer<ResourcePermission.Builder>... permissions)	A list of resource permissions on the dataset.
CreateDataSetRequest.Builder	permissions(ResourcePermission... permissions)	A list of resource permissions on the dataset.
CreateDataSetRequest.Builder	physicalTableMap(Map<String,PhysicalTable> physicalTableMap)	Declares the physical tables that are available in the underlying data sources.
default CreateDataSetRequest.Builder	rowLevelPermissionDataSet(Consumer<RowLevelPermissionDataSet.Builder> rowLevelPermissionDataSet)	The row-level security configuration for the data that you want to create.
CreateDataSetRequest.Builder	rowLevelPermissionDataSet(RowLevelPermissionDataSet rowLevelPermissionDataSet)	The row-level security configuration for the data that you want to create.
default CreateDataSetRequest.Builder	rowLevelPermissionTagConfiguration(Consumer<RowLevelPermissionTagConfiguration.Builder> rowLevelPermissionTagConfiguration)	The configuration of tags on a dataset to set row-level security.
CreateDataSetRequest.Builder	rowLevelPermissionTagConfiguration(RowLevelPermissionTagConfiguration rowLevelPermissionTagConfiguration)	The configuration of tags on a dataset to set row-level security.
CreateDataSetRequest.Builder	tags(Collection<Tag> tags)	Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.
CreateDataSetRequest.Builder	tags(Consumer<Tag.Builder>... tags)	Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.
CreateDataSetRequest.Builder	tags(Tag... tags)	Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.

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

CreateDataSetRequest.Builder awsAccountId(String awsAccountId)

The Amazon Web Services account ID.

Parameters:

awsAccountId - The Amazon Web Services account ID.

Returns:

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

dataSetId

CreateDataSetRequest.Builder dataSetId(String dataSetId)

An ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

Parameters:

dataSetId - An ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

Returns:

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

name

CreateDataSetRequest.Builder name(String name)

The display name for the dataset.

Parameters:

name - The display name for the dataset.

Returns:

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

physicalTableMap

CreateDataSetRequest.Builder physicalTableMap(Map<String,PhysicalTable> physicalTableMap)

Declares the physical tables that are available in the underlying data sources.

Parameters:

physicalTableMap - Declares the physical tables that are available in the underlying data sources.

Returns:

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

logicalTableMap

CreateDataSetRequest.Builder logicalTableMap(Map<String,LogicalTable> logicalTableMap)

Configures the combination and transformation of the data from the physical tables.

Parameters:

logicalTableMap - Configures the combination and transformation of the data from the physical tables.

Returns:

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

importMode

CreateDataSetRequest.Builder importMode(String importMode)

Indicates whether you want to import the data into SPICE.

Parameters:

importMode - Indicates whether you want to import the data into SPICE.

Returns:

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

See Also:

• DataSetImportMode
• DataSetImportMode

importMode

CreateDataSetRequest.Builder importMode(DataSetImportMode importMode)

Indicates whether you want to import the data into SPICE.

Parameters:

importMode - Indicates whether you want to import the data into SPICE.

Returns:

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

See Also:

• DataSetImportMode
• DataSetImportMode

columnGroups

CreateDataSetRequest.Builder columnGroups(Collection<ColumnGroup> columnGroups)

Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.

Parameters:

columnGroups - Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.

Returns:

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

columnGroups

CreateDataSetRequest.Builder columnGroups(ColumnGroup... columnGroups)

Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.

Parameters:

columnGroups - Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.

Returns:

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

columnGroups

CreateDataSetRequest.Builder columnGroups(Consumer<ColumnGroup.Builder>... columnGroups)

Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to columnGroups(List<ColumnGroup>).

Parameters:

columnGroups - a consumer that will call methods on ColumnGroup.Builder

Returns:

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

See Also:

• columnGroups(java.util.Collection<ColumnGroup>)

fieldFolders

CreateDataSetRequest.Builder fieldFolders(Map<String,FieldFolder> fieldFolders)

The folder that contains fields and nested subfolders for your dataset.

Parameters:

fieldFolders - The folder that contains fields and nested subfolders for your dataset.

Returns:

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

permissions

CreateDataSetRequest.Builder permissions(Collection<ResourcePermission> permissions)

A list of resource permissions on the dataset.

Parameters:

permissions - A list of resource permissions on the dataset.

Returns:

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

permissions

CreateDataSetRequest.Builder permissions(ResourcePermission... permissions)

A list of resource permissions on the dataset.

Parameters:

permissions - A list of resource permissions on the dataset.

Returns:

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

permissions

CreateDataSetRequest.Builder permissions(Consumer<ResourcePermission.Builder>... permissions)

A list of resource permissions on the dataset.

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<ResourcePermission>).

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<ResourcePermission>)

rowLevelPermissionDataSet

CreateDataSetRequest.Builder rowLevelPermissionDataSet(RowLevelPermissionDataSet rowLevelPermissionDataSet)

The row-level security configuration for the data that you want to create.

Parameters:

rowLevelPermissionDataSet - The row-level security configuration for the data that you want to create.

Returns:

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

rowLevelPermissionDataSet

default CreateDataSetRequest.Builder rowLevelPermissionDataSet(Consumer<RowLevelPermissionDataSet.Builder> rowLevelPermissionDataSet)

The row-level security configuration for the data that you want to create.

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

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

Parameters:

rowLevelPermissionDataSet - a consumer that will call methods on RowLevelPermissionDataSet.Builder

Returns:

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

See Also:

• rowLevelPermissionDataSet(RowLevelPermissionDataSet)

rowLevelPermissionTagConfiguration

CreateDataSetRequest.Builder rowLevelPermissionTagConfiguration(RowLevelPermissionTagConfiguration rowLevelPermissionTagConfiguration)

The configuration of tags on a dataset to set row-level security. Row-level security tags are currently supported for anonymous embedding only.

Parameters:

rowLevelPermissionTagConfiguration - The configuration of tags on a dataset to set row-level security. Row-level security tags are currently supported for anonymous embedding only.

Returns:

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

rowLevelPermissionTagConfiguration

default CreateDataSetRequest.Builder rowLevelPermissionTagConfiguration(Consumer<RowLevelPermissionTagConfiguration.Builder> rowLevelPermissionTagConfiguration)

The configuration of tags on a dataset to set row-level security. Row-level security tags are currently supported for anonymous embedding only.

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

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

Parameters:

rowLevelPermissionTagConfiguration - a consumer that will call methods on RowLevelPermissionTagConfiguration.Builder

Returns:

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

See Also:

• rowLevelPermissionTagConfiguration(RowLevelPermissionTagConfiguration)

columnLevelPermissionRules

CreateDataSetRequest.Builder columnLevelPermissionRules(Collection<ColumnLevelPermissionRule> columnLevelPermissionRules)

A set of one or more definitions of a ColumnLevelPermissionRule .

Parameters:

columnLevelPermissionRules - A set of one or more definitions of a ColumnLevelPermissionRule .

Returns:

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

columnLevelPermissionRules

CreateDataSetRequest.Builder columnLevelPermissionRules(ColumnLevelPermissionRule... columnLevelPermissionRules)

A set of one or more definitions of a ColumnLevelPermissionRule .

Parameters:

columnLevelPermissionRules - A set of one or more definitions of a ColumnLevelPermissionRule .

Returns:

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

columnLevelPermissionRules

CreateDataSetRequest.Builder columnLevelPermissionRules(Consumer<ColumnLevelPermissionRule.Builder>... columnLevelPermissionRules)

A set of one or more definitions of a ColumnLevelPermissionRule .

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to columnLevelPermissionRules(List<ColumnLevelPermissionRule>).

Parameters:

columnLevelPermissionRules - a consumer that will call methods on ColumnLevelPermissionRule.Builder

Returns:

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

See Also:

• columnLevelPermissionRules(java.util.Collection<ColumnLevelPermissionRule>)

tags

CreateDataSetRequest.Builder tags(Collection<Tag> tags)

Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.

Parameters:

tags - Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.

Returns:

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

tags

CreateDataSetRequest.Builder tags(Tag... tags)

Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.

Parameters:

tags - Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.

Returns:

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

tags

CreateDataSetRequest.Builder tags(Consumer<Tag.Builder>... tags)

Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.

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<Tag>).

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<Tag>)

dataSetUsageConfiguration

CreateDataSetRequest.Builder dataSetUsageConfiguration(DataSetUsageConfiguration dataSetUsageConfiguration)

Sets the value of the DataSetUsageConfiguration property for this object.

Parameters:

dataSetUsageConfiguration - The new value for the DataSetUsageConfiguration property for this object.

Returns:

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

dataSetUsageConfiguration

default CreateDataSetRequest.Builder dataSetUsageConfiguration(Consumer<DataSetUsageConfiguration.Builder> dataSetUsageConfiguration)

Sets the value of the DataSetUsageConfiguration property for this object. This is a convenience method that creates an instance of the DataSetUsageConfiguration.Builder avoiding the need to create one manually via DataSetUsageConfiguration.builder().

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

Parameters:

dataSetUsageConfiguration - a consumer that will call methods on DataSetUsageConfiguration.Builder

Returns:

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

See Also:

• dataSetUsageConfiguration(DataSetUsageConfiguration)

datasetParameters

CreateDataSetRequest.Builder datasetParameters(Collection<DatasetParameter> datasetParameters)

The parameter declarations of the dataset.

Parameters:

datasetParameters - The parameter declarations of the dataset.

Returns:

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

datasetParameters

CreateDataSetRequest.Builder datasetParameters(DatasetParameter... datasetParameters)

The parameter declarations of the dataset.

Parameters:

datasetParameters - The parameter declarations of the dataset.

Returns:

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

datasetParameters

CreateDataSetRequest.Builder datasetParameters(Consumer<DatasetParameter.Builder>... datasetParameters)

The parameter declarations of the dataset.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to datasetParameters(List<DatasetParameter>).

Parameters:

datasetParameters - a consumer that will call methods on DatasetParameter.Builder

Returns:

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

See Also:

• datasetParameters(java.util.Collection<DatasetParameter>)

folderArns

CreateDataSetRequest.Builder folderArns(Collection<String> folderArns)

When you create the dataset, Amazon QuickSight adds the dataset to these folders.

Parameters:

folderArns - When you create the dataset, Amazon QuickSight adds the dataset to these folders.

Returns:

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

folderArns

CreateDataSetRequest.Builder folderArns(String... folderArns)

When you create the dataset, Amazon QuickSight adds the dataset to these folders.

Parameters:

folderArns - When you create the dataset, Amazon QuickSight adds the dataset to these folders.

Returns:

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

overrideConfiguration

CreateDataSetRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

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

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.