DataSet (AWS Java SDK :: Services :: QuickSight 2.17.166 API)

java.lang.Object
- software.amazon.awssdk.services.quicksight.model.DataSet

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<DataSet.Builder,DataSet>

@Generated(value="software.amazon.awssdk:codegen")
public final class DataSet
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DataSet.Builder,DataSet>

Dataset.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DataSet.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`DataSet.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`arn()` The Amazon Resource Name (ARN) of the resource.
`static DataSet.Builder`	`builder()`
`List<ColumnGroup>`	`columnGroups()` Groupings of columns that work together in certain Amazon QuickSight features.
`List<ColumnLevelPermissionRule>`	`columnLevelPermissionRules()` A set of one or more definitions of a `ColumnLevelPermissionRule` .
`Long`	`consumedSpiceCapacityInBytes()` The amount of SPICE capacity used by this dataset.
`Instant`	`createdTime()` The time that this dataset was created.
`String`	`dataSetId()` The ID of the dataset.
`DataSetUsageConfiguration`	`dataSetUsageConfiguration()` The usage configuration to apply to child datasets that reference this dataset as a source.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`Map<String,FieldFolder>`	`fieldFolders()` The folder that contains fields and nested subfolders for your dataset.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasColumnGroups()` For responses, this returns true if the service returned a value for the ColumnGroups property.
`boolean`	`hasColumnLevelPermissionRules()` For responses, this returns true if the service returned a value for the ColumnLevelPermissionRules property.
`boolean`	`hasFieldFolders()` For responses, this returns true if the service returned a value for the FieldFolders property.
`int`	`hashCode()`
`boolean`	`hasLogicalTableMap()` For responses, this returns true if the service returned a value for the LogicalTableMap property.
`boolean`	`hasOutputColumns()` For responses, this returns true if the service returned a value for the OutputColumns property.
`boolean`	`hasPhysicalTableMap()` For responses, this returns true if the service returned a value for the PhysicalTableMap property.
`DataSetImportMode`	`importMode()` A value that indicates whether you want to import the data into SPICE.
`String`	`importModeAsString()` A value that indicates whether you want to import the data into SPICE.
`Instant`	`lastUpdatedTime()` The last time that this dataset was updated.
`Map<String,LogicalTable>`	`logicalTableMap()` Configures the combination and transformation of the data from the physical tables.
`String`	`name()` A display name for the dataset.
`List<OutputColumn>`	`outputColumns()` The list of columns after all transforms.
`Map<String,PhysicalTable>`	`physicalTableMap()` Declares the physical tables that are available in the underlying data sources.
`RowLevelPermissionDataSet`	`rowLevelPermissionDataSet()` The row-level security configuration for the dataset.
`RowLevelPermissionTagConfiguration`	`rowLevelPermissionTagConfiguration()` The element you can use to define tags for row-level security.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DataSet.Builder>`	`serializableBuilderClass()`
`DataSet.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - arn
```
public final String arn()
```
    The Amazon Resource Name (ARN) of the resource.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the resource.
  - dataSetId
```
public final String dataSetId()
```
    The ID of the dataset.
    
    Returns:
    
    The ID of the dataset.
  - name
```
public final String name()
```
    A display name for the dataset.
    
    Returns:
    
    A display name for the dataset.
  - createdTime
```
public final Instant createdTime()
```
    The time that this dataset was created.
    
    Returns:
    
    The time that this dataset was created.
  - lastUpdatedTime
```
public final Instant 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 the isEmpty() 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
```
public final Map<String,PhysicalTable> 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 the isEmpty() 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
```
public final Map<String,LogicalTable> 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 the isEmpty() 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
```
public final List<OutputColumn> 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
```
public final DataSetImportMode 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 return DataSetImportMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from importModeAsString().
    
    Returns:
    
    A value that indicates whether you want to import the data into SPICE.
    
    See Also:
    
    DataSetImportMode
  - importModeAsString
```
public final String 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 return DataSetImportMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from importModeAsString().
    
    Returns:
    
    A value that indicates whether you want to import the data into SPICE.
    
    See Also:
    
    DataSetImportMode
  - consumedSpiceCapacityInBytes
```
public final Long 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 the isEmpty() 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
```
public final List<ColumnGroup> 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 the isEmpty() 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
```
public final Map<String,FieldFolder> 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
```
public final RowLevelPermissionDataSet rowLevelPermissionDataSet()
```
    The row-level security configuration for the dataset.
    
    Returns:
    
    The row-level security configuration for the dataset.
  - rowLevelPermissionTagConfiguration
```
public final RowLevelPermissionTagConfiguration 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 the isEmpty() 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
```
public final List<ColumnLevelPermissionRule> 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
```
public final DataSetUsageConfiguration 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.
  - toBuilder
```
public DataSet.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DataSet.Builder,DataSet>
  - builder
```
public static DataSet.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DataSet.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String 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.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class DataSet

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

arn

dataSetId

name

createdTime

lastUpdatedTime

hasPhysicalTableMap

physicalTableMap

hasLogicalTableMap

logicalTableMap

hasOutputColumns

outputColumns

importMode

importModeAsString

consumedSpiceCapacityInBytes

hasColumnGroups

columnGroups

hasFieldFolders

fieldFolders

rowLevelPermissionDataSet

rowLevelPermissionTagConfiguration

hasColumnLevelPermissionRules

columnLevelPermissionRules

dataSetUsageConfiguration

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields