Package software.amazon.awssdk.services.quicksight.model

Interface DataSet.Builder

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

        Parameters:
        dataSetId - The ID of the dataset.
        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).

        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)

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

        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)

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

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

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

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