/*
 * Copyright 2018-2023 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.quicksight.model;

import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;

/**
 * <p>
 * Information about a dataset that contains permissions for row-level security (RLS). The permissions dataset maps
 * fields to users or groups. For more information, see <a href=
 * "https://docs.aws.amazon.com/quicksight/latest/user/restrict-access-to-a-data-set-using-row-level-security.html"
 * >Using Row-Level Security (RLS) to Restrict Access to a Dataset</a> in the <i>Amazon QuickSight User Guide</i>.
 * </p>
 * <p>
 * The option to deny permissions by setting <code>PermissionPolicy</code> to <code>DENY_ACCESS</code> is not supported
 * for new RLS datasets.
 * </p>
 * 
 * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RowLevelPermissionDataSet"
 *      target="_top">AWS API Documentation</a>
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class RowLevelPermissionDataSet implements Serializable, Cloneable, StructuredPojo {

    /**
     * <p>
     * The namespace associated with the dataset that contains permissions for RLS.
     * </p>
     */
    private String namespace;
    /**
     * <p>
     * The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.
     * </p>
     */
    private String arn;
    /**
     * <p>
     * The type of permissions to use when interpreting the permissions for RLS. <code>DENY_ACCESS</code> is included
     * for backward compatibility only.
     * </p>
     */
    private String permissionPolicy;
    /**
     * <p>
     * The user or group rules associated with the dataset that contains permissions for RLS.
     * </p>
     * <p>
     * By default, <code>FormatVersion</code> is <code>VERSION_1</code>. When <code>FormatVersion</code> is
     * <code>VERSION_1</code>, <code>UserName</code> and <code>GroupName</code> are required. When
     * <code>FormatVersion</code> is <code>VERSION_2</code>, <code>UserARN</code> and <code>GroupARN</code> are
     * required, and <code>Namespace</code> must not exist.
     * </p>
     */
    private String formatVersion;
    /**
     * <p>
     * The status of the row-level security permission dataset. If enabled, the status is <code>ENABLED</code>. If
     * disabled, the status is <code>DISABLED</code>.
     * </p>
     */
    private String status;

    /**
     * <p>
     * The namespace associated with the dataset that contains permissions for RLS.
     * </p>
     * 
     * @param namespace
     *        The namespace associated with the dataset that contains permissions for RLS.
     */

    public void setNamespace(String namespace) {
        this.namespace = namespace;
    }

    /**
     * <p>
     * The namespace associated with the dataset that contains permissions for RLS.
     * </p>
     * 
     * @return The namespace associated with the dataset that contains permissions for RLS.
     */

    public String getNamespace() {
        return this.namespace;
    }

    /**
     * <p>
     * The namespace associated with the dataset that contains permissions for RLS.
     * </p>
     * 
     * @param namespace
     *        The namespace associated with the dataset that contains permissions for RLS.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public RowLevelPermissionDataSet withNamespace(String namespace) {
        setNamespace(namespace);
        return this;
    }

    /**
     * <p>
     * The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.
     * </p>
     * 
     * @param arn
     *        The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.
     */

    public void setArn(String arn) {
        this.arn = arn;
    }

    /**
     * <p>
     * The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.
     * </p>
     * 
     * @return The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.
     */

    public String getArn() {
        return this.arn;
    }

    /**
     * <p>
     * The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.
     * </p>
     * 
     * @param arn
     *        The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public RowLevelPermissionDataSet withArn(String arn) {
        setArn(arn);
        return this;
    }

    /**
     * <p>
     * The type of permissions to use when interpreting the permissions for RLS. <code>DENY_ACCESS</code> is included
     * for backward compatibility only.
     * </p>
     * 
     * @param permissionPolicy
     *        The type of permissions to use when interpreting the permissions for RLS. <code>DENY_ACCESS</code> is
     *        included for backward compatibility only.
     * @see RowLevelPermissionPolicy
     */

    public void setPermissionPolicy(String permissionPolicy) {
        this.permissionPolicy = permissionPolicy;
    }

    /**
     * <p>
     * The type of permissions to use when interpreting the permissions for RLS. <code>DENY_ACCESS</code> is included
     * for backward compatibility only.
     * </p>
     * 
     * @return The type of permissions to use when interpreting the permissions for RLS. <code>DENY_ACCESS</code> is
     *         included for backward compatibility only.
     * @see RowLevelPermissionPolicy
     */

    public String getPermissionPolicy() {
        return this.permissionPolicy;
    }

    /**
     * <p>
     * The type of permissions to use when interpreting the permissions for RLS. <code>DENY_ACCESS</code> is included
     * for backward compatibility only.
     * </p>
     * 
     * @param permissionPolicy
     *        The type of permissions to use when interpreting the permissions for RLS. <code>DENY_ACCESS</code> is
     *        included for backward compatibility only.
     * @return Returns a reference to this object so that method calls can be chained together.
     * @see RowLevelPermissionPolicy
     */

    public RowLevelPermissionDataSet withPermissionPolicy(String permissionPolicy) {
        setPermissionPolicy(permissionPolicy);
        return this;
    }

    /**
     * <p>
     * The type of permissions to use when interpreting the permissions for RLS. <code>DENY_ACCESS</code> is included
     * for backward compatibility only.
     * </p>
     * 
     * @param permissionPolicy
     *        The type of permissions to use when interpreting the permissions for RLS. <code>DENY_ACCESS</code> is
     *        included for backward compatibility only.
     * @return Returns a reference to this object so that method calls can be chained together.
     * @see RowLevelPermissionPolicy
     */

    public RowLevelPermissionDataSet withPermissionPolicy(RowLevelPermissionPolicy permissionPolicy) {
        this.permissionPolicy = permissionPolicy.toString();
        return this;
    }

    /**
     * <p>
     * The user or group rules associated with the dataset that contains permissions for RLS.
     * </p>
     * <p>
     * By default, <code>FormatVersion</code> is <code>VERSION_1</code>. When <code>FormatVersion</code> is
     * <code>VERSION_1</code>, <code>UserName</code> and <code>GroupName</code> are required. When
     * <code>FormatVersion</code> is <code>VERSION_2</code>, <code>UserARN</code> and <code>GroupARN</code> are
     * required, and <code>Namespace</code> must not exist.
     * </p>
     * 
     * @param formatVersion
     *        The user or group rules associated with the dataset that contains permissions for RLS.</p>
     *        <p>
     *        By default, <code>FormatVersion</code> is <code>VERSION_1</code>. When <code>FormatVersion</code> is
     *        <code>VERSION_1</code>, <code>UserName</code> and <code>GroupName</code> are required. When
     *        <code>FormatVersion</code> is <code>VERSION_2</code>, <code>UserARN</code> and <code>GroupARN</code> are
     *        required, and <code>Namespace</code> must not exist.
     * @see RowLevelPermissionFormatVersion
     */

    public void setFormatVersion(String formatVersion) {
        this.formatVersion = formatVersion;
    }

    /**
     * <p>
     * The user or group rules associated with the dataset that contains permissions for RLS.
     * </p>
     * <p>
     * By default, <code>FormatVersion</code> is <code>VERSION_1</code>. When <code>FormatVersion</code> is
     * <code>VERSION_1</code>, <code>UserName</code> and <code>GroupName</code> are required. When
     * <code>FormatVersion</code> is <code>VERSION_2</code>, <code>UserARN</code> and <code>GroupARN</code> are
     * required, and <code>Namespace</code> must not exist.
     * </p>
     * 
     * @return The user or group rules associated with the dataset that contains permissions for RLS.</p>
     *         <p>
     *         By default, <code>FormatVersion</code> is <code>VERSION_1</code>. When <code>FormatVersion</code> is
     *         <code>VERSION_1</code>, <code>UserName</code> and <code>GroupName</code> are required. When
     *         <code>FormatVersion</code> is <code>VERSION_2</code>, <code>UserARN</code> and <code>GroupARN</code> are
     *         required, and <code>Namespace</code> must not exist.
     * @see RowLevelPermissionFormatVersion
     */

    public String getFormatVersion() {
        return this.formatVersion;
    }

    /**
     * <p>
     * The user or group rules associated with the dataset that contains permissions for RLS.
     * </p>
     * <p>
     * By default, <code>FormatVersion</code> is <code>VERSION_1</code>. When <code>FormatVersion</code> is
     * <code>VERSION_1</code>, <code>UserName</code> and <code>GroupName</code> are required. When
     * <code>FormatVersion</code> is <code>VERSION_2</code>, <code>UserARN</code> and <code>GroupARN</code> are
     * required, and <code>Namespace</code> must not exist.
     * </p>
     * 
     * @param formatVersion
     *        The user or group rules associated with the dataset that contains permissions for RLS.</p>
     *        <p>
     *        By default, <code>FormatVersion</code> is <code>VERSION_1</code>. When <code>FormatVersion</code> is
     *        <code>VERSION_1</code>, <code>UserName</code> and <code>GroupName</code> are required. When
     *        <code>FormatVersion</code> is <code>VERSION_2</code>, <code>UserARN</code> and <code>GroupARN</code> are
     *        required, and <code>Namespace</code> must not exist.
     * @return Returns a reference to this object so that method calls can be chained together.
     * @see RowLevelPermissionFormatVersion
     */

    public RowLevelPermissionDataSet withFormatVersion(String formatVersion) {
        setFormatVersion(formatVersion);
        return this;
    }

    /**
     * <p>
     * The user or group rules associated with the dataset that contains permissions for RLS.
     * </p>
     * <p>
     * By default, <code>FormatVersion</code> is <code>VERSION_1</code>. When <code>FormatVersion</code> is
     * <code>VERSION_1</code>, <code>UserName</code> and <code>GroupName</code> are required. When
     * <code>FormatVersion</code> is <code>VERSION_2</code>, <code>UserARN</code> and <code>GroupARN</code> are
     * required, and <code>Namespace</code> must not exist.
     * </p>
     * 
     * @param formatVersion
     *        The user or group rules associated with the dataset that contains permissions for RLS.</p>
     *        <p>
     *        By default, <code>FormatVersion</code> is <code>VERSION_1</code>. When <code>FormatVersion</code> is
     *        <code>VERSION_1</code>, <code>UserName</code> and <code>GroupName</code> are required. When
     *        <code>FormatVersion</code> is <code>VERSION_2</code>, <code>UserARN</code> and <code>GroupARN</code> are
     *        required, and <code>Namespace</code> must not exist.
     * @return Returns a reference to this object so that method calls can be chained together.
     * @see RowLevelPermissionFormatVersion
     */

    public RowLevelPermissionDataSet withFormatVersion(RowLevelPermissionFormatVersion formatVersion) {
        this.formatVersion = formatVersion.toString();
        return this;
    }

    /**
     * <p>
     * The status of the row-level security permission dataset. If enabled, the status is <code>ENABLED</code>. If
     * disabled, the status is <code>DISABLED</code>.
     * </p>
     * 
     * @param status
     *        The status of the row-level security permission dataset. If enabled, the status is <code>ENABLED</code>.
     *        If disabled, the status is <code>DISABLED</code>.
     * @see Status
     */

    public void setStatus(String status) {
        this.status = status;
    }

    /**
     * <p>
     * The status of the row-level security permission dataset. If enabled, the status is <code>ENABLED</code>. If
     * disabled, the status is <code>DISABLED</code>.
     * </p>
     * 
     * @return The status of the row-level security permission dataset. If enabled, the status is <code>ENABLED</code>.
     *         If disabled, the status is <code>DISABLED</code>.
     * @see Status
     */

    public String getStatus() {
        return this.status;
    }

    /**
     * <p>
     * The status of the row-level security permission dataset. If enabled, the status is <code>ENABLED</code>. If
     * disabled, the status is <code>DISABLED</code>.
     * </p>
     * 
     * @param status
     *        The status of the row-level security permission dataset. If enabled, the status is <code>ENABLED</code>.
     *        If disabled, the status is <code>DISABLED</code>.
     * @return Returns a reference to this object so that method calls can be chained together.
     * @see Status
     */

    public RowLevelPermissionDataSet withStatus(String status) {
        setStatus(status);
        return this;
    }

    /**
     * <p>
     * The status of the row-level security permission dataset. If enabled, the status is <code>ENABLED</code>. If
     * disabled, the status is <code>DISABLED</code>.
     * </p>
     * 
     * @param status
     *        The status of the row-level security permission dataset. If enabled, the status is <code>ENABLED</code>.
     *        If disabled, the status is <code>DISABLED</code>.
     * @return Returns a reference to this object so that method calls can be chained together.
     * @see Status
     */

    public RowLevelPermissionDataSet withStatus(Status status) {
        this.status = status.toString();
        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 (getNamespace() != null)
            sb.append("Namespace: ").append(getNamespace()).append(",");
        if (getArn() != null)
            sb.append("Arn: ").append(getArn()).append(",");
        if (getPermissionPolicy() != null)
            sb.append("PermissionPolicy: ").append(getPermissionPolicy()).append(",");
        if (getFormatVersion() != null)
            sb.append("FormatVersion: ").append(getFormatVersion()).append(",");
        if (getStatus() != null)
            sb.append("Status: ").append(getStatus());
        sb.append("}");
        return sb.toString();
    }

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

        if (obj instanceof RowLevelPermissionDataSet == false)
            return false;
        RowLevelPermissionDataSet other = (RowLevelPermissionDataSet) obj;
        if (other.getNamespace() == null ^ this.getNamespace() == null)
            return false;
        if (other.getNamespace() != null && other.getNamespace().equals(this.getNamespace()) == false)
            return false;
        if (other.getArn() == null ^ this.getArn() == null)
            return false;
        if (other.getArn() != null && other.getArn().equals(this.getArn()) == false)
            return false;
        if (other.getPermissionPolicy() == null ^ this.getPermissionPolicy() == null)
            return false;
        if (other.getPermissionPolicy() != null && other.getPermissionPolicy().equals(this.getPermissionPolicy()) == false)
            return false;
        if (other.getFormatVersion() == null ^ this.getFormatVersion() == null)
            return false;
        if (other.getFormatVersion() != null && other.getFormatVersion().equals(this.getFormatVersion()) == false)
            return false;
        if (other.getStatus() == null ^ this.getStatus() == null)
            return false;
        if (other.getStatus() != null && other.getStatus().equals(this.getStatus()) == false)
            return false;
        return true;
    }

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

        hashCode = prime * hashCode + ((getNamespace() == null) ? 0 : getNamespace().hashCode());
        hashCode = prime * hashCode + ((getArn() == null) ? 0 : getArn().hashCode());
        hashCode = prime * hashCode + ((getPermissionPolicy() == null) ? 0 : getPermissionPolicy().hashCode());
        hashCode = prime * hashCode + ((getFormatVersion() == null) ? 0 : getFormatVersion().hashCode());
        hashCode = prime * hashCode + ((getStatus() == null) ? 0 : getStatus().hashCode());
        return hashCode;
    }

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

    @com.amazonaws.annotation.SdkInternalApi
    @Override
    public void marshall(ProtocolMarshaller protocolMarshaller) {
        com.amazonaws.services.quicksight.model.transform.RowLevelPermissionDataSetMarshaller.getInstance().marshall(this, protocolMarshaller);
    }
}