java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.quicksight.model.QuickSightRequest
    - - software.amazon.awssdk.services.quicksight.model.CreateDataSetRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateDataSetRequest.Builder,CreateDataSetRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateDataSetRequest
extends QuickSightRequest
implements ToCopyableBuilder<CreateDataSetRequest.Builder,CreateDataSetRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface CreateDataSetRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`awsAccountId()`	The Amazon Web Services account ID.
`static CreateDataSetRequest.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` .
`String`	`dataSetId()`	An ID for the dataset that you want to create.
`List<DatasetParameter>`	`datasetParameters()`	The parameter declarations of the dataset.
`DataSetUsageConfiguration`	`dataSetUsageConfiguration()`	Returns the value of the DataSetUsageConfiguration property for this object.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`Map<String,FieldFolder>`	`fieldFolders()`	The folder that contains fields and nested subfolders for your dataset.
`List<String>`	`folderArns()`	When you create the dataset, Amazon QuickSight adds the dataset to these folders.
`<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`	`hasDatasetParameters()`	For responses, this returns true if the service returned a value for the DatasetParameters property.
`boolean`	`hasFieldFolders()`	For responses, this returns true if the service returned a value for the FieldFolders property.
`boolean`	`hasFolderArns()`	For responses, this returns true if the service returned a value for the FolderArns property.
`int`	`hashCode()`
`boolean`	`hasLogicalTableMap()`	For responses, this returns true if the service returned a value for the LogicalTableMap property.
`boolean`	`hasPermissions()`	For responses, this returns true if the service returned a value for the Permissions property.
`boolean`	`hasPhysicalTableMap()`	For responses, this returns true if the service returned a value for the PhysicalTableMap property.
`boolean`	`hasTags()`	For responses, this returns true if the service returned a value for the Tags property.
`DataSetImportMode`	`importMode()`	Indicates whether you want to import the data into SPICE.
`String`	`importModeAsString()`	Indicates whether you want to import the data into SPICE.
`Map<String,LogicalTable>`	`logicalTableMap()`	Configures the combination and transformation of the data from the physical tables.
`String`	`name()`	The display name for the dataset.
`List<ResourcePermission>`	`permissions()`	A list of resource permissions on the dataset.
`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 data that you want to create.
`RowLevelPermissionTagConfiguration`	`rowLevelPermissionTagConfiguration()`	The configuration of tags on a dataset to set row-level security.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateDataSetRequest.Builder>`	`serializableBuilderClass()`
`List<Tag>`	`tags()`	Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.
`CreateDataSetRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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
  - awsAccountId
```
public final String awsAccountId()
```
    The Amazon Web Services account ID.
    
    Returns:
    
    The Amazon Web Services account ID.
  - dataSetId
```
public final String dataSetId()
```
    An ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
    
    Returns:
    
    An ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
  - name
```
public final String name()
```
    The display name for the dataset.
    
    Returns:
    
    The display name for the dataset.
  - 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.
  - importMode
```
public final 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 final 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
  - 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.
  - hasPermissions
```
public final boolean hasPermissions()
```
    For responses, this returns true if the service returned a value for the Permissions 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.
  - permissions
```
public final List<ResourcePermission> permissions()
```
    A list of resource permissions on the 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 hasPermissions() method.
    
    Returns:
    
    A list of resource permissions on the dataset.
  - rowLevelPermissionDataSet
```
public final RowLevelPermissionDataSet rowLevelPermissionDataSet()
```
    The row-level security configuration for the data that you want to create.
    
    Returns:
    
    The row-level security configuration for the data that you want to create.
  - rowLevelPermissionTagConfiguration
```
public final RowLevelPermissionTagConfiguration rowLevelPermissionTagConfiguration()
```
    The configuration of tags on a dataset to set row-level security. Row-level security tags are currently supported for anonymous embedding only.
    
    Returns:
    
    The configuration of tags on a dataset to set row-level security. Row-level security tags are currently supported for anonymous embedding only.
  - 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 .
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags 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.
  - tags
```
public final List<Tag> tags()
```
    Contains a map of the key-value pairs for the resource tag or tags assigned to the 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 hasTags() method.
    
    Returns:
    
    Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.
  - dataSetUsageConfiguration
```
public final DataSetUsageConfiguration dataSetUsageConfiguration()
```
    Returns the value of the DataSetUsageConfiguration property for this object.
    
    Returns:
    
    The value of the DataSetUsageConfiguration property for this object.
  - 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 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.
  - datasetParameters
```
public final List<DatasetParameter> datasetParameters()
```
    The parameter declarations of the 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 parameter declarations of the dataset.
  - hasFolderArns
```
public final boolean hasFolderArns()
```
    For responses, this returns true if the service returned a value for the FolderArns 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.
  - folderArns
```
public final List<String> folderArns()
```
    When you create the dataset, Amazon QuickSight adds the dataset to these folders.
    
    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 hasFolderArns() method.
    
    Returns:
    
    When you create the dataset, Amazon QuickSight adds the dataset to these folders.
  - toBuilder
```
public CreateDataSetRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateDataSetRequest.Builder,CreateDataSetRequest>
    
    Specified by:
    
    toBuilder in class QuickSightRequest
  - builder
```
public static CreateDataSetRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateDataSetRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - 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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CreateDataSetRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

awsAccountId

dataSetId

name

hasPhysicalTableMap

physicalTableMap

hasLogicalTableMap

logicalTableMap

importMode

importModeAsString

hasColumnGroups

columnGroups

hasFieldFolders

fieldFolders

hasPermissions

permissions

rowLevelPermissionDataSet

rowLevelPermissionTagConfiguration

hasColumnLevelPermissionRules

columnLevelPermissionRules

hasTags

tags

dataSetUsageConfiguration

hasDatasetParameters

datasetParameters

hasFolderArns

folderArns

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields