Class DataSetSummary

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

Dataset summary.

See Also:

  • Method Details

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the dataset.

      Returns:
      The Amazon Resource Name (ARN) of the dataset.

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

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

    • rowLevelPermissionDataSet

      public final RowLevelPermissionDataSet rowLevelPermissionDataSet()

      The row-level security configuration for the dataset in the legacy data preparation experience.

      Returns:
      The row-level security configuration for the dataset in the legacy data preparation experience.

    • hasRowLevelPermissionDataSetMap

      public final boolean hasRowLevelPermissionDataSetMap()
      For responses, this returns true if the service returned a value for the RowLevelPermissionDataSetMap 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.

    • rowLevelPermissionDataSetMap

      public final Map<String,RowLevelPermissionDataSet> rowLevelPermissionDataSetMap()

      The row-level security configuration for the dataset in the new data preparation experience.

      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 hasRowLevelPermissionDataSetMap() method.

      Returns:
      The row-level security configuration for the dataset in the new data preparation experience.

    • rowLevelPermissionTagConfigurationApplied

      public final Boolean rowLevelPermissionTagConfigurationApplied()

      Whether or not the row level permission tags are applied.

      Returns:
      Whether or not the row level permission tags are applied.

    • columnLevelPermissionRulesApplied

      public final Boolean columnLevelPermissionRulesApplied()

      A value that indicates if the dataset has column level permission configured.

      Returns:
      A value that indicates if the dataset has column level permission configured.

    • useAs

      public final DataSetUseAs useAs()

      The usage of the dataset.

      If the service returns an enum value that is not available in the current SDK version, useAs will return DataSetUseAs.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from useAsAsString().

      Returns:
      The usage of the dataset.
      See Also:

    • useAsAsString

      public final String useAsAsString()

      The usage of the dataset.

      If the service returns an enum value that is not available in the current SDK version, useAs will return DataSetUseAs.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from useAsAsString().

      Returns:
      The usage of the dataset.
      See Also:

    • toBuilder

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

    • builder

      public static DataSetSummary.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DataSetSummary.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.