software.amazon.awssdk.services.quicksight.model

Class ColumnLevelPermissionRule

java.lang.Object

software.amazon.awssdk.services.quicksight.model.ColumnLevelPermissionRule

All Implemented Interfaces:

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

@Generated(value="software.amazon.awssdk:codegen")
public final class ColumnLevelPermissionRule
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ColumnLevelPermissionRule.Builder,ColumnLevelPermissionRule>

A rule defined to grant access on one or more restricted columns. Each dataset can have multiple rules. To create a restricted column, you add it to one or more rules. Each rule must contain at least one column and at least one user or group. To be able to see a restricted column, a user or group needs to be added to a rule for that column.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ColumnLevelPermissionRule.Builder

Method Summary

Modifier and Type	Method and Description
static ColumnLevelPermissionRule.Builder	builder()
List<String>	columnNames() An array of column names.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasColumnNames() Returns true if the ColumnNames property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
boolean	hasPrincipals() Returns true if the Principals property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
List<String>	principals() An array of Amazon Resource Names (ARNs) for QuickSight users or groups.
List<SdkField<?>>	sdkFields()
static Class<? extends ColumnLevelPermissionRule.Builder>	serializableBuilderClass()
ColumnLevelPermissionRule.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

hasPrincipals

public boolean hasPrincipals()

Returns true if the Principals property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

principals

public List<String> principals()

An array of Amazon Resource Names (ARNs) for QuickSight users or groups.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasPrincipals() to see if a value was sent in this field.

Returns:

An array of Amazon Resource Names (ARNs) for QuickSight users or groups.

hasColumnNames

public boolean hasColumnNames()

Returns true if the ColumnNames property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

columnNames

public List<String> columnNames()

An array of column names.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasColumnNames() to see if a value was sent in this field.

Returns:

An array of column names.

toBuilder

public ColumnLevelPermissionRule.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ColumnLevelPermissionRule.Builder,ColumnLevelPermissionRule>

builder

public static ColumnLevelPermissionRule.Builder builder()

serializableBuilderClass

public static Class<? extends ColumnLevelPermissionRule.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo