Class RowLevelPermissionTagConfiguration

java.lang.Object
software.amazon.awssdk.services.quicksight.model.RowLevelPermissionTagConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<RowLevelPermissionTagConfiguration.Builder,RowLevelPermissionTagConfiguration>

@Generated("software.amazon.awssdk:codegen") public final class RowLevelPermissionTagConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<RowLevelPermissionTagConfiguration.Builder,RowLevelPermissionTagConfiguration>

The configuration of tags on a dataset to set row-level security.

See Also:
  • Method Details

    • status

      public final Status status()

      The status of row-level security tags. If enabled, the status is ENABLED. If disabled, the status is DISABLED.

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

      Returns:
      The status of row-level security tags. If enabled, the status is ENABLED. If disabled, the status is DISABLED.
      See Also:
    • statusAsString

      public final String statusAsString()

      The status of row-level security tags. If enabled, the status is ENABLED. If disabled, the status is DISABLED.

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

      Returns:
      The status of row-level security tags. If enabled, the status is ENABLED. If disabled, the status is DISABLED.
      See Also:
    • hasTagRules

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

      public final List<RowLevelPermissionTagRule> tagRules()

      A set of rules associated with row-level security, such as the tag names and columns that they are assigned to.

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

      Returns:
      A set of rules associated with row-level security, such as the tag names and columns that they are assigned to.
    • hasTagRuleConfigurations

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

      public final List<List<String>> tagRuleConfigurations()

      A list of tag configuration rules to apply to a dataset. All tag configurations have the OR condition. Tags within each tile will be joined (AND). At least one rule in this structure must have all tag values assigned to it to apply Row-level security (RLS) 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 hasTagRuleConfigurations() method.

      Returns:
      A list of tag configuration rules to apply to a dataset. All tag configurations have the OR condition. Tags within each tile will be joined (AND). At least one rule in this structure must have all tag values assigned to it to apply Row-level security (RLS) to the dataset.
    • 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<RowLevelPermissionTagConfiguration.Builder,RowLevelPermissionTagConfiguration>
      Returns:
      a builder for type T
    • builder

    • serializableBuilderClass

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