Interface DataSet.Builder

All Superinterfaces:

Buildable, CopyableBuilder<DataSet.Builder,DataSet>, SdkBuilder<DataSet.Builder,DataSet>, SdkPojo

Enclosing class:

DataSet

@Mutable
@NotThreadSafe
public static interface DataSet.Builder
extends SdkPojo, CopyableBuilder<DataSet.Builder,DataSet>

Method Summary

Modifier and Type	Method	Description
DataSet.Builder	arn(String arn)	The Amazon Resource Name (ARN) of the resource.
DataSet.Builder	columnGroups(Collection<ColumnGroup> columnGroups)	Groupings of columns that work together in certain Amazon QuickSight features.
DataSet.Builder	columnGroups(Consumer<ColumnGroup.Builder>... columnGroups)	Groupings of columns that work together in certain Amazon QuickSight features.
DataSet.Builder	columnGroups(ColumnGroup... columnGroups)	Groupings of columns that work together in certain Amazon QuickSight features.
DataSet.Builder	columnLevelPermissionRules(Collection<ColumnLevelPermissionRule> columnLevelPermissionRules)	A set of one or more definitions of a ColumnLevelPermissionRule .
DataSet.Builder	columnLevelPermissionRules(Consumer<ColumnLevelPermissionRule.Builder>... columnLevelPermissionRules)	A set of one or more definitions of a ColumnLevelPermissionRule .
DataSet.Builder	columnLevelPermissionRules(ColumnLevelPermissionRule... columnLevelPermissionRules)	A set of one or more definitions of a ColumnLevelPermissionRule .
DataSet.Builder	consumedSpiceCapacityInBytes(Long consumedSpiceCapacityInBytes)	The amount of SPICE capacity used by this dataset.
DataSet.Builder	createdTime(Instant createdTime)	The time that this dataset was created.
DataSet.Builder	dataSetId(String dataSetId)	The ID of the dataset.
DataSet.Builder	datasetParameters(Collection<DatasetParameter> datasetParameters)	The parameters that are declared in a dataset.
DataSet.Builder	datasetParameters(Consumer<DatasetParameter.Builder>... datasetParameters)	The parameters that are declared in a dataset.
DataSet.Builder	datasetParameters(DatasetParameter... datasetParameters)	The parameters that are declared in a dataset.
default DataSet.Builder	dataSetUsageConfiguration(Consumer<DataSetUsageConfiguration.Builder> dataSetUsageConfiguration)	The usage configuration to apply to child datasets that reference this dataset as a source.
DataSet.Builder	dataSetUsageConfiguration(DataSetUsageConfiguration dataSetUsageConfiguration)	The usage configuration to apply to child datasets that reference this dataset as a source.
DataSet.Builder	fieldFolders(Map<String,FieldFolder> fieldFolders)	The folder that contains fields and nested subfolders for your dataset.
DataSet.Builder	importMode(String importMode)	A value that indicates whether you want to import the data into SPICE.
DataSet.Builder	importMode(DataSetImportMode importMode)	A value that indicates whether you want to import the data into SPICE.
DataSet.Builder	lastUpdatedTime(Instant lastUpdatedTime)	The last time that this dataset was updated.
DataSet.Builder	logicalTableMap(Map<String,LogicalTable> logicalTableMap)	Configures the combination and transformation of the data from the physical tables.
DataSet.Builder	name(String name)	A display name for the dataset.
DataSet.Builder	outputColumns(Collection<OutputColumn> outputColumns)	The list of columns after all transforms.
DataSet.Builder	outputColumns(Consumer<OutputColumn.Builder>... outputColumns)	The list of columns after all transforms.
DataSet.Builder	outputColumns(OutputColumn... outputColumns)	The list of columns after all transforms.
default DataSet.Builder	performanceConfiguration(Consumer<PerformanceConfiguration.Builder> performanceConfiguration)	The performance optimization configuration of a dataset.
DataSet.Builder	performanceConfiguration(PerformanceConfiguration performanceConfiguration)	The performance optimization configuration of a dataset.
DataSet.Builder	physicalTableMap(Map<String,PhysicalTable> physicalTableMap)	Declares the physical tables that are available in the underlying data sources.
default DataSet.Builder	rowLevelPermissionDataSet(Consumer<RowLevelPermissionDataSet.Builder> rowLevelPermissionDataSet)	The row-level security configuration for the dataset.
DataSet.Builder	rowLevelPermissionDataSet(RowLevelPermissionDataSet rowLevelPermissionDataSet)	The row-level security configuration for the dataset.
default DataSet.Builder	rowLevelPermissionTagConfiguration(Consumer<RowLevelPermissionTagConfiguration.Builder> rowLevelPermissionTagConfiguration)	The element you can use to define tags for row-level security.
DataSet.Builder	rowLevelPermissionTagConfiguration(RowLevelPermissionTagConfiguration rowLevelPermissionTagConfiguration)	The element you can use to define tags for row-level security.
DataSet.Builder	useAs(String useAs)	The usage of the dataset.
DataSet.Builder	useAs(DataSetUseAs useAs)	The usage of the dataset.

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, sdkFieldNameToField, sdkFields

Method Details

arn

DataSet.Builder arn(String arn)

The Amazon Resource Name (ARN) of the resource.

Parameters:

arn - The Amazon Resource Name (ARN) of the resource.

Returns:

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

dataSetId

DataSet.Builder dataSetId(String dataSetId)

The ID of the dataset. Limited to 96 characters.

Parameters:

dataSetId - The ID of the dataset. Limited to 96 characters.

Returns:

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

name

DataSet.Builder name(String name)

A display name for the dataset.

Parameters:

name - A display name for the dataset.

Returns:

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

createdTime

DataSet.Builder createdTime(Instant createdTime)

The time that this dataset was created.

Parameters:

createdTime - The time that this dataset was created.

Returns:

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

lastUpdatedTime

DataSet.Builder lastUpdatedTime(Instant lastUpdatedTime)

The last time that this dataset was updated.

Parameters:

lastUpdatedTime - The last time that this dataset was updated.

Returns:

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

physicalTableMap

DataSet.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

DataSet.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.

outputColumns

DataSet.Builder outputColumns(Collection<OutputColumn> outputColumns)

The list of columns after all transforms. These columns are available in templates, analyses, and dashboards.

Parameters:

outputColumns - The list of columns after all transforms. These columns are available in templates, analyses, and dashboards.

Returns:

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

outputColumns

DataSet.Builder outputColumns(OutputColumn... outputColumns)

The list of columns after all transforms. These columns are available in templates, analyses, and dashboards.

Parameters:

outputColumns - The list of columns after all transforms. These columns are available in templates, analyses, and dashboards.

Returns:

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

outputColumns

DataSet.Builder outputColumns(Consumer<OutputColumn.Builder>... outputColumns)

The list of columns after all transforms. These columns are available in templates, analyses, and dashboards.

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

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

Parameters:

outputColumns - a consumer that will call methods on OutputColumn.Builder

Returns:

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

See Also:

• outputColumns(java.util.Collection<OutputColumn>)

importMode

DataSet.Builder importMode(String importMode)

A value that indicates whether you want to import the data into SPICE.

Parameters:

importMode - A value that 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

DataSet.Builder importMode(DataSetImportMode importMode)

A value that indicates whether you want to import the data into SPICE.

Parameters:

importMode - A value that 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

consumedSpiceCapacityInBytes

DataSet.Builder consumedSpiceCapacityInBytes(Long consumedSpiceCapacityInBytes)

The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't imported into SPICE.

Parameters:

consumedSpiceCapacityInBytes - The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't imported into SPICE.

Returns:

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

columnGroups

DataSet.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

DataSet.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

DataSet.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

DataSet.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.

rowLevelPermissionDataSet

DataSet.Builder rowLevelPermissionDataSet(RowLevelPermissionDataSet rowLevelPermissionDataSet)

The row-level security configuration for the dataset.

Parameters:

rowLevelPermissionDataSet - The row-level security configuration for the dataset.

Returns:

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

rowLevelPermissionDataSet

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

The row-level security configuration for the dataset.

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

DataSet.Builder rowLevelPermissionTagConfiguration(RowLevelPermissionTagConfiguration rowLevelPermissionTagConfiguration)

The element you can use to define tags for row-level security.

Parameters:

rowLevelPermissionTagConfiguration - The element you can use to define tags for row-level security.

Returns:

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

rowLevelPermissionTagConfiguration

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

The element you can use to define tags for row-level security.

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

DataSet.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

DataSet.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

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

dataSetUsageConfiguration

DataSet.Builder dataSetUsageConfiguration(DataSetUsageConfiguration dataSetUsageConfiguration)

The usage configuration to apply to child datasets that reference this dataset as a source.

Parameters:

dataSetUsageConfiguration - The usage configuration to apply to child datasets that reference this dataset as a source.

Returns:

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

dataSetUsageConfiguration

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

The usage configuration to apply to child datasets that reference this dataset as a source.

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

DataSet.Builder datasetParameters(Collection<DatasetParameter> datasetParameters)

The parameters that are declared in a dataset.

Parameters:

datasetParameters - The parameters that are declared in a dataset.

Returns:

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

datasetParameters

DataSet.Builder datasetParameters(DatasetParameter... datasetParameters)

The parameters that are declared in a dataset.

Parameters:

datasetParameters - The parameters that are declared in a dataset.

Returns:

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

datasetParameters

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

The parameters that are declared in a 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>)

performanceConfiguration

DataSet.Builder performanceConfiguration(PerformanceConfiguration performanceConfiguration)

The performance optimization configuration of a dataset.

Parameters:

performanceConfiguration - The performance optimization configuration of a dataset.

Returns:

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

performanceConfiguration

default DataSet.Builder performanceConfiguration(Consumer<PerformanceConfiguration.Builder> performanceConfiguration)

The performance optimization configuration of a dataset.

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

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

Parameters:

performanceConfiguration - a consumer that will call methods on PerformanceConfiguration.Builder

Returns:

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

See Also:

• performanceConfiguration(PerformanceConfiguration)

useAs

DataSet.Builder useAs(String useAs)

The usage of the dataset.

Parameters:

useAs - The usage of the dataset.

Returns:

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

See Also:

• DataSetUseAs
• DataSetUseAs

useAs

DataSet.Builder useAs(DataSetUseAs useAs)

The usage of the dataset.

Parameters:

useAs - The usage of the dataset.

Returns:

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

See Also:

• DataSetUseAs
• DataSetUseAs