Class RowLevelPermissionDataSet

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

Information about a dataset that contains permissions for row-level security (RLS). The permissions dataset maps fields to users or groups. For more information, see Using Row-Level Security (RLS) to Restrict Access to a Dataset in the Amazon QuickSight User Guide.

The option to deny permissions by setting PermissionPolicy to DENY_ACCESS is not supported for new RLS datasets.

See Also:

  • Method Details

    • namespace

      public final String namespace()

      The namespace associated with the dataset that contains permissions for RLS.

      Returns:
      The namespace associated with the dataset that contains permissions for RLS.

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.

      Returns:
      The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.

    • permissionPolicy

      public final RowLevelPermissionPolicy permissionPolicy()

      The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS is included for backward compatibility only.

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

      Returns:
      The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS is included for backward compatibility only.
      See Also:

    • permissionPolicyAsString

      public final String permissionPolicyAsString()

      The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS is included for backward compatibility only.

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

      Returns:
      The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS is included for backward compatibility only.
      See Also:

    • formatVersion

      public final RowLevelPermissionFormatVersion formatVersion()

      The user or group rules associated with the dataset that contains permissions for RLS.

      By default, FormatVersion is VERSION_1. When FormatVersion is VERSION_1, UserName and GroupName are required. When FormatVersion is VERSION_2, UserARN and GroupARN are required, and Namespace must not exist.

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

      Returns:
      The user or group rules associated with the dataset that contains permissions for RLS.

      By default, FormatVersion is VERSION_1. When FormatVersion is VERSION_1, UserName and GroupName are required. When FormatVersion is VERSION_2, UserARN and GroupARN are required, and Namespace must not exist.

      See Also:

    • formatVersionAsString

      public final String formatVersionAsString()

      The user or group rules associated with the dataset that contains permissions for RLS.

      By default, FormatVersion is VERSION_1. When FormatVersion is VERSION_1, UserName and GroupName are required. When FormatVersion is VERSION_2, UserARN and GroupARN are required, and Namespace must not exist.

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

      Returns:
      The user or group rules associated with the dataset that contains permissions for RLS.

      By default, FormatVersion is VERSION_1. When FormatVersion is VERSION_1, UserName and GroupName are required. When FormatVersion is VERSION_2, UserARN and GroupARN are required, and Namespace must not exist.

      See Also:

    • status

      public final Status status()

      The status of the row-level security permission dataset. 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 the row-level security permission dataset. If enabled, the status is ENABLED. If disabled, the status is DISABLED.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the row-level security permission dataset. 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 the row-level security permission dataset. If enabled, the status is ENABLED. If disabled, the status is DISABLED.
      See Also:

    • toBuilder

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

    • builder

      public static RowLevelPermissionDataSet.Builder builder()

    • serializableBuilderClass

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