software.amazon.awssdk.services.quicksight.model.ResourcePermission 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;
/**
*
* Permission for the resource.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ResourcePermission implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField PRINCIPAL_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(ResourcePermission::principal)).setter(setter(Builder::principal))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Principal").build()).build();
private static final SdkField> ACTIONS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.getter(getter(ResourcePermission::actions))
.setter(setter(Builder::actions))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Actions").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(PRINCIPAL_FIELD, ACTIONS_FIELD));
private static final long serialVersionUID = 1L;
private final String principal;
private final List actions;
private ResourcePermission(BuilderImpl builder) {
this.principal = builder.principal;
this.actions = builder.actions;
}
/**
*
* The Amazon Resource Name (ARN) of the principal. This can be one of the following:
*
*
* -
*
* The ARN of an Amazon QuickSight user, group, or namespace. (This is most common.)
*
*
* -
*
* The ARN of an AWS account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share
* resources (templates) across AWS accounts. (This is less common.)
*
*
*
*
* @return The Amazon Resource Name (ARN) of the principal. This can be one of the following:
*
* -
*
* The ARN of an Amazon QuickSight user, group, or namespace. (This is most common.)
*
*
* -
*
* The ARN of an AWS account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to
* share resources (templates) across AWS accounts. (This is less common.)
*
*
*/
public String principal() {
return principal;
}
/**
* Returns true if the Actions 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 hasActions() {
return actions != null && !(actions instanceof SdkAutoConstructList);
}
/**
*
* The IAM action to grant or revoke permissions on, for example "quicksight:DescribeDashboard".
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasActions()} to see if a value was sent in this field.
*
*
* @return The IAM action to grant or revoke permissions on, for example "quicksight:DescribeDashboard"
* .
*/
public List actions() {
return actions;
}
@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(principal());
hashCode = 31 * hashCode + Objects.hashCode(actions());
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 ResourcePermission)) {
return false;
}
ResourcePermission other = (ResourcePermission) obj;
return Objects.equals(principal(), other.principal()) && Objects.equals(actions(), other.actions());
}
/**
* 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("ResourcePermission").add("Principal", principal()).add("Actions", actions()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Principal":
return Optional.ofNullable(clazz.cast(principal()));
case "Actions":
return Optional.ofNullable(clazz.cast(actions()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ResourcePermission) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The Amazon Resource Name (ARN) of the principal. This can be one of the following:
*
*
* -
*
* The ARN of an Amazon QuickSight user, group, or namespace. (This is most common.)
*
*
* -
*
* The ARN of an AWS account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to
* share resources (templates) across AWS accounts. (This is less common.)
*
*
*
*
* @param principal
* The Amazon Resource Name (ARN) of the principal. This can be one of the following:
*
* -
*
* The ARN of an Amazon QuickSight user, group, or namespace. (This is most common.)
*
*
* -
*
* The ARN of an AWS account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only
* to share resources (templates) across AWS accounts. (This is less common.)
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder principal(String principal);
/**
*
* The IAM action to grant or revoke permissions on, for example "quicksight:DescribeDashboard".
*
*
* @param actions
* The IAM action to grant or revoke permissions on, for example
* "quicksight:DescribeDashboard".
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder actions(Collection actions);
/**
*
* The IAM action to grant or revoke permissions on, for example "quicksight:DescribeDashboard".
*
*
* @param actions
* The IAM action to grant or revoke permissions on, for example
* "quicksight:DescribeDashboard".
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder actions(String... actions);
}
static final class BuilderImpl implements Builder {
private String principal;
private List actions = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(ResourcePermission model) {
principal(model.principal);
actions(model.actions);
}
public final String getPrincipal() {
return principal;
}
@Override
public final Builder principal(String principal) {
this.principal = principal;
return this;
}
public final void setPrincipal(String principal) {
this.principal = principal;
}
public final Collection getActions() {
return actions;
}
@Override
public final Builder actions(Collection actions) {
this.actions = ActionListCopier.copy(actions);
return this;
}
@Override
@SafeVarargs
public final Builder actions(String... actions) {
actions(Arrays.asList(actions));
return this;
}
public final void setActions(Collection actions) {
this.actions = ActionListCopier.copy(actions);
}
@Override
public ResourcePermission build() {
return new ResourcePermission(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}