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
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description DataSet.Builderarn(String arn)The Amazon Resource Name (ARN) of the resource.DataSet.BuildercolumnGroups(Collection<ColumnGroup> columnGroups)Groupings of columns that work together in certain Amazon QuickSight features.DataSet.BuildercolumnGroups(Consumer<ColumnGroup.Builder>... columnGroups)Groupings of columns that work together in certain Amazon QuickSight features.DataSet.BuildercolumnGroups(ColumnGroup... columnGroups)Groupings of columns that work together in certain Amazon QuickSight features.DataSet.BuildercolumnLevelPermissionRules(Collection<ColumnLevelPermissionRule> columnLevelPermissionRules)A set of one or more definitions of aColumnLevelPermissionRule.DataSet.BuildercolumnLevelPermissionRules(Consumer<ColumnLevelPermissionRule.Builder>... columnLevelPermissionRules)A set of one or more definitions of aColumnLevelPermissionRule.DataSet.BuildercolumnLevelPermissionRules(ColumnLevelPermissionRule... columnLevelPermissionRules)A set of one or more definitions of aColumnLevelPermissionRule.DataSet.BuilderconsumedSpiceCapacityInBytes(Long consumedSpiceCapacityInBytes)The amount of SPICE capacity used by this dataset.DataSet.BuildercreatedTime(Instant createdTime)The time that this dataset was created.DataSet.BuilderdataSetId(String dataSetId)The ID of the dataset.DataSet.BuilderdatasetParameters(Collection<DatasetParameter> datasetParameters)The parameters that are declared in a dataset.DataSet.BuilderdatasetParameters(Consumer<DatasetParameter.Builder>... datasetParameters)The parameters that are declared in a dataset.DataSet.BuilderdatasetParameters(DatasetParameter... datasetParameters)The parameters that are declared in a dataset.default DataSet.BuilderdataSetUsageConfiguration(Consumer<DataSetUsageConfiguration.Builder> dataSetUsageConfiguration)The usage configuration to apply to child datasets that reference this dataset as a source.DataSet.BuilderdataSetUsageConfiguration(DataSetUsageConfiguration dataSetUsageConfiguration)The usage configuration to apply to child datasets that reference this dataset as a source.DataSet.BuilderfieldFolders(Map<String,FieldFolder> fieldFolders)The folder that contains fields and nested subfolders for your dataset.DataSet.BuilderimportMode(String importMode)A value that indicates whether you want to import the data into SPICE.DataSet.BuilderimportMode(DataSetImportMode importMode)A value that indicates whether you want to import the data into SPICE.DataSet.BuilderlastUpdatedTime(Instant lastUpdatedTime)The last time that this dataset was updated.DataSet.BuilderlogicalTableMap(Map<String,LogicalTable> logicalTableMap)Configures the combination and transformation of the data from the physical tables.DataSet.Buildername(String name)A display name for the dataset.DataSet.BuilderoutputColumns(Collection<OutputColumn> outputColumns)The list of columns after all transforms.DataSet.BuilderoutputColumns(Consumer<OutputColumn.Builder>... outputColumns)The list of columns after all transforms.DataSet.BuilderoutputColumns(OutputColumn... outputColumns)The list of columns after all transforms.default DataSet.BuilderperformanceConfiguration(Consumer<PerformanceConfiguration.Builder> performanceConfiguration)The performance optimization configuration of a dataset.DataSet.BuilderperformanceConfiguration(PerformanceConfiguration performanceConfiguration)The performance optimization configuration of a dataset.DataSet.BuilderphysicalTableMap(Map<String,PhysicalTable> physicalTableMap)Declares the physical tables that are available in the underlying data sources.default DataSet.BuilderrowLevelPermissionDataSet(Consumer<RowLevelPermissionDataSet.Builder> rowLevelPermissionDataSet)The row-level security configuration for the dataset.DataSet.BuilderrowLevelPermissionDataSet(RowLevelPermissionDataSet rowLevelPermissionDataSet)The row-level security configuration for the dataset.default DataSet.BuilderrowLevelPermissionTagConfiguration(Consumer<RowLevelPermissionTagConfiguration.Builder> rowLevelPermissionTagConfiguration)The element you can use to define tags for row-level security.DataSet.BuilderrowLevelPermissionTagConfiguration(RowLevelPermissionTagConfiguration rowLevelPermissionTagConfiguration)The element you can use to define tags for row-level security.DataSet.BuilderuseAs(String useAs)The usage of the dataset.DataSet.BuilderuseAs(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 Detail
-
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 theOutputColumn.Builderavoiding the need to create one manually viaOutputColumn.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#outputColumns(List.) - Parameters:
outputColumns- a consumer that will call methods onOutputColumn.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#outputColumns(java.util.Collection)
-
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 theColumnGroup.Builderavoiding the need to create one manually viaColumnGroup.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#columnGroups(List.) - Parameters:
columnGroups- a consumer that will call methods onColumnGroup.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#columnGroups(java.util.Collection)
-
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 theRowLevelPermissionDataSet.Builderavoiding the need to create one manually viaRowLevelPermissionDataSet.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed torowLevelPermissionDataSet(RowLevelPermissionDataSet).- Parameters:
rowLevelPermissionDataSet- a consumer that will call methods onRowLevelPermissionDataSet.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 theRowLevelPermissionTagConfiguration.Builderavoiding the need to create one manually viaRowLevelPermissionTagConfiguration.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed torowLevelPermissionTagConfiguration(RowLevelPermissionTagConfiguration).- Parameters:
rowLevelPermissionTagConfiguration- a consumer that will call methods onRowLevelPermissionTagConfiguration.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 aColumnLevelPermissionRule.- 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 aColumnLevelPermissionRule.- 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
This is a convenience method that creates an instance of theColumnLevelPermissionRule.ColumnLevelPermissionRule.Builderavoiding the need to create one manually viaColumnLevelPermissionRule.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#columnLevelPermissionRules(List.) - Parameters:
columnLevelPermissionRules- a consumer that will call methods onColumnLevelPermissionRule.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#columnLevelPermissionRules(java.util.Collection)
-
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 theDataSetUsageConfiguration.Builderavoiding the need to create one manually viaDataSetUsageConfiguration.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed todataSetUsageConfiguration(DataSetUsageConfiguration).- Parameters:
dataSetUsageConfiguration- a consumer that will call methods onDataSetUsageConfiguration.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 theDatasetParameter.Builderavoiding the need to create one manually viaDatasetParameter.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#datasetParameters(List.) - Parameters:
datasetParameters- a consumer that will call methods onDatasetParameter.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#datasetParameters(java.util.Collection)
-
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 thePerformanceConfiguration.Builderavoiding the need to create one manually viaPerformanceConfiguration.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toperformanceConfiguration(PerformanceConfiguration).- Parameters:
performanceConfiguration- a consumer that will call methods onPerformanceConfiguration.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
-
-