Package software.amazon.awssdk.services.quicksight.model

Class UpdateDataSetRequest

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.UpdateDataSetRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateDataSetRequest.Builder,UpdateDataSetRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateDataSetRequest extends QuickSightRequest implements ToCopyableBuilder<UpdateDataSetRequest.Builder,UpdateDataSetRequest>

  • Method Details

    • awsAccountId

      public final String awsAccountId()

      The Amazon Web Services account ID.

      Returns:
      The Amazon Web Services account ID.

    • dataSetId

      public final String dataSetId()

      The ID for the dataset that you want to update. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

      Returns:
      The ID for the dataset that you want to update. 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:

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

    • 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 data you want to create.

      Returns:
      The row-level security configuration for the data 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 .

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

    • toBuilder

      public UpdateDataSetRequest.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<UpdateDataSetRequest.Builder,UpdateDataSetRequest>
      Specified by:
      toBuilder in class QuickSightRequest
      Returns:
      a builder for type T

    • builder

      public static UpdateDataSetRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UpdateDataSetRequest.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)
      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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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

      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.