Class DataSet
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<DataSet.Builder,
DataSet>
Dataset.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
arn()
The Amazon Resource Name (ARN) of the resource.static DataSet.Builder
builder()
final List
<ColumnGroup> Groupings of columns that work together in certain Amazon QuickSight features.final List
<ColumnLevelPermissionRule> A set of one or more definitions of aColumnLevelPermissionRule
.final Long
The amount of SPICE capacity used by this dataset.final Instant
The time that this dataset was created.final String
The ID of the dataset.final List
<DatasetParameter> The parameters that are declared in a dataset.The usage configuration to apply to child datasets that reference this dataset as a source.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Map
<String, FieldFolder> The folder that contains fields and nested subfolders for your dataset.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the ColumnGroups property.final boolean
For responses, this returns true if the service returned a value for the ColumnLevelPermissionRules property.final boolean
For responses, this returns true if the service returned a value for the DatasetParameters property.final boolean
For responses, this returns true if the service returned a value for the FieldFolders property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the LogicalTableMap property.final boolean
For responses, this returns true if the service returned a value for the OutputColumns property.final boolean
For responses, this returns true if the service returned a value for the PhysicalTableMap property.final DataSetImportMode
A value that indicates whether you want to import the data into SPICE.final String
A value that indicates whether you want to import the data into SPICE.final Instant
The last time that this dataset was updated.final Map
<String, LogicalTable> Configures the combination and transformation of the data from the physical tables.final String
name()
A display name for the dataset.final List
<OutputColumn> The list of columns after all transforms.final Map
<String, PhysicalTable> Declares the physical tables that are available in the underlying data sources.The row-level security configuration for the dataset.The element you can use to define tags for row-level security.static Class
<? extends DataSet.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
arn
The Amazon Resource Name (ARN) of the resource.
- Returns:
- The Amazon Resource Name (ARN) of the resource.
-
dataSetId
The ID of the dataset.
- Returns:
- The ID of the dataset.
-
name
A display name for the dataset.
- Returns:
- A display name for the dataset.
-
createdTime
The time that this dataset was created.
- Returns:
- The time that this dataset was created.
-
lastUpdatedTime
The last time that this dataset was updated.
- Returns:
- The last time that this dataset was updated.
-
hasPhysicalTableMap
public final boolean hasPhysicalTableMap()For responses, this returns true if the service returned a value for the PhysicalTableMap property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
physicalTableMap
Declares the physical tables that are available in the underlying data sources.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasPhysicalTableMap()
method.- Returns:
- Declares the physical tables that are available in the underlying data sources.
-
hasLogicalTableMap
public final boolean hasLogicalTableMap()For responses, this returns true if the service returned a value for the LogicalTableMap property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
logicalTableMap
Configures the combination and transformation of the data from the physical tables.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasLogicalTableMap()
method.- Returns:
- Configures the combination and transformation of the data from the physical tables.
-
hasOutputColumns
public final boolean hasOutputColumns()For responses, this returns true if the service returned a value for the OutputColumns property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
outputColumns
The list of columns after all transforms. These columns are available in templates, analyses, and dashboards.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasOutputColumns()
method.- Returns:
- The list of columns after all transforms. These columns are available in templates, analyses, and dashboards.
-
importMode
A value that indicates whether you want to import the data into SPICE.
If the service returns an enum value that is not available in the current SDK version,
importMode
will returnDataSetImportMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromimportModeAsString()
.- Returns:
- A value that indicates whether you want to import the data into SPICE.
- See Also:
-
importModeAsString
A value that indicates whether you want to import the data into SPICE.
If the service returns an enum value that is not available in the current SDK version,
importMode
will returnDataSetImportMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromimportModeAsString()
.- Returns:
- A value that indicates whether you want to import the data into SPICE.
- See Also:
-
consumedSpiceCapacityInBytes
The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't imported into SPICE.
- Returns:
- The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't imported into SPICE.
-
hasColumnGroups
public final boolean hasColumnGroups()For responses, this returns true if the service returned a value for the ColumnGroups property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
columnGroups
Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasColumnGroups()
method.- Returns:
- Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.
-
hasFieldFolders
public final boolean hasFieldFolders()For responses, this returns true if the service returned a value for the FieldFolders property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
fieldFolders
The folder that contains fields and nested subfolders for your dataset.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasFieldFolders()
method.- Returns:
- The folder that contains fields and nested subfolders for your dataset.
-
rowLevelPermissionDataSet
The row-level security configuration for the dataset.
- Returns:
- The row-level security configuration for the dataset.
-
rowLevelPermissionTagConfiguration
The element you can use to define tags for row-level security.
- Returns:
- The element you can use to define tags for row-level security.
-
hasColumnLevelPermissionRules
public final boolean hasColumnLevelPermissionRules()For responses, this returns true if the service returned a value for the ColumnLevelPermissionRules property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
columnLevelPermissionRules
A set of one or more definitions of a
ColumnLevelPermissionRule
.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasColumnLevelPermissionRules()
method.- Returns:
- A set of one or more definitions of a
ColumnLevelPermissionRule
.
-
dataSetUsageConfiguration
The usage configuration to apply to child datasets that reference this dataset as a source.
- Returns:
- The usage configuration to apply to child datasets that reference this dataset as a source.
-
hasDatasetParameters
public final boolean hasDatasetParameters()For responses, this returns true if the service returned a value for the DatasetParameters property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
datasetParameters
The parameters that are declared in a dataset.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasDatasetParameters()
method.- Returns:
- The parameters that are declared in a dataset.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<DataSet.Builder,
DataSet> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-