Class RowLevelPermissionDataSet
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
arn()
The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.The user or group rules associated with the dataset that contains permissions for RLS.final String
The user or group rules associated with the dataset that contains permissions for RLS.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
The namespace associated with the dataset that contains permissions for RLS.final RowLevelPermissionPolicy
The type of permissions to use when interpreting the permissions for RLS.final String
The type of permissions to use when interpreting the permissions for RLS.static Class
<? extends RowLevelPermissionDataSet.Builder> final Status
status()
The status of the row-level security permission dataset.final String
The status of the row-level security permission dataset.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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
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 returnRowLevelPermissionPolicy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frompermissionPolicyAsString()
.- Returns:
- The type of permissions to use when interpreting the permissions for RLS.
DENY_ACCESS
is included for backward compatibility only. - See Also:
-
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 returnRowLevelPermissionPolicy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frompermissionPolicyAsString()
.- Returns:
- The type of permissions to use when interpreting the permissions for RLS.
DENY_ACCESS
is included for backward compatibility only. - See Also:
-
formatVersion
The user or group rules associated with the dataset that contains permissions for RLS.
By default,
FormatVersion
isVERSION_1
. WhenFormatVersion
isVERSION_1
,UserName
andGroupName
are required. WhenFormatVersion
isVERSION_2
,UserARN
andGroupARN
are required, andNamespace
must not exist.If the service returns an enum value that is not available in the current SDK version,
formatVersion
will returnRowLevelPermissionFormatVersion.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromformatVersionAsString()
.- Returns:
- The user or group rules associated with the dataset that contains permissions for RLS.
By default,
FormatVersion
isVERSION_1
. WhenFormatVersion
isVERSION_1
,UserName
andGroupName
are required. WhenFormatVersion
isVERSION_2
,UserARN
andGroupARN
are required, andNamespace
must not exist. - See Also:
-
formatVersionAsString
The user or group rules associated with the dataset that contains permissions for RLS.
By default,
FormatVersion
isVERSION_1
. WhenFormatVersion
isVERSION_1
,UserName
andGroupName
are required. WhenFormatVersion
isVERSION_2
,UserARN
andGroupARN
are required, andNamespace
must not exist.If the service returns an enum value that is not available in the current SDK version,
formatVersion
will returnRowLevelPermissionFormatVersion.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromformatVersionAsString()
.- Returns:
- The user or group rules associated with the dataset that contains permissions for RLS.
By default,
FormatVersion
isVERSION_1
. WhenFormatVersion
isVERSION_1
,UserName
andGroupName
are required. WhenFormatVersion
isVERSION_2
,UserARN
andGroupARN
are required, andNamespace
must not exist. - See Also:
-
status
The status of the row-level security permission dataset. If enabled, the status is
ENABLED
. If disabled, the status isDISABLED
.If the service returns an enum value that is not available in the current SDK version,
status
will returnStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the row-level security permission dataset. If enabled, the status is
ENABLED
. If disabled, the status isDISABLED
. - See Also:
-
statusAsString
The status of the row-level security permission dataset. If enabled, the status is
ENABLED
. If disabled, the status isDISABLED
.If the service returns an enum value that is not available in the current SDK version,
status
will returnStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the row-level security permission dataset. If enabled, the status is
ENABLED
. If disabled, the status isDISABLED
. - See Also:
-
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 interfaceToCopyableBuilder<RowLevelPermissionDataSet.Builder,
RowLevelPermissionDataSet> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-