Interface CreateDataSetRequest.Builder
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<CreateDataSetRequest.Builder,,CreateDataSetRequest> QuickSightRequest.Builder,SdkBuilder<CreateDataSetRequest.Builder,,CreateDataSetRequest> SdkPojo,SdkRequest.Builder
- Enclosing class:
CreateDataSetRequest
-
Method Summary
Modifier and TypeMethodDescriptionawsAccountId(String awsAccountId) The Amazon Web Services account ID.columnGroups(Collection<ColumnGroup> columnGroups) Groupings of columns that work together in certain Amazon Quick Sight features.columnGroups(Consumer<ColumnGroup.Builder>... columnGroups) Groupings of columns that work together in certain Amazon Quick Sight features.columnGroups(ColumnGroup... columnGroups) Groupings of columns that work together in certain Amazon Quick Sight features.columnLevelPermissionRules(Collection<ColumnLevelPermissionRule> columnLevelPermissionRules) A set of one or more definitions of aColumnLevelPermissionRule.columnLevelPermissionRules(Consumer<ColumnLevelPermissionRule.Builder>... columnLevelPermissionRules) A set of one or more definitions of aColumnLevelPermissionRule.columnLevelPermissionRules(ColumnLevelPermissionRule... columnLevelPermissionRules) A set of one or more definitions of aColumnLevelPermissionRule.default CreateDataSetRequest.BuilderdataPrepConfiguration(Consumer<DataPrepConfiguration.Builder> dataPrepConfiguration) The data preparation configuration for the dataset.dataPrepConfiguration(DataPrepConfiguration dataPrepConfiguration) The data preparation configuration for the dataset.An ID for the dataset that you want to create.datasetParameters(Collection<DatasetParameter> datasetParameters) The parameter declarations of the dataset.datasetParameters(Consumer<DatasetParameter.Builder>... datasetParameters) The parameter declarations of the dataset.datasetParameters(DatasetParameter... datasetParameters) The parameter declarations of the dataset.default CreateDataSetRequest.BuilderdataSetUsageConfiguration(Consumer<DataSetUsageConfiguration.Builder> dataSetUsageConfiguration) Sets the value of the DataSetUsageConfiguration property for this object.dataSetUsageConfiguration(DataSetUsageConfiguration dataSetUsageConfiguration) Sets the value of the DataSetUsageConfiguration property for this object.fieldFolders(Map<String, FieldFolder> fieldFolders) The folder that contains fields and nested subfolders for your dataset.folderArns(String... folderArns) When you create the dataset, Amazon Quick Sight adds the dataset to these folders.folderArns(Collection<String> folderArns) When you create the dataset, Amazon Quick Sight adds the dataset to these folders.importMode(String importMode) Indicates whether you want to import the data into SPICE.importMode(DataSetImportMode importMode) Indicates whether you want to import the data into SPICE.logicalTableMap(Map<String, LogicalTable> logicalTableMap) Deprecated.Only used in the legacy data preparation experience.The display name for the dataset.overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.default CreateDataSetRequest.BuilderperformanceConfiguration(Consumer<PerformanceConfiguration.Builder> performanceConfiguration) The configuration for the performance optimization of the dataset that contains aUniqueKeyconfiguration.performanceConfiguration(PerformanceConfiguration performanceConfiguration) The configuration for the performance optimization of the dataset that contains aUniqueKeyconfiguration.permissions(Collection<ResourcePermission> permissions) A list of resource permissions on the dataset.permissions(Consumer<ResourcePermission.Builder>... permissions) A list of resource permissions on the dataset.permissions(ResourcePermission... permissions) A list of resource permissions on the dataset.physicalTableMap(Map<String, PhysicalTable> physicalTableMap) Declares the physical tables that are available in the underlying data sources.default CreateDataSetRequest.BuilderrowLevelPermissionDataSet(Consumer<RowLevelPermissionDataSet.Builder> rowLevelPermissionDataSet) Deprecated.Only used in the legacy data preparation experience.rowLevelPermissionDataSet(RowLevelPermissionDataSet rowLevelPermissionDataSet) Deprecated.Only used in the legacy data preparation experience.default CreateDataSetRequest.BuilderrowLevelPermissionTagConfiguration(Consumer<RowLevelPermissionTagConfiguration.Builder> rowLevelPermissionTagConfiguration) Deprecated.Only used in the legacy data preparation experience.rowLevelPermissionTagConfiguration(RowLevelPermissionTagConfiguration rowLevelPermissionTagConfiguration) Deprecated.Only used in the legacy data preparation experience.default CreateDataSetRequest.BuildersemanticModelConfiguration(Consumer<SemanticModelConfiguration.Builder> semanticModelConfiguration) The semantic model configuration for the dataset.semanticModelConfiguration(SemanticModelConfiguration semanticModelConfiguration) The semantic model configuration for the dataset.tags(Collection<Tag> tags) Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.tags(Consumer<Tag.Builder>... tags) Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.The usage of the dataset.useAs(DataSetUseAs useAs) The usage of the dataset.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copyMethods inherited from interface software.amazon.awssdk.services.quicksight.model.QuickSightRequest.Builder
buildMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
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
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
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
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
Deprecated.Only used in the legacy data preparation experience.Configures the combination and transformation of the data from the physical tables. This parameter is used with the legacy data preparation experience.
- Parameters:
logicalTableMap- Configures the combination and transformation of the data from the physical tables. This parameter is used with the legacy data preparation experience.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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:
-
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:
-
columnGroups
Groupings of columns that work together in certain Amazon Quick Sight features. Currently, only geospatial hierarchy is supported.
- Parameters:
columnGroups- Groupings of columns that work together in certain Amazon Quick Sight features. Currently, only geospatial hierarchy is supported.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
columnGroups
Groupings of columns that work together in certain Amazon Quick Sight features. Currently, only geospatial hierarchy is supported.
- Parameters:
columnGroups- Groupings of columns that work together in certain Amazon Quick Sight features. Currently, only geospatial hierarchy is supported.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
columnGroups
Groupings of columns that work together in certain Amazon Quick Sight 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 tocolumnGroups(List<ColumnGroup>).- 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:
-
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
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
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
A list of resource permissions on the dataset.
This is a convenience method that creates an instance of theResourcePermission.Builderavoiding the need to create one manually viaResourcePermission.builder().When the
Consumercompletes,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:
-
rowLevelPermissionDataSet
@Deprecated CreateDataSetRequest.Builder rowLevelPermissionDataSet(RowLevelPermissionDataSet rowLevelPermissionDataSet) Deprecated.Only used in the legacy data preparation experience.The row-level security configuration for the data that you want to create. This parameter is used with the legacy data preparation experience.
- Parameters:
rowLevelPermissionDataSet- The row-level security configuration for the data that you want to create. This parameter is used with the legacy data preparation experience.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
rowLevelPermissionDataSet
@Deprecated default CreateDataSetRequest.Builder rowLevelPermissionDataSet(Consumer<RowLevelPermissionDataSet.Builder> rowLevelPermissionDataSet) Deprecated.Only used in the legacy data preparation experience.The row-level security configuration for the data that you want to create. This parameter is used with the legacy data preparation experience.
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:
-
rowLevelPermissionTagConfiguration
@Deprecated CreateDataSetRequest.Builder rowLevelPermissionTagConfiguration(RowLevelPermissionTagConfiguration rowLevelPermissionTagConfiguration) Deprecated.Only used in the legacy data preparation experience.The configuration of tags on a dataset to set row-level security. Row-level security tags are currently supported for anonymous embedding only. This parameter is used with the legacy data preparation experience.
- 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. This parameter is used with the legacy data preparation experience.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
rowLevelPermissionTagConfiguration
@Deprecated default CreateDataSetRequest.Builder rowLevelPermissionTagConfiguration(Consumer<RowLevelPermissionTagConfiguration.Builder> rowLevelPermissionTagConfiguration) Deprecated.Only used in the legacy data preparation experience.The configuration of tags on a dataset to set row-level security. Row-level security tags are currently supported for anonymous embedding only. This parameter is used with the legacy data preparation experience.
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:
-
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 aColumnLevelPermissionRule.- 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 aColumnLevelPermissionRule.- 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
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 tocolumnLevelPermissionRules(List<ColumnLevelPermissionRule>).- 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:
-
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
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
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 theTag.Builderavoiding the need to create one manually viaTag.builder().When the
Consumercompletes,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:
-
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 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:
-
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
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 theDatasetParameter.Builderavoiding the need to create one manually viaDatasetParameter.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed todatasetParameters(List<DatasetParameter>).- 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:
-
folderArns
When you create the dataset, Amazon Quick Sight adds the dataset to these folders.
- Parameters:
folderArns- When you create the dataset, Amazon Quick Sight adds the dataset to these folders.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
folderArns
When you create the dataset, Amazon Quick Sight adds the dataset to these folders.
- Parameters:
folderArns- When you create the dataset, Amazon Quick Sight adds the dataset to these folders.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
performanceConfiguration
CreateDataSetRequest.Builder performanceConfiguration(PerformanceConfiguration performanceConfiguration) The configuration for the performance optimization of the dataset that contains a
UniqueKeyconfiguration.- Parameters:
performanceConfiguration- The configuration for the performance optimization of the dataset that contains aUniqueKeyconfiguration.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
performanceConfiguration
default CreateDataSetRequest.Builder performanceConfiguration(Consumer<PerformanceConfiguration.Builder> performanceConfiguration) The configuration for the performance optimization of the dataset that contains a
This is a convenience method that creates an instance of theUniqueKeyconfiguration.PerformanceConfiguration.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:
-
useAs
The usage of the dataset.
RLS_RULESmust be specified for RLS permission datasets.- Parameters:
useAs- The usage of the dataset.RLS_RULESmust be specified for RLS permission datasets.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
useAs
The usage of the dataset.
RLS_RULESmust be specified for RLS permission datasets.- Parameters:
useAs- The usage of the dataset.RLS_RULESmust be specified for RLS permission datasets.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
dataPrepConfiguration
The data preparation configuration for the dataset. This configuration defines the source tables, transformation steps, and destination tables used to prepare the data. Required when using the new data preparation experience.
- Parameters:
dataPrepConfiguration- The data preparation configuration for the dataset. This configuration defines the source tables, transformation steps, and destination tables used to prepare the data. Required when using the new data preparation experience.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dataPrepConfiguration
default CreateDataSetRequest.Builder dataPrepConfiguration(Consumer<DataPrepConfiguration.Builder> dataPrepConfiguration) The data preparation configuration for the dataset. This configuration defines the source tables, transformation steps, and destination tables used to prepare the data. Required when using the new data preparation experience.
This is a convenience method that creates an instance of theDataPrepConfiguration.Builderavoiding the need to create one manually viaDataPrepConfiguration.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed todataPrepConfiguration(DataPrepConfiguration).- Parameters:
dataPrepConfiguration- a consumer that will call methods onDataPrepConfiguration.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
semanticModelConfiguration
CreateDataSetRequest.Builder semanticModelConfiguration(SemanticModelConfiguration semanticModelConfiguration) The semantic model configuration for the dataset. This configuration defines how the prepared data is structured for an analysis, including table mappings and row-level security configurations. Required when using the new data preparation experience.
- Parameters:
semanticModelConfiguration- The semantic model configuration for the dataset. This configuration defines how the prepared data is structured for an analysis, including table mappings and row-level security configurations. Required when using the new data preparation experience.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
semanticModelConfiguration
default CreateDataSetRequest.Builder semanticModelConfiguration(Consumer<SemanticModelConfiguration.Builder> semanticModelConfiguration) The semantic model configuration for the dataset. This configuration defines how the prepared data is structured for an analysis, including table mappings and row-level security configurations. Required when using the new data preparation experience.
This is a convenience method that creates an instance of theSemanticModelConfiguration.Builderavoiding the need to create one manually viaSemanticModelConfiguration.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tosemanticModelConfiguration(SemanticModelConfiguration).- Parameters:
semanticModelConfiguration- a consumer that will call methods onSemanticModelConfiguration.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
CreateDataSetRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.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.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
builderConsumer- AConsumerto which an emptyAwsRequestOverrideConfiguration.Builderwill be given.- Returns:
- This object for method chaining.
-