com.amazonaws.services.bedrockagentruntime.model.TextResponsePart Maven / Gradle / Ivy

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

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

/**
 * 
 * Contains the part of the generated text that contains a citation, alongside where it begins and ends.
 * 
 * 
 * This data type is used in the following API operations:
 * 
 * 
 * 
 * 
 * RetrieveAndGenerate response – in the textResponsePart field
 * 
 * 
 * 
 * 
 * InvokeAgent response – in the textResponsePart field
 * 
 * 
 * 
 * 
 * @see AWS API Documentation
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class TextResponsePart implements Serializable, Cloneable, StructuredPojo {

    /**
     * 
     * Contains information about where the text with a citation begins and ends in the generated output.
     * 
     */
    private Span span;
    /**
     * 
     * The part of the generated text that contains a citation.
     * 
     */
    private String text;

    /**
     * 
     * Contains information about where the text with a citation begins and ends in the generated output.
     * 
     * 
     * @param span
     *        Contains information about where the text with a citation begins and ends in the generated output.
     */

    public void setSpan(Span span) {
        this.span = span;
    }

    /**
     * 
     * Contains information about where the text with a citation begins and ends in the generated output.
     * 
     * 
     * @return Contains information about where the text with a citation begins and ends in the generated output.
     */

    public Span getSpan() {
        return this.span;
    }

    /**
     * 
     * Contains information about where the text with a citation begins and ends in the generated output.
     * 
     * 
     * @param span
     *        Contains information about where the text with a citation begins and ends in the generated output.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public TextResponsePart withSpan(Span span) {
        setSpan(span);
        return this;
    }

    /**
     * 
     * The part of the generated text that contains a citation.
     * 
     * 
     * @param text
     *        The part of the generated text that contains a citation.
     */

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

    /**
     * 
     * The part of the generated text that contains a citation.
     * 
     * 
     * @return The part of the generated text that contains a citation.
     */

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

    /**
     * 
     * The part of the generated text that contains a citation.
     * 
     * 
     * @param text
     *        The part of the generated text that contains a citation.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public TextResponsePart withText(String text) {
        setText(text);
        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 (getSpan() != null)
            sb.append("Span: ").append(getSpan()).append(",");
        if (getText() != null)
            sb.append("Text: ").append(getText());
        sb.append("}");
        return sb.toString();
    }

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

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

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

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

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