Class CreateDataSetRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateDataSetRequest.Builder,
CreateDataSetRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The Amazon Web Services account ID.static CreateDataSetRequest.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 String
An ID for the dataset that you want to create.final List
<DatasetParameter> The parameter declarations of the dataset.Returns the value of the DataSetUsageConfiguration property for this object.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.When you create the dataset, Amazon QuickSight adds the dataset to these folders.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.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 boolean
For responses, this returns true if the service returned a value for the FolderArns 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 Permissions property.final boolean
For responses, this returns true if the service returned a value for the PhysicalTableMap property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final DataSetImportMode
Indicates whether you want to import the data into SPICE.final String
Indicates whether you want to import the data into SPICE.final Map
<String, LogicalTable> Configures the combination and transformation of the data from the physical tables.final String
name()
The display name for the dataset.final List
<ResourcePermission> A list of resource permissions on the dataset.final Map
<String, PhysicalTable> Declares the physical tables that are available in the underlying data sources.The row-level security configuration for the data that you want to create.The configuration of tags on a dataset to set row-level security.static Class
<? extends CreateDataSetRequest.Builder> tags()
Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.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 class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
awsAccountId
The Amazon Web Services account ID.
- Returns:
- The Amazon Web Services account ID.
-
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
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 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.
-
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 returnDataSetImportMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromimportModeAsString()
.- Returns:
- Indicates whether you want to import the data into SPICE.
- See Also:
-
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 returnDataSetImportMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromimportModeAsString()
.- Returns:
- Indicates whether you want to import the data into SPICE.
- See Also:
-
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.
-
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 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. -
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
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
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 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
.
-
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 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. -
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
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 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 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 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. -
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
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<CreateDataSetRequest.Builder,
CreateDataSetRequest> - Specified by:
toBuilder
in classQuickSightRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
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
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-