com.amazonaws.services.bedrockruntime.model.GuardrailTextBlock Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-bedrockruntime Show documentation
The AWS Java SDK for Amazon Bedrock Runtime module holds the client classes that are used for communicating with Amazon Bedrock Runtime Service
There is a newer version: 1.12.780
Show 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.bedrockruntime.model;

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

/**
 * 
 * The text block to be evaluated by the guardrail.
 * 
 * 
 * @see AWS
 *      API Documentation
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class GuardrailTextBlock implements Serializable, Cloneable, StructuredPojo {

    /**
     * 
     * The input text details to be evaluated by the guardrail.
     * 
     */
    private String text;
    /**
     * 
     * The qualifiers describing the text block.
     * 
     */
    private java.util.List qualifiers;

    /**
     * 
     * The input text details to be evaluated by the guardrail.
     * 
     * 
     * @param text
     *        The input text details to be evaluated by the guardrail.
     */

    public void setText(String text) {
        this.text = text;
    }

    /**
     * 
     * The input text details to be evaluated by the guardrail.
     * 
     * 
     * @return The input text details to be evaluated by the guardrail.
     */

    public String getText() {
        return this.text;
    }

    /**
     * 
     * The input text details to be evaluated by the guardrail.
     * 
     * 
     * @param text
     *        The input text details to be evaluated by the guardrail.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public GuardrailTextBlock withText(String text) {
        setText(text);
        return this;
    }

    /**
     * 
     * The qualifiers describing the text block.
     * 
     * 
     * @return The qualifiers describing the text block.
     * @see GuardrailContentQualifier
     */

    public java.util.List getQualifiers() {
        return qualifiers;
    }

    /**
     * 
     * The qualifiers describing the text block.
     * 
     * 
     * @param qualifiers
     *        The qualifiers describing the text block.
     * @see GuardrailContentQualifier
     */

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

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

    /**
     * 
     * The qualifiers describing the text block.
     * 
     * 
     * NOTE: This method appends the values to the existing list (if any). Use
     * {@link #setQualifiers(java.util.Collection)} or {@link #withQualifiers(java.util.Collection)} if you want to
     * override the existing values.
     * 
     * 
     * @param qualifiers
     *        The qualifiers describing the text block.
     * @return Returns a reference to this object so that method calls can be chained together.
     * @see GuardrailContentQualifier
     */

    public GuardrailTextBlock withQualifiers(String... qualifiers) {
        if (this.qualifiers == null) {
            setQualifiers(new java.util.ArrayList(qualifiers.length));
        }
        for (String ele : qualifiers) {
            this.qualifiers.add(ele);
        }
        return this;
    }

    /**
     * 
     * The qualifiers describing the text block.
     * 
     * 
     * @param qualifiers
     *        The qualifiers describing the text block.
     * @return Returns a reference to this object so that method calls can be chained together.
     * @see GuardrailContentQualifier
     */

    public GuardrailTextBlock withQualifiers(java.util.Collection qualifiers) {
        setQualifiers(qualifiers);
        return this;
    }

    /**
     * 
     * The qualifiers describing the text block.
     * 
     * 
     * @param qualifiers
     *        The qualifiers describing the text block.
     * @return Returns a reference to this object so that method calls can be chained together.
     * @see GuardrailContentQualifier
     */

    public GuardrailTextBlock withQualifiers(GuardrailContentQualifier... qualifiers) {
        java.util.ArrayList qualifiersCopy = new java.util.ArrayList(qualifiers.length);
        for (GuardrailContentQualifier value : qualifiers) {
            qualifiersCopy.add(value.toString());
        }
        if (getQualifiers() == null) {
            setQualifiers(qualifiersCopy);
        } else {
            getQualifiers().addAll(qualifiersCopy);
        }
        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 (getText() != null)
            sb.append("Text: ").append(getText()).append(",");
        if (getQualifiers() != null)
            sb.append("Qualifiers: ").append(getQualifiers());
        sb.append("}");
        return sb.toString();
    }

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

        if (obj instanceof GuardrailTextBlock == false)
            return false;
        GuardrailTextBlock other = (GuardrailTextBlock) obj;
        if (other.getText() == null ^ this.getText() == null)
            return false;
        if (other.getText() != null && other.getText().equals(this.getText()) == false)
            return false;
        if (other.getQualifiers() == null ^ this.getQualifiers() == null)
            return false;
        if (other.getQualifiers() != null && other.getQualifiers().equals(this.getQualifiers()) == false)
            return false;
        return true;
    }

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

        hashCode = prime * hashCode + ((getText() == null) ? 0 : getText().hashCode());
        hashCode = prime * hashCode + ((getQualifiers() == null) ? 0 : getQualifiers().hashCode());
        return hashCode;
    }

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