software.amazon.awssdk.services.iam.model.PermissionsBoundaryDecisionDetail Maven / Gradle / Ivy

Go to download
/*
 * 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.iam.model;

import java.io.Serializable;
import java.util.Arrays;
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.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;

/**
 * 
 * Contains information about the effect that a permissions boundary has on a policy simulation when the boundary is
 * applied to an IAM entity.
 * 
 */
@Generated("software.amazon.awssdk:codegen")
public final class PermissionsBoundaryDecisionDetail implements SdkPojo, Serializable,
        ToCopyableBuilder {
    private static final SdkField ALLOWED_BY_PERMISSIONS_BOUNDARY_FIELD = SdkField
            . builder(MarshallingType.BOOLEAN)
            .memberName("AllowedByPermissionsBoundary")
            .getter(getter(PermissionsBoundaryDecisionDetail::allowedByPermissionsBoundary))
            .setter(setter(Builder::allowedByPermissionsBoundary))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AllowedByPermissionsBoundary")
                    .build()).build();

    private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays
            .asList(ALLOWED_BY_PERMISSIONS_BOUNDARY_FIELD));

    private static final long serialVersionUID = 1L;

    private final Boolean allowedByPermissionsBoundary;

    private PermissionsBoundaryDecisionDetail(BuilderImpl builder) {
        this.allowedByPermissionsBoundary = builder.allowedByPermissionsBoundary;
    }

    /**
     * 
     * Specifies whether an action is allowed by a permissions boundary that is applied to an IAM entity (user or role).
     * A value of true means that the permissions boundary does not deny the action. This means that the
     * policy includes an Allow statement that matches the request. In this case, if an identity-based
     * policy also allows the action, the request is allowed. A value of false means that either the
     * requested action is not allowed (implicitly denied) or that the action is explicitly denied by the permissions
     * boundary. In both of these cases, the action is not allowed, regardless of the identity-based policy.
     * 
     * 
     * @return Specifies whether an action is allowed by a permissions boundary that is applied to an IAM entity (user
     *         or role). A value of true means that the permissions boundary does not deny the action. This
     *         means that the policy includes an Allow statement that matches the request. In this case, if
     *         an identity-based policy also allows the action, the request is allowed. A value of false
     *         means that either the requested action is not allowed (implicitly denied) or that the action is
     *         explicitly denied by the permissions boundary. In both of these cases, the action is not allowed,
     *         regardless of the identity-based policy.
     */
    public final Boolean allowedByPermissionsBoundary() {
        return allowedByPermissionsBoundary;
    }

    @Override
    public Builder toBuilder() {
        return new BuilderImpl(this);
    }

    public static Builder builder() {
        return new BuilderImpl();
    }

    public static Class serializableBuilderClass() {
        return BuilderImpl.class;
    }

    @Override
    public final int hashCode() {
        int hashCode = 1;
        hashCode = 31 * hashCode + Objects.hashCode(allowedByPermissionsBoundary());
        return hashCode;
    }

    @Override
    public final boolean equals(Object obj) {
        return equalsBySdkFields(obj);
    }

    @Override
    public final boolean equalsBySdkFields(Object obj) {
        if (this == obj) {
            return true;
        }
        if (obj == null) {
            return false;
        }
        if (!(obj instanceof PermissionsBoundaryDecisionDetail)) {
            return false;
        }
        PermissionsBoundaryDecisionDetail other = (PermissionsBoundaryDecisionDetail) obj;
        return Objects.equals(allowedByPermissionsBoundary(), other.allowedByPermissionsBoundary());
    }

    /**
     * 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 final String toString() {
        return ToString.builder("PermissionsBoundaryDecisionDetail")
                .add("AllowedByPermissionsBoundary", allowedByPermissionsBoundary()).build();
    }

    public final  Optional getValueForField(String fieldName, Class clazz) {
        switch (fieldName) {
        case "AllowedByPermissionsBoundary":
            return Optional.ofNullable(clazz.cast(allowedByPermissionsBoundary()));
        default:
            return Optional.empty();
        }
    }

    @Override
    public final List> sdkFields() {
        return SDK_FIELDS;
    }

    private static  Function getter(Function g) {
        return obj -> g.apply((PermissionsBoundaryDecisionDetail) obj);
    }

    private static  BiConsumer setter(BiConsumer s) {
        return (obj, val) -> s.accept((Builder) obj, val);
    }

    public interface Builder extends SdkPojo, CopyableBuilder {
        /**
         * 
         * Specifies whether an action is allowed by a permissions boundary that is applied to an IAM entity (user or
         * role). A value of true means that the permissions boundary does not deny the action. This means
         * that the policy includes an Allow statement that matches the request. In this case, if an
         * identity-based policy also allows the action, the request is allowed. A value of false means
         * that either the requested action is not allowed (implicitly denied) or that the action is explicitly denied
         * by the permissions boundary. In both of these cases, the action is not allowed, regardless of the
         * identity-based policy.
         * 
         * 
         * @param allowedByPermissionsBoundary
         *        Specifies whether an action is allowed by a permissions boundary that is applied to an IAM entity
         *        (user or role). A value of true means that the permissions boundary does not deny the
         *        action. This means that the policy includes an Allow statement that matches the request.
         *        In this case, if an identity-based policy also allows the action, the request is allowed. A value of
         *        false means that either the requested action is not allowed (implicitly denied) or that
         *        the action is explicitly denied by the permissions boundary. In both of these cases, the action is not
         *        allowed, regardless of the identity-based policy.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder allowedByPermissionsBoundary(Boolean allowedByPermissionsBoundary);
    }

    static final class BuilderImpl implements Builder {
        private Boolean allowedByPermissionsBoundary;

        private BuilderImpl() {
        }

        private BuilderImpl(PermissionsBoundaryDecisionDetail model) {
            allowedByPermissionsBoundary(model.allowedByPermissionsBoundary);
        }

        public final Boolean getAllowedByPermissionsBoundary() {
            return allowedByPermissionsBoundary;
        }

        public final void setAllowedByPermissionsBoundary(Boolean allowedByPermissionsBoundary) {
            this.allowedByPermissionsBoundary = allowedByPermissionsBoundary;
        }

        @Override
        public final Builder allowedByPermissionsBoundary(Boolean allowedByPermissionsBoundary) {
            this.allowedByPermissionsBoundary = allowedByPermissionsBoundary;
            return this;
        }

        @Override
        public PermissionsBoundaryDecisionDetail build() {
            return new PermissionsBoundaryDecisionDetail(this);
        }

        @Override
        public List> sdkFields() {
            return SDK_FIELDS;
        }
    }
}