Package 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("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	Description
static interface	ColumnLevelPermissionRule.Builder

Method Summary

Modifier and Type	Method	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()	For responses, this returns true if the service returned a value for the ColumnNames property.
int	hashCode()
boolean	hasPrincipals()	For responses, this returns true if the service returned a value for the Principals property.
List<String>	principals()	An array of Amazon Resource Names (ARNs) for Amazon 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 final boolean hasPrincipals()

For responses, this returns true if the service returned a value for the Principals property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

principals

public final List<String> principals()

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

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPrincipals() method.

Returns:

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

hasColumnNames

public final boolean hasColumnNames()

For responses, this returns true if the service returned a value for the ColumnNames property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

columnNames

public final List<String> columnNames()

An array of column names.

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasColumnNames() method.

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 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