Class DataSet

java.lang.Object
software.amazon.awssdk.services.quicksight.model.DataSet
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<DataSet.Builder,DataSet>
@Generated("software.amazon.awssdk:codegen") public final class DataSet extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DataSet.Builder,DataSet>

Dataset.

See Also:

  • Method Details

    • 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:

    • 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:

    • 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.

    • 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 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

      public DataSet.Builder 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 interface ToCopyableBuilder<DataSet.Builder,DataSet>
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.