/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.quicksight.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *
* Dataset. *
* * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class DataSet implements Serializable, Cloneable, StructuredPojo { /** ** The Amazon Resource Name (ARN) of the resource. *
*/ private String arn; /** ** The ID of the dataset. *
*/ private String dataSetId; /** ** A display name for the dataset. *
*/ private String name; /** ** The time that this dataset was created. *
*/ private java.util.Date createdTime; /** ** The last time that this dataset was updated. *
*/ private java.util.Date lastUpdatedTime; /** ** Declares the physical tables that are available in the underlying data sources. *
*/ private java.util.Map* Configures the combination and transformation of the data from the physical tables. *
*/ private java.util.Map* The list of columns after all transforms. These columns are available in templates, analyses, and dashboards. *
*/ private java.util.List* A value that indicates whether you want to import the data into SPICE. *
*/ private String importMode; /** ** The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't imported into SPICE. *
*/ private Long consumedSpiceCapacityInBytes; /** ** Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial * hierarchy is supported. *
*/ private java.util.List* The folder that contains fields and nested subfolders for your dataset. *
*/ private java.util.Map* The row-level security configuration for the dataset. *
*/ private RowLevelPermissionDataSet rowLevelPermissionDataSet; /** ** The element you can use to define tags for row-level security. *
*/ private RowLevelPermissionTagConfiguration rowLevelPermissionTagConfiguration; /** *
* A set of one or more definitions of a
* ColumnLevelPermissionRule
* .
*
* The usage configuration to apply to child datasets that reference this dataset as a source. *
*/ private DataSetUsageConfiguration dataSetUsageConfiguration; /** ** The parameters that are declared in a dataset. *
*/ private java.util.List* The Amazon Resource Name (ARN) of the resource. *
* * @param arn * The Amazon Resource Name (ARN) of the resource. */ public void setArn(String arn) { this.arn = arn; } /** ** The Amazon Resource Name (ARN) of the resource. *
* * @return The Amazon Resource Name (ARN) of the resource. */ public String getArn() { return this.arn; } /** ** The Amazon Resource Name (ARN) of the resource. *
* * @param arn * The Amazon Resource Name (ARN) of the resource. * @return Returns a reference to this object so that method calls can be chained together. */ public DataSet withArn(String arn) { setArn(arn); return this; } /** ** The ID of the dataset. *
* * @param dataSetId * The ID of the dataset. */ public void setDataSetId(String dataSetId) { this.dataSetId = dataSetId; } /** ** The ID of the dataset. *
* * @return The ID of the dataset. */ public String getDataSetId() { return this.dataSetId; } /** ** The ID of the dataset. *
* * @param dataSetId * The ID of the dataset. * @return Returns a reference to this object so that method calls can be chained together. */ public DataSet withDataSetId(String dataSetId) { setDataSetId(dataSetId); return this; } /** ** A display name for the dataset. *
* * @param name * A display name for the dataset. */ public void setName(String name) { this.name = name; } /** ** A display name for the dataset. *
* * @return A display name for the dataset. */ public String getName() { return this.name; } /** ** A display name for the dataset. *
* * @param name * A display name for the dataset. * @return Returns a reference to this object so that method calls can be chained together. */ public DataSet withName(String name) { setName(name); return this; } /** ** The time that this dataset was created. *
* * @param createdTime * The time that this dataset was created. */ public void setCreatedTime(java.util.Date createdTime) { this.createdTime = createdTime; } /** ** The time that this dataset was created. *
* * @return The time that this dataset was created. */ public java.util.Date getCreatedTime() { return this.createdTime; } /** ** The time that this dataset was created. *
* * @param createdTime * The time that this dataset was created. * @return Returns a reference to this object so that method calls can be chained together. */ public DataSet withCreatedTime(java.util.Date createdTime) { setCreatedTime(createdTime); return this; } /** ** The last time that this dataset was updated. *
* * @param lastUpdatedTime * The last time that this dataset was updated. */ public void setLastUpdatedTime(java.util.Date lastUpdatedTime) { this.lastUpdatedTime = lastUpdatedTime; } /** ** The last time that this dataset was updated. *
* * @return The last time that this dataset was updated. */ public java.util.Date getLastUpdatedTime() { return this.lastUpdatedTime; } /** ** The last time that this dataset was updated. *
* * @param lastUpdatedTime * The last time that this dataset was updated. * @return Returns a reference to this object so that method calls can be chained together. */ public DataSet withLastUpdatedTime(java.util.Date lastUpdatedTime) { setLastUpdatedTime(lastUpdatedTime); return this; } /** ** Declares the physical tables that are available in the underlying data sources. *
* * @return Declares the physical tables that are available in the underlying data sources. */ public java.util.Map* Declares the physical tables that are available in the underlying data sources. *
* * @param physicalTableMap * Declares the physical tables that are available in the underlying data sources. */ public void setPhysicalTableMap(java.util.Map* Declares the physical tables that are available in the underlying data sources. *
* * @param physicalTableMap * Declares the physical tables that are available in the underlying data sources. * @return Returns a reference to this object so that method calls can be chained together. */ public DataSet withPhysicalTableMap(java.util.Map* Configures the combination and transformation of the data from the physical tables. *
* * @return Configures the combination and transformation of the data from the physical tables. */ public java.util.Map* Configures the combination and transformation of the data from the physical tables. *
* * @param logicalTableMap * Configures the combination and transformation of the data from the physical tables. */ public void setLogicalTableMap(java.util.Map* Configures the combination and transformation of the data from the physical tables. *
* * @param logicalTableMap * Configures the combination and transformation of the data from the physical tables. * @return Returns a reference to this object so that method calls can be chained together. */ public DataSet withLogicalTableMap(java.util.Map* The list of columns after all transforms. These columns are available in templates, analyses, and dashboards. *
* * @return The list of columns after all transforms. These columns are available in templates, analyses, and * dashboards. */ public java.util.List* The list of columns after all transforms. These columns are available in templates, analyses, and dashboards. *
* * @param outputColumns * The list of columns after all transforms. These columns are available in templates, analyses, and * dashboards. */ public void setOutputColumns(java.util.Collection* The list of columns after all transforms. These columns are available in templates, analyses, and dashboards. *
** NOTE: This method appends the values to the existing list (if any). Use * {@link #setOutputColumns(java.util.Collection)} or {@link #withOutputColumns(java.util.Collection)} if you want * to override the existing values. *
* * @param outputColumns * The list of columns after all transforms. These columns are available in templates, analyses, and * dashboards. * @return Returns a reference to this object so that method calls can be chained together. */ public DataSet withOutputColumns(OutputColumn... outputColumns) { if (this.outputColumns == null) { setOutputColumns(new java.util.ArrayList* The list of columns after all transforms. These columns are available in templates, analyses, and dashboards. *
* * @param outputColumns * The list of columns after all transforms. These columns are available in templates, analyses, and * dashboards. * @return Returns a reference to this object so that method calls can be chained together. */ public DataSet withOutputColumns(java.util.Collection* A value that indicates whether you want to import the data into SPICE. *
* * @param importMode * A value that indicates whether you want to import the data into SPICE. * @see DataSetImportMode */ public void setImportMode(String importMode) { this.importMode = importMode; } /** ** A value that indicates whether you want to import the data into SPICE. *
* * @return A value that indicates whether you want to import the data into SPICE. * @see DataSetImportMode */ public String getImportMode() { return this.importMode; } /** ** A value that indicates whether you want to import the data into SPICE. *
* * @param importMode * A value that indicates whether you want to import the data into SPICE. * @return Returns a reference to this object so that method calls can be chained together. * @see DataSetImportMode */ public DataSet withImportMode(String importMode) { setImportMode(importMode); return this; } /** ** A value that indicates whether you want to import the data into SPICE. *
* * @param importMode * A value that indicates whether you want to import the data into SPICE. * @return Returns a reference to this object so that method calls can be chained together. * @see DataSetImportMode */ public DataSet withImportMode(DataSetImportMode importMode) { this.importMode = importMode.toString(); return this; } /** ** The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't imported into SPICE. *
* * @param consumedSpiceCapacityInBytes * The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't imported into SPICE. */ public void setConsumedSpiceCapacityInBytes(Long consumedSpiceCapacityInBytes) { this.consumedSpiceCapacityInBytes = consumedSpiceCapacityInBytes; } /** ** The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't imported into SPICE. *
* * @return The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't imported into SPICE. */ public Long getConsumedSpiceCapacityInBytes() { return this.consumedSpiceCapacityInBytes; } /** ** The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't imported into SPICE. *
* * @param consumedSpiceCapacityInBytes * The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't imported into SPICE. * @return Returns a reference to this object so that method calls can be chained together. */ public DataSet withConsumedSpiceCapacityInBytes(Long consumedSpiceCapacityInBytes) { setConsumedSpiceCapacityInBytes(consumedSpiceCapacityInBytes); return this; } /** ** Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial * hierarchy is supported. *
* * @return Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial * hierarchy is supported. */ public java.util.List* Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial * hierarchy is supported. *
* * @param columnGroups * Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial * hierarchy is supported. */ public void setColumnGroups(java.util.Collection* Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial * hierarchy is supported. *
** NOTE: This method appends the values to the existing list (if any). Use * {@link #setColumnGroups(java.util.Collection)} or {@link #withColumnGroups(java.util.Collection)} if you want to * override the existing values. *
* * @param columnGroups * Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial * hierarchy is supported. * @return Returns a reference to this object so that method calls can be chained together. */ public DataSet withColumnGroups(ColumnGroup... columnGroups) { if (this.columnGroups == null) { setColumnGroups(new java.util.ArrayList* Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial * hierarchy is supported. *
* * @param columnGroups * Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial * hierarchy is supported. * @return Returns a reference to this object so that method calls can be chained together. */ public DataSet withColumnGroups(java.util.Collection* The folder that contains fields and nested subfolders for your dataset. *
* * @return The folder that contains fields and nested subfolders for your dataset. */ public java.util.Map* The folder that contains fields and nested subfolders for your dataset. *
* * @param fieldFolders * The folder that contains fields and nested subfolders for your dataset. */ public void setFieldFolders(java.util.Map* The folder that contains fields and nested subfolders for your dataset. *
* * @param fieldFolders * The folder that contains fields and nested subfolders for your dataset. * @return Returns a reference to this object so that method calls can be chained together. */ public DataSet withFieldFolders(java.util.Map* The row-level security configuration for the dataset. *
* * @param rowLevelPermissionDataSet * The row-level security configuration for the dataset. */ public void setRowLevelPermissionDataSet(RowLevelPermissionDataSet rowLevelPermissionDataSet) { this.rowLevelPermissionDataSet = rowLevelPermissionDataSet; } /** ** The row-level security configuration for the dataset. *
* * @return The row-level security configuration for the dataset. */ public RowLevelPermissionDataSet getRowLevelPermissionDataSet() { return this.rowLevelPermissionDataSet; } /** ** The row-level security configuration for the dataset. *
* * @param rowLevelPermissionDataSet * The row-level security configuration for the dataset. * @return Returns a reference to this object so that method calls can be chained together. */ public DataSet withRowLevelPermissionDataSet(RowLevelPermissionDataSet rowLevelPermissionDataSet) { setRowLevelPermissionDataSet(rowLevelPermissionDataSet); return this; } /** ** The element you can use to define tags for row-level security. *
* * @param rowLevelPermissionTagConfiguration * The element you can use to define tags for row-level security. */ public void setRowLevelPermissionTagConfiguration(RowLevelPermissionTagConfiguration rowLevelPermissionTagConfiguration) { this.rowLevelPermissionTagConfiguration = rowLevelPermissionTagConfiguration; } /** ** The element you can use to define tags for row-level security. *
* * @return The element you can use to define tags for row-level security. */ public RowLevelPermissionTagConfiguration getRowLevelPermissionTagConfiguration() { return this.rowLevelPermissionTagConfiguration; } /** ** The element you can use to define tags for row-level security. *
* * @param rowLevelPermissionTagConfiguration * The element you can use to define tags for row-level security. * @return Returns a reference to this object so that method calls can be chained together. */ public DataSet withRowLevelPermissionTagConfiguration(RowLevelPermissionTagConfiguration rowLevelPermissionTagConfiguration) { setRowLevelPermissionTagConfiguration(rowLevelPermissionTagConfiguration); return this; } /** *
* A set of one or more definitions of a
* ColumnLevelPermissionRule
* .
*
ColumnLevelPermissionRule
* .
*/
public java.util.List
* A set of one or more definitions of a
* ColumnLevelPermissionRule
* .
*
ColumnLevelPermissionRule
* .
*/
public void setColumnLevelPermissionRules(java.util.Collection
* A set of one or more definitions of a
* ColumnLevelPermissionRule
* .
*
* NOTE: This method appends the values to the existing list (if any). Use * {@link #setColumnLevelPermissionRules(java.util.Collection)} or * {@link #withColumnLevelPermissionRules(java.util.Collection)} if you want to override the existing values. *
* * @param columnLevelPermissionRules * A set of one or more definitions of a * ColumnLevelPermissionRule
* .
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DataSet withColumnLevelPermissionRules(ColumnLevelPermissionRule... columnLevelPermissionRules) {
if (this.columnLevelPermissionRules == null) {
setColumnLevelPermissionRules(new java.util.ArrayList
* A set of one or more definitions of a
* ColumnLevelPermissionRule
* .
*
ColumnLevelPermissionRule
* .
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DataSet withColumnLevelPermissionRules(java.util.Collection* The usage configuration to apply to child datasets that reference this dataset as a source. *
* * @param dataSetUsageConfiguration * The usage configuration to apply to child datasets that reference this dataset as a source. */ public void setDataSetUsageConfiguration(DataSetUsageConfiguration dataSetUsageConfiguration) { this.dataSetUsageConfiguration = dataSetUsageConfiguration; } /** ** The usage configuration to apply to child datasets that reference this dataset as a source. *
* * @return The usage configuration to apply to child datasets that reference this dataset as a source. */ public DataSetUsageConfiguration getDataSetUsageConfiguration() { return this.dataSetUsageConfiguration; } /** ** The usage configuration to apply to child datasets that reference this dataset as a source. *
* * @param dataSetUsageConfiguration * The usage configuration to apply to child datasets that reference this dataset as a source. * @return Returns a reference to this object so that method calls can be chained together. */ public DataSet withDataSetUsageConfiguration(DataSetUsageConfiguration dataSetUsageConfiguration) { setDataSetUsageConfiguration(dataSetUsageConfiguration); return this; } /** ** The parameters that are declared in a dataset. *
* * @return The parameters that are declared in a dataset. */ public java.util.List* The parameters that are declared in a dataset. *
* * @param datasetParameters * The parameters that are declared in a dataset. */ public void setDatasetParameters(java.util.Collection* The parameters that are declared in a dataset. *
** NOTE: This method appends the values to the existing list (if any). Use * {@link #setDatasetParameters(java.util.Collection)} or {@link #withDatasetParameters(java.util.Collection)} if * you want to override the existing values. *
* * @param datasetParameters * The parameters that are declared in a dataset. * @return Returns a reference to this object so that method calls can be chained together. */ public DataSet withDatasetParameters(DatasetParameter... datasetParameters) { if (this.datasetParameters == null) { setDatasetParameters(new java.util.ArrayList* The parameters that are declared in a dataset. *
* * @param datasetParameters * The parameters that are declared in a dataset. * @return Returns a reference to this object so that method calls can be chained together. */ public DataSet withDatasetParameters(java.util.Collection