RowLevelPermissionDataSet (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.quicksight.model.RowLevelPermissionDataSet

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@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.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

RowLevelPermissionDataSet()

Constructors
Constructor and Description
`RowLevelPermissionDataSet()`

Method Summary

All Methods Instance Methods Concrete Methods
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.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - RowLevelPermissionDataSet
```
public RowLevelPermissionDataSet()
```
- Method Detail
  - setNamespace
```
public void setNamespace(String namespace)
```
    The namespace associated with the dataset that contains permissions for RLS.
    
    Parameters:
    
    namespace - The namespace associated with the dataset that contains permissions for RLS.
  - getNamespace
```
public String getNamespace()
```
    The namespace associated with the dataset that contains permissions for RLS.
    
    Returns:
    
    The namespace associated with the dataset that contains permissions for RLS.
  - withNamespace
```
public RowLevelPermissionDataSet withNamespace(String namespace)
```
    The namespace associated with the dataset that contains permissions for RLS.
    
    Parameters:
    
    namespace - The namespace associated with the dataset that contains permissions for RLS.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setArn
```
public void setArn(String arn)
```
    The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.
  - getArn
```
public String getArn()
```
    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.
  - withArn
```
public RowLevelPermissionDataSet withArn(String arn)
```
    The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPermissionPolicy
```
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.
    
    Parameters:
    
    permissionPolicy - The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS is included for backward compatibility only.
    
    See Also:
    
    RowLevelPermissionPolicy
  - getPermissionPolicy
```
public String getPermissionPolicy()
```
    The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS is included for backward compatibility only.
    
    Returns:
    
    The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS is included for backward compatibility only.
    
    See Also:
    
    RowLevelPermissionPolicy
  - withPermissionPolicy
```
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.
    
    Parameters:
    
    permissionPolicy - The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS is included for backward compatibility only.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    RowLevelPermissionPolicy
  - withPermissionPolicy
```
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.
    
    Parameters:
    
    permissionPolicy - The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS is included for backward compatibility only.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    RowLevelPermissionPolicy
  - setFormatVersion
```
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.
    
    Parameters:
    
    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.
    
    See Also:
    
    RowLevelPermissionFormatVersion
  - getFormatVersion
```
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.
    
    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
  - withFormatVersion
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    RowLevelPermissionFormatVersion
  - withFormatVersion
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    RowLevelPermissionFormatVersion
  - setStatus
```
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.
    
    Parameters:
    
    status - The status of the row-level security permission dataset. If enabled, the status is ENABLED. If disabled, the status is DISABLED.
    
    See Also:
    
    Status
  - getStatus
```
public String getStatus()
```
    The status of the row-level security permission dataset. If enabled, the status is ENABLED. If disabled, the status is DISABLED.
    
    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
  - withStatus
```
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.
    
    Parameters:
    
    status - The status of the row-level security permission dataset. If enabled, the status is ENABLED. If disabled, the status is DISABLED.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Status
  - withStatus
```
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.
    
    Parameters:
    
    status - The status of the row-level security permission dataset. If enabled, the status is ENABLED. If disabled, the status is DISABLED.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Status
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public RowLevelPermissionDataSet clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.792

Class RowLevelPermissionDataSet

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RowLevelPermissionDataSet

Method Detail

setNamespace

getNamespace

withNamespace

setArn

getArn

withArn

setPermissionPolicy

getPermissionPolicy

withPermissionPolicy

withPermissionPolicy

setFormatVersion

getFormatVersion

withFormatVersion

withFormatVersion

setStatus

getStatus

withStatus

withStatus

toString

equals

hashCode

clone

marshall