@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class RowLevelPermissionDataSet extends Object implements Serializable, Cloneable, StructuredPojo
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.
Constructor and Description |
---|
RowLevelPermissionDataSet() |
Modifier and Type | Method and Description |
---|---|
RowLevelPermissionDataSet |
clone() |
boolean |
equals(Object obj) |
String |
getArn()
The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.
|
String |
getFormatVersion()
The user or group rules associated with the dataset that contains permissions for RLS.
|
String |
getNamespace()
The namespace associated with the dataset that contains permissions for RLS.
|
String |
getPermissionPolicy()
The type of permissions to use when interpreting the permissions for RLS.
|
String |
getStatus()
The status of the row-level security permission dataset.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setArn(String arn)
The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.
|
void |
setFormatVersion(String formatVersion)
The user or group rules associated with the dataset that contains permissions for RLS.
|
void |
setNamespace(String namespace)
The namespace associated with the dataset that contains permissions for RLS.
|
void |
setPermissionPolicy(String permissionPolicy)
The type of permissions to use when interpreting the permissions for RLS.
|
void |
setStatus(String status)
The status of the row-level security permission dataset.
|
String |
toString()
Returns a string representation of this object.
|
RowLevelPermissionDataSet |
withArn(String arn)
The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.
|
RowLevelPermissionDataSet |
withFormatVersion(RowLevelPermissionFormatVersion formatVersion)
The user or group rules associated with the dataset that contains permissions for RLS.
|
RowLevelPermissionDataSet |
withFormatVersion(String formatVersion)
The user or group rules associated with the dataset that contains permissions for RLS.
|
RowLevelPermissionDataSet |
withNamespace(String namespace)
The namespace associated with the dataset that contains permissions for RLS.
|
RowLevelPermissionDataSet |
withPermissionPolicy(RowLevelPermissionPolicy permissionPolicy)
The type of permissions to use when interpreting the permissions for RLS.
|
RowLevelPermissionDataSet |
withPermissionPolicy(String permissionPolicy)
The type of permissions to use when interpreting the permissions for RLS.
|
RowLevelPermissionDataSet |
withStatus(Status status)
The status of the row-level security permission dataset.
|
RowLevelPermissionDataSet |
withStatus(String status)
The status of the row-level security permission dataset.
|
public void setNamespace(String namespace)
The namespace associated with the dataset that contains permissions for RLS.
namespace
- The namespace associated with the dataset that contains permissions for RLS.public String getNamespace()
The namespace associated with the dataset that contains permissions for RLS.
public RowLevelPermissionDataSet withNamespace(String namespace)
The namespace associated with the dataset that contains permissions for RLS.
namespace
- The namespace associated with the dataset that contains permissions for RLS.public void setArn(String arn)
The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.
arn
- The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.public String getArn()
The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.
public RowLevelPermissionDataSet withArn(String arn)
The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.
arn
- The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.public void setPermissionPolicy(String permissionPolicy)
The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS
is included
for backward compatibility only.
permissionPolicy
- The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS
is
included for backward compatibility only.RowLevelPermissionPolicy
public String getPermissionPolicy()
The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS
is included
for backward compatibility only.
DENY_ACCESS
is
included for backward compatibility only.RowLevelPermissionPolicy
public RowLevelPermissionDataSet withPermissionPolicy(String permissionPolicy)
The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS
is included
for backward compatibility only.
permissionPolicy
- The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS
is
included for backward compatibility only.RowLevelPermissionPolicy
public RowLevelPermissionDataSet withPermissionPolicy(RowLevelPermissionPolicy permissionPolicy)
The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS
is included
for backward compatibility only.
permissionPolicy
- The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS
is
included for backward compatibility only.RowLevelPermissionPolicy
public void setFormatVersion(String 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.
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.
RowLevelPermissionFormatVersion
public String getFormatVersion()
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.
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.
RowLevelPermissionFormatVersion
public RowLevelPermissionDataSet withFormatVersion(String 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.
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.
RowLevelPermissionFormatVersion
public RowLevelPermissionDataSet withFormatVersion(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.
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.
RowLevelPermissionFormatVersion
public void setStatus(String status)
The status of the row-level security permission dataset. If enabled, the status is ENABLED
. If
disabled, the status is DISABLED
.
status
- The status of the row-level security permission dataset. If enabled, the status is ENABLED
.
If disabled, the status is DISABLED
.Status
public String getStatus()
The status of the row-level security permission dataset. If enabled, the status is ENABLED
. If
disabled, the status is DISABLED
.
ENABLED
.
If disabled, the status is DISABLED
.Status
public RowLevelPermissionDataSet withStatus(String status)
The status of the row-level security permission dataset. If enabled, the status is ENABLED
. If
disabled, the status is DISABLED
.
status
- The status of the row-level security permission dataset. If enabled, the status is ENABLED
.
If disabled, the status is DISABLED
.Status
public RowLevelPermissionDataSet withStatus(Status status)
The status of the row-level security permission dataset. If enabled, the status is ENABLED
. If
disabled, the status is DISABLED
.
status
- The status of the row-level security permission dataset. If enabled, the status is ENABLED
.
If disabled, the status is DISABLED
.Status
public String toString()
toString
in class Object
Object.toString()
public RowLevelPermissionDataSet clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.