DataSet (AWS Java SDK :: Services :: QuickSight 2.15.13 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.
`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.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasColumnGroups()` Returns true if the ColumnGroups property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasLogicalTableMap()` Returns true if the LogicalTableMap property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasOutputColumns()` Returns true if the OutputColumns property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasPhysicalTableMap()` Returns true if the PhysicalTableMap property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`DataSetImportMode`	`importMode()` Indicates whether you want to import the data into SPICE.
`String`	`importModeAsString()` 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.
`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 String arn()
```
    The Amazon Resource Name (ARN) of the resource.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the resource.
  - dataSetId
```
public String dataSetId()
```
    The ID of the dataset.
    
    Returns:
    
    The ID of the dataset.
  - name
```
public String name()
```
    A display name for the dataset.
    
    Returns:
    
    A display name for the dataset.
  - createdTime
```
public Instant createdTime()
```
    The time that this dataset was created.
    
    Returns:
    
    The time that this dataset was created.
  - lastUpdatedTime
```
public Instant lastUpdatedTime()
```
    The last time that this dataset was updated.
    
    Returns:
    
    The last time that this dataset was updated.
  - hasPhysicalTableMap
```
public boolean hasPhysicalTableMap()
```
    Returns true if the PhysicalTableMap property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - physicalTableMap
```
public 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.
    
    You can use hasPhysicalTableMap() to see if a value was sent in this field.
    
    Returns:
    
    Declares the physical tables that are available in the underlying data sources.
  - hasLogicalTableMap
```
public boolean hasLogicalTableMap()
```
    Returns true if the LogicalTableMap property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - logicalTableMap
```
public 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.
    
    You can use hasLogicalTableMap() to see if a value was sent in this field.
    
    Returns:
    
    Configures the combination and transformation of the data from the physical tables.
  - hasOutputColumns
```
public boolean hasOutputColumns()
```
    Returns true if the OutputColumns property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - outputColumns
```
public 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.
    
    You can use hasOutputColumns() to see if a value was sent in this field.
    
    Returns:
    
    The list of columns after all transforms. These columns are available in templates, analyses, and dashboards.
  - importMode
```
public DataSetImportMode importMode()
```
    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:
    
    Indicates whether you want to import the data into SPICE.
    
    See Also:
    
    DataSetImportMode
  - importModeAsString
```
public String importModeAsString()
```
    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:
    
    Indicates whether you want to import the data into SPICE.
    
    See Also:
    
    DataSetImportMode
  - consumedSpiceCapacityInBytes
```
public 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 boolean hasColumnGroups()
```
    Returns true if the ColumnGroups property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - columnGroups
```
public 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.
    
    You can use hasColumnGroups() to see if a value was sent in this field.
    
    Returns:
    
    Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.
  - rowLevelPermissionDataSet
```
public RowLevelPermissionDataSet rowLevelPermissionDataSet()
```
    The row-level security configuration for the dataset.
    
    Returns:
    
    The row-level security configuration for the dataset.
  - 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 int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public 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

rowLevelPermissionDataSet

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields