com.amazonaws.services.identitymanagement.model.Statement Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-iam Show documentation
The AWS Java SDK for AWS IAM module holds the client classes that are used for communicating with AWS Identity and Access Management Service
The newest version!
/*
 * Copyright 2020-2025 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 com.amazonaws.services.identitymanagement.model;

import java.io.Serializable;
import javax.annotation.Generated;

/**
 * 
 * Contains a reference to a Statement element in a policy document that determines the result of the
 * simulation.
 * 
 * 
 * This data type is used by the MatchedStatements member of the  EvaluationResult 
 * type.
 * 
 * 
 * @see AWS API
 *      Documentation
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class Statement implements Serializable, Cloneable {

    /**
     * 
     * The identifier of the policy that was provided as an input.
     * 
     */
    private String sourcePolicyId;
    /**
     * 
     * The type of the policy.
     * 
     */
    private String sourcePolicyType;
    /**
     * 
     * The row and column of the beginning of the Statement in an IAM policy.
     * 
     */
    private Position startPosition;
    /**
     * 
     * The row and column of the end of a Statement in an IAM policy.
     * 
     */
    private Position endPosition;

    /**
     * 
     * The identifier of the policy that was provided as an input.
     * 
     * 
     * @param sourcePolicyId
     *        The identifier of the policy that was provided as an input.
     */

    public void setSourcePolicyId(String sourcePolicyId) {
        this.sourcePolicyId = sourcePolicyId;
    }

    /**
     * 
     * The identifier of the policy that was provided as an input.
     * 
     * 
     * @return The identifier of the policy that was provided as an input.
     */

    public String getSourcePolicyId() {
        return this.sourcePolicyId;
    }

    /**
     * 
     * The identifier of the policy that was provided as an input.
     * 
     * 
     * @param sourcePolicyId
     *        The identifier of the policy that was provided as an input.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public Statement withSourcePolicyId(String sourcePolicyId) {
        setSourcePolicyId(sourcePolicyId);
        return this;
    }

    /**
     * 
     * The type of the policy.
     * 
     * 
     * @param sourcePolicyType
     *        The type of the policy.
     * @see PolicySourceType
     */

    public void setSourcePolicyType(String sourcePolicyType) {
        this.sourcePolicyType = sourcePolicyType;
    }

    /**
     * 
     * The type of the policy.
     * 
     * 
     * @return The type of the policy.
     * @see PolicySourceType
     */

    public String getSourcePolicyType() {
        return this.sourcePolicyType;
    }

    /**
     * 
     * The type of the policy.
     * 
     * 
     * @param sourcePolicyType
     *        The type of the policy.
     * @return Returns a reference to this object so that method calls can be chained together.
     * @see PolicySourceType
     */

    public Statement withSourcePolicyType(String sourcePolicyType) {
        setSourcePolicyType(sourcePolicyType);
        return this;
    }

    /**
     * 
     * The type of the policy.
     * 
     * 
     * @param sourcePolicyType
     *        The type of the policy.
     * @see PolicySourceType
     */

    public void setSourcePolicyType(PolicySourceType sourcePolicyType) {
        withSourcePolicyType(sourcePolicyType);
    }

    /**
     * 
     * The type of the policy.
     * 
     * 
     * @param sourcePolicyType
     *        The type of the policy.
     * @return Returns a reference to this object so that method calls can be chained together.
     * @see PolicySourceType
     */

    public Statement withSourcePolicyType(PolicySourceType sourcePolicyType) {
        this.sourcePolicyType = sourcePolicyType.toString();
        return this;
    }

    /**
     * 
     * The row and column of the beginning of the Statement in an IAM policy.
     * 
     * 
     * @param startPosition
     *        The row and column of the beginning of the Statement in an IAM policy.
     */

    public void setStartPosition(Position startPosition) {
        this.startPosition = startPosition;
    }

    /**
     * 
     * The row and column of the beginning of the Statement in an IAM policy.
     * 
     * 
     * @return The row and column of the beginning of the Statement in an IAM policy.
     */

    public Position getStartPosition() {
        return this.startPosition;
    }

    /**
     * 
     * The row and column of the beginning of the Statement in an IAM policy.
     * 
     * 
     * @param startPosition
     *        The row and column of the beginning of the Statement in an IAM policy.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public Statement withStartPosition(Position startPosition) {
        setStartPosition(startPosition);
        return this;
    }

    /**
     * 
     * The row and column of the end of a Statement in an IAM policy.
     * 
     * 
     * @param endPosition
     *        The row and column of the end of a Statement in an IAM policy.
     */

    public void setEndPosition(Position endPosition) {
        this.endPosition = endPosition;
    }

    /**
     * 
     * The row and column of the end of a Statement in an IAM policy.
     * 
     * 
     * @return The row and column of the end of a Statement in an IAM policy.
     */

    public Position getEndPosition() {
        return this.endPosition;
    }

    /**
     * 
     * The row and column of the end of a Statement in an IAM policy.
     * 
     * 
     * @param endPosition
     *        The row and column of the end of a Statement in an IAM policy.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public Statement withEndPosition(Position endPosition) {
        setEndPosition(endPosition);
        return this;
    }

    /**
     * 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.
     *
     * @return A string representation of this object.
     *
     * @see java.lang.Object#toString()
     */
    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("{");
        if (getSourcePolicyId() != null)
            sb.append("SourcePolicyId: ").append(getSourcePolicyId()).append(",");
        if (getSourcePolicyType() != null)
            sb.append("SourcePolicyType: ").append(getSourcePolicyType()).append(",");
        if (getStartPosition() != null)
            sb.append("StartPosition: ").append(getStartPosition()).append(",");
        if (getEndPosition() != null)
            sb.append("EndPosition: ").append(getEndPosition());
        sb.append("}");
        return sb.toString();
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;

        if (obj instanceof Statement == false)
            return false;
        Statement other = (Statement) obj;
        if (other.getSourcePolicyId() == null ^ this.getSourcePolicyId() == null)
            return false;
        if (other.getSourcePolicyId() != null && other.getSourcePolicyId().equals(this.getSourcePolicyId()) == false)
            return false;
        if (other.getSourcePolicyType() == null ^ this.getSourcePolicyType() == null)
            return false;
        if (other.getSourcePolicyType() != null && other.getSourcePolicyType().equals(this.getSourcePolicyType()) == false)
            return false;
        if (other.getStartPosition() == null ^ this.getStartPosition() == null)
            return false;
        if (other.getStartPosition() != null && other.getStartPosition().equals(this.getStartPosition()) == false)
            return false;
        if (other.getEndPosition() == null ^ this.getEndPosition() == null)
            return false;
        if (other.getEndPosition() != null && other.getEndPosition().equals(this.getEndPosition()) == false)
            return false;
        return true;
    }

    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;

        hashCode = prime * hashCode + ((getSourcePolicyId() == null) ? 0 : getSourcePolicyId().hashCode());
        hashCode = prime * hashCode + ((getSourcePolicyType() == null) ? 0 : getSourcePolicyType().hashCode());
        hashCode = prime * hashCode + ((getStartPosition() == null) ? 0 : getStartPosition().hashCode());
        hashCode = prime * hashCode + ((getEndPosition() == null) ? 0 : getEndPosition().hashCode());
        return hashCode;
    }

    @Override
    public Statement clone() {
        try {
            return (Statement) super.clone();
        } catch (CloneNotSupportedException e) {
            throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
        }
    }

}