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 QuickSight features.columnGroups
(Consumer<ColumnGroup.Builder>... columnGroups) Groupings of columns that work together in certain Amazon QuickSight features.columnGroups
(ColumnGroup... columnGroups) Groupings of columns that work together in certain Amazon QuickSight 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
.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.Builder
dataSetUsageConfiguration
(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 QuickSight adds the dataset to these folders.folderArns
(Collection<String> folderArns) When you create the dataset, Amazon QuickSight 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) Configures the combination and transformation of the data from the physical tables.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.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.Builder
rowLevelPermissionDataSet
(Consumer<RowLevelPermissionDataSet.Builder> rowLevelPermissionDataSet) The row-level security configuration for the data that you want to create.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.rowLevelPermissionTagConfiguration
(RowLevelPermissionTagConfiguration rowLevelPermissionTagConfiguration) The configuration of tags on a dataset to set row-level security.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.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
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
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
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 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
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
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.Builder
avoiding the need to create one manually viaColumnGroup.builder()
.When the
Consumer
completes,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.Builder
avoiding the need to create one manually viaResourcePermission.builder()
.When the
Consumer
completes,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
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 theRowLevelPermissionDataSet.Builder
avoiding the need to create one manually viaRowLevelPermissionDataSet.builder()
.When the
Consumer
completes,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
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 theRowLevelPermissionTagConfiguration.Builder
avoiding the need to create one manually viaRowLevelPermissionTagConfiguration.builder()
.When the
Consumer
completes,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.Builder
avoiding the need to create one manually viaColumnLevelPermissionRule.builder()
.When the
Consumer
completes,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.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,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.Builder
avoiding the need to create one manually viaDataSetUsageConfiguration.builder()
.When the
Consumer
completes,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.Builder
avoiding the need to create one manually viaDatasetParameter.builder()
.When the
Consumer
completes,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 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
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 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.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-