com.amazonaws.services.bedrock.model.GuardrailSensitiveInformationPolicy Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-bedrock Show documentation
The AWS Java SDK for Amazon Bedrock module holds the client classes that are used for communicating with Amazon Bedrock Service
The newest version!
/*
 * Copyright 2019-2024 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.bedrock.model;

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

/**
 * 
 * Contains details about PII entities and regular expressions configured for the guardrail.
 * 
 * 
 * @see AWS API Documentation
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class GuardrailSensitiveInformationPolicy implements Serializable, Cloneable, StructuredPojo {

    /**
     * 
     * The list of PII entities configured for the guardrail.
     * 
     */
    private java.util.List piiEntities;
    /**
     * 
     * The list of regular expressions configured for the guardrail.
     * 
     */
    private java.util.List regexes;

    /**
     * 
     * The list of PII entities configured for the guardrail.
     * 
     * 
     * @return The list of PII entities configured for the guardrail.
     */

    public java.util.List getPiiEntities() {
        return piiEntities;
    }

    /**
     * 
     * The list of PII entities configured for the guardrail.
     * 
     * 
     * @param piiEntities
     *        The list of PII entities configured for the guardrail.
     */

    public void setPiiEntities(java.util.Collection piiEntities) {
        if (piiEntities == null) {
            this.piiEntities = null;
            return;
        }

        this.piiEntities = new java.util.ArrayList(piiEntities);
    }

    /**
     * 
     * The list of PII entities configured for the guardrail.
     * 
     * 
     * NOTE: This method appends the values to the existing list (if any). Use
     * {@link #setPiiEntities(java.util.Collection)} or {@link #withPiiEntities(java.util.Collection)} if you want to
     * override the existing values.
     * 
     * 
     * @param piiEntities
     *        The list of PII entities configured for the guardrail.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public GuardrailSensitiveInformationPolicy withPiiEntities(GuardrailPiiEntity... piiEntities) {
        if (this.piiEntities == null) {
            setPiiEntities(new java.util.ArrayList(piiEntities.length));
        }
        for (GuardrailPiiEntity ele : piiEntities) {
            this.piiEntities.add(ele);
        }
        return this;
    }

    /**
     * 
     * The list of PII entities configured for the guardrail.
     * 
     * 
     * @param piiEntities
     *        The list of PII entities configured for the guardrail.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public GuardrailSensitiveInformationPolicy withPiiEntities(java.util.Collection piiEntities) {
        setPiiEntities(piiEntities);
        return this;
    }

    /**
     * 
     * The list of regular expressions configured for the guardrail.
     * 
     * 
     * @return The list of regular expressions configured for the guardrail.
     */

    public java.util.List getRegexes() {
        return regexes;
    }

    /**
     * 
     * The list of regular expressions configured for the guardrail.
     * 
     * 
     * @param regexes
     *        The list of regular expressions configured for the guardrail.
     */

    public void setRegexes(java.util.Collection regexes) {
        if (regexes == null) {
            this.regexes = null;
            return;
        }

        this.regexes = new java.util.ArrayList(regexes);
    }

    /**
     * 
     * The list of regular expressions configured for the guardrail.
     * 
     * 
     * NOTE: This method appends the values to the existing list (if any). Use
     * {@link #setRegexes(java.util.Collection)} or {@link #withRegexes(java.util.Collection)} if you want to override
     * the existing values.
     * 
     * 
     * @param regexes
     *        The list of regular expressions configured for the guardrail.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public GuardrailSensitiveInformationPolicy withRegexes(GuardrailRegex... regexes) {
        if (this.regexes == null) {
            setRegexes(new java.util.ArrayList(regexes.length));
        }
        for (GuardrailRegex ele : regexes) {
            this.regexes.add(ele);
        }
        return this;
    }

    /**
     * 
     * The list of regular expressions configured for the guardrail.
     * 
     * 
     * @param regexes
     *        The list of regular expressions configured for the guardrail.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public GuardrailSensitiveInformationPolicy withRegexes(java.util.Collection regexes) {
        setRegexes(regexes);
        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 (getPiiEntities() != null)
            sb.append("PiiEntities: ").append(getPiiEntities()).append(",");
        if (getRegexes() != null)
            sb.append("Regexes: ").append(getRegexes());
        sb.append("}");
        return sb.toString();
    }

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

        if (obj instanceof GuardrailSensitiveInformationPolicy == false)
            return false;
        GuardrailSensitiveInformationPolicy other = (GuardrailSensitiveInformationPolicy) obj;
        if (other.getPiiEntities() == null ^ this.getPiiEntities() == null)
            return false;
        if (other.getPiiEntities() != null && other.getPiiEntities().equals(this.getPiiEntities()) == false)
            return false;
        if (other.getRegexes() == null ^ this.getRegexes() == null)
            return false;
        if (other.getRegexes() != null && other.getRegexes().equals(this.getRegexes()) == false)
            return false;
        return true;
    }

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

        hashCode = prime * hashCode + ((getPiiEntities() == null) ? 0 : getPiiEntities().hashCode());
        hashCode = prime * hashCode + ((getRegexes() == null) ? 0 : getRegexes().hashCode());
        return hashCode;
    }

    @Override
    public GuardrailSensitiveInformationPolicy clone() {
        try {
            return (GuardrailSensitiveInformationPolicy) 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.bedrock.model.transform.GuardrailSensitiveInformationPolicyMarshaller.getInstance().marshall(this, protocolMarshaller);
    }
}