software.amazon.awssdk.services.quicksight.model.ColumnLevelPermissionRule Maven / Gradle / Ivy
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.quicksight.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* 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.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ColumnLevelPermissionRule implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField> PRINCIPALS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Principals")
.getter(getter(ColumnLevelPermissionRule::principals))
.setter(setter(Builder::principals))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Principals").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> COLUMN_NAMES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("ColumnNames")
.getter(getter(ColumnLevelPermissionRule::columnNames))
.setter(setter(Builder::columnNames))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ColumnNames").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(PRINCIPALS_FIELD,
COLUMN_NAMES_FIELD));
private static final long serialVersionUID = 1L;
private final List principals;
private final List columnNames;
private ColumnLevelPermissionRule(BuilderImpl builder) {
this.principals = builder.principals;
this.columnNames = builder.columnNames;
}
/**
* 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.
*/
public boolean hasPrincipals() {
return principals != null && !(principals instanceof SdkAutoConstructList);
}
/**
*
* 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 {@link #hasPrincipals()} to see if a value was sent in this field.
*
*
* @return An array of Amazon Resource Names (ARNs) for QuickSight users or groups.
*/
public List principals() {
return principals;
}
/**
* 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.
*/
public boolean hasColumnNames() {
return columnNames != null && !(columnNames instanceof SdkAutoConstructList);
}
/**
*
* An array of column names.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasColumnNames()} to see if a value was sent in this field.
*
*
* @return An array of column names.
*/
public List columnNames() {
return columnNames;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(hasPrincipals() ? principals() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasColumnNames() ? columnNames() : null);
return hashCode;
}
@Override
public boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof ColumnLevelPermissionRule)) {
return false;
}
ColumnLevelPermissionRule other = (ColumnLevelPermissionRule) obj;
return hasPrincipals() == other.hasPrincipals() && Objects.equals(principals(), other.principals())
&& hasColumnNames() == other.hasColumnNames() && Objects.equals(columnNames(), other.columnNames());
}
/**
* 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.
*/
@Override
public String toString() {
return ToString.builder("ColumnLevelPermissionRule").add("Principals", hasPrincipals() ? principals() : null)
.add("ColumnNames", hasColumnNames() ? columnNames() : null).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Principals":
return Optional.ofNullable(clazz.cast(principals()));
case "ColumnNames":
return Optional.ofNullable(clazz.cast(columnNames()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ColumnLevelPermissionRule) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* An array of Amazon Resource Names (ARNs) for QuickSight users or groups.
*
*
* @param principals
* An array of Amazon Resource Names (ARNs) for QuickSight users or groups.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder principals(Collection principals);
/**
*
* An array of Amazon Resource Names (ARNs) for QuickSight users or groups.
*
*
* @param principals
* An array of Amazon Resource Names (ARNs) for QuickSight users or groups.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder principals(String... principals);
/**
*
* An array of column names.
*
*
* @param columnNames
* An array of column names.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder columnNames(Collection columnNames);
/**
*
* An array of column names.
*
*
* @param columnNames
* An array of column names.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder columnNames(String... columnNames);
}
static final class BuilderImpl implements Builder {
private List principals = DefaultSdkAutoConstructList.getInstance();
private List columnNames = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(ColumnLevelPermissionRule model) {
principals(model.principals);
columnNames(model.columnNames);
}
public final Collection getPrincipals() {
if (principals instanceof SdkAutoConstructList) {
return null;
}
return principals;
}
@Override
public final Builder principals(Collection principals) {
this.principals = PrincipalListCopier.copy(principals);
return this;
}
@Override
@SafeVarargs
public final Builder principals(String... principals) {
principals(Arrays.asList(principals));
return this;
}
public final void setPrincipals(Collection principals) {
this.principals = PrincipalListCopier.copy(principals);
}
public final Collection getColumnNames() {
if (columnNames instanceof SdkAutoConstructList) {
return null;
}
return columnNames;
}
@Override
public final Builder columnNames(Collection columnNames) {
this.columnNames = ColumnNameListCopier.copy(columnNames);
return this;
}
@Override
@SafeVarargs
public final Builder columnNames(String... columnNames) {
columnNames(Arrays.asList(columnNames));
return this;
}
public final void setColumnNames(Collection columnNames) {
this.columnNames = ColumnNameListCopier.copy(columnNames);
}
@Override
public ColumnLevelPermissionRule build() {
return new ColumnLevelPermissionRule(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy