software.amazon.awssdk.services.quicksight.model

Class RowLevelPermissionDataSet

java.lang.Object

software.amazon.awssdk.services.quicksight.model.RowLevelPermissionDataSet

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<RowLevelPermissionDataSet.Builder,RowLevelPermissionDataSet>

@Generated(value="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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RowLevelPermissionDataSet.Builder

Method Summary

Modifier and Type	Method and Description
String	arn() The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.
static RowLevelPermissionDataSet.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
RowLevelPermissionFormatVersion	formatVersion() The user or group rules associated with the dataset that contains permissions for RLS.
String	formatVersionAsString() The user or group rules associated with the dataset that contains permissions for RLS.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	namespace() The namespace associated with the dataset that contains permissions for RLS.
RowLevelPermissionPolicy	permissionPolicy() The type of permissions to use when interpreting the permissions for RLS.
String	permissionPolicyAsString() The type of permissions to use when interpreting the permissions for RLS.
List<SdkField<?>>	sdkFields()
static Class<? extends RowLevelPermissionDataSet.Builder>	serializableBuilderClass()
Status	status() The status of the row-level security permission dataset.
String	statusAsString() The status of the row-level security permission dataset.
RowLevelPermissionDataSet.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

RowLevelPermissionPolicy

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:

RowLevelPermissionPolicy

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:

RowLevelPermissionFormatVersion

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:

RowLevelPermissionFormatVersion

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:

Status

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:

Status

toBuilder

public RowLevelPermissionDataSet.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RowLevelPermissionDataSet.Builder,RowLevelPermissionDataSet>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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