com.amazonaws.services.qapps.model.QQueryCardInput Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-qapps Show documentation
The AWS Java SDK for QApps module holds the client classes that are used for communicating with QApps 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.qapps.model;

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

/**
 * 
 * The input shape for defining a query card in an Amazon Q App.
 * 
 * 
 * @see AWS API
 *      Documentation
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class QQueryCardInput implements Serializable, Cloneable, StructuredPojo {

    /**
     * 
     * The title or label of the query card.
     * 
     */
    private String title;
    /**
     * 
     * The unique identifier of the query card.
     * 
     */
    private String id;
    /**
     * 
     * The type of the card.
     * 
     */
    private String type;
    /**
     * 
     * The prompt or instructions displayed for the query card.
     * 
     */
    private String prompt;
    /**
     * 
     * The source or type of output to generate for the query card.
     * 
     */
    private String outputSource;
    /**
     * 
     * Turns on filtering of responses based on document attributes or metadata fields.
     * 
     */
    private AttributeFilter attributeFilter;

    /**
     * 
     * The title or label of the query card.
     * 
     * 
     * @param title
     *        The title or label of the query card.
     */

    public void setTitle(String title) {
        this.title = title;
    }

    /**
     * 
     * The title or label of the query card.
     * 
     * 
     * @return The title or label of the query card.
     */

    public String getTitle() {
        return this.title;
    }

    /**
     * 
     * The title or label of the query card.
     * 
     * 
     * @param title
     *        The title or label of the query card.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public QQueryCardInput withTitle(String title) {
        setTitle(title);
        return this;
    }

    /**
     * 
     * The unique identifier of the query card.
     * 
     * 
     * @param id
     *        The unique identifier of the query card.
     */

    public void setId(String id) {
        this.id = id;
    }

    /**
     * 
     * The unique identifier of the query card.
     * 
     * 
     * @return The unique identifier of the query card.
     */

    public String getId() {
        return this.id;
    }

    /**
     * 
     * The unique identifier of the query card.
     * 
     * 
     * @param id
     *        The unique identifier of the query card.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public QQueryCardInput withId(String id) {
        setId(id);
        return this;
    }

    /**
     * 
     * The type of the card.
     * 
     * 
     * @param type
     *        The type of the card.
     * @see CardType
     */

    public void setType(String type) {
        this.type = type;
    }

    /**
     * 
     * The type of the card.
     * 
     * 
     * @return The type of the card.
     * @see CardType
     */

    public String getType() {
        return this.type;
    }

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

    public QQueryCardInput withType(String type) {
        setType(type);
        return this;
    }

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

    public QQueryCardInput withType(CardType type) {
        this.type = type.toString();
        return this;
    }

    /**
     * 
     * The prompt or instructions displayed for the query card.
     * 
     * 
     * @param prompt
     *        The prompt or instructions displayed for the query card.
     */

    public void setPrompt(String prompt) {
        this.prompt = prompt;
    }

    /**
     * 
     * The prompt or instructions displayed for the query card.
     * 
     * 
     * @return The prompt or instructions displayed for the query card.
     */

    public String getPrompt() {
        return this.prompt;
    }

    /**
     * 
     * The prompt or instructions displayed for the query card.
     * 
     * 
     * @param prompt
     *        The prompt or instructions displayed for the query card.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public QQueryCardInput withPrompt(String prompt) {
        setPrompt(prompt);
        return this;
    }

    /**
     * 
     * The source or type of output to generate for the query card.
     * 
     * 
     * @param outputSource
     *        The source or type of output to generate for the query card.
     * @see CardOutputSource
     */

    public void setOutputSource(String outputSource) {
        this.outputSource = outputSource;
    }

    /**
     * 
     * The source or type of output to generate for the query card.
     * 
     * 
     * @return The source or type of output to generate for the query card.
     * @see CardOutputSource
     */

    public String getOutputSource() {
        return this.outputSource;
    }

    /**
     * 
     * The source or type of output to generate for the query card.
     * 
     * 
     * @param outputSource
     *        The source or type of output to generate for the query card.
     * @return Returns a reference to this object so that method calls can be chained together.
     * @see CardOutputSource
     */

    public QQueryCardInput withOutputSource(String outputSource) {
        setOutputSource(outputSource);
        return this;
    }

    /**
     * 
     * The source or type of output to generate for the query card.
     * 
     * 
     * @param outputSource
     *        The source or type of output to generate for the query card.
     * @return Returns a reference to this object so that method calls can be chained together.
     * @see CardOutputSource
     */

    public QQueryCardInput withOutputSource(CardOutputSource outputSource) {
        this.outputSource = outputSource.toString();
        return this;
    }

    /**
     * 
     * Turns on filtering of responses based on document attributes or metadata fields.
     * 
     * 
     * @param attributeFilter
     *        Turns on filtering of responses based on document attributes or metadata fields.
     */

    public void setAttributeFilter(AttributeFilter attributeFilter) {
        this.attributeFilter = attributeFilter;
    }

    /**
     * 
     * Turns on filtering of responses based on document attributes or metadata fields.
     * 
     * 
     * @return Turns on filtering of responses based on document attributes or metadata fields.
     */

    public AttributeFilter getAttributeFilter() {
        return this.attributeFilter;
    }

    /**
     * 
     * Turns on filtering of responses based on document attributes or metadata fields.
     * 
     * 
     * @param attributeFilter
     *        Turns on filtering of responses based on document attributes or metadata fields.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public QQueryCardInput withAttributeFilter(AttributeFilter attributeFilter) {
        setAttributeFilter(attributeFilter);
        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 (getTitle() != null)
            sb.append("Title: ").append(getTitle()).append(",");
        if (getId() != null)
            sb.append("Id: ").append(getId()).append(",");
        if (getType() != null)
            sb.append("Type: ").append(getType()).append(",");
        if (getPrompt() != null)
            sb.append("Prompt: ").append(getPrompt()).append(",");
        if (getOutputSource() != null)
            sb.append("OutputSource: ").append(getOutputSource()).append(",");
        if (getAttributeFilter() != null)
            sb.append("AttributeFilter: ").append(getAttributeFilter());
        sb.append("}");
        return sb.toString();
    }

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

        if (obj instanceof QQueryCardInput == false)
            return false;
        QQueryCardInput other = (QQueryCardInput) obj;
        if (other.getTitle() == null ^ this.getTitle() == null)
            return false;
        if (other.getTitle() != null && other.getTitle().equals(this.getTitle()) == false)
            return false;
        if (other.getId() == null ^ this.getId() == null)
            return false;
        if (other.getId() != null && other.getId().equals(this.getId()) == false)
            return false;
        if (other.getType() == null ^ this.getType() == null)
            return false;
        if (other.getType() != null && other.getType().equals(this.getType()) == false)
            return false;
        if (other.getPrompt() == null ^ this.getPrompt() == null)
            return false;
        if (other.getPrompt() != null && other.getPrompt().equals(this.getPrompt()) == false)
            return false;
        if (other.getOutputSource() == null ^ this.getOutputSource() == null)
            return false;
        if (other.getOutputSource() != null && other.getOutputSource().equals(this.getOutputSource()) == false)
            return false;
        if (other.getAttributeFilter() == null ^ this.getAttributeFilter() == null)
            return false;
        if (other.getAttributeFilter() != null && other.getAttributeFilter().equals(this.getAttributeFilter()) == false)
            return false;
        return true;
    }

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

        hashCode = prime * hashCode + ((getTitle() == null) ? 0 : getTitle().hashCode());
        hashCode = prime * hashCode + ((getId() == null) ? 0 : getId().hashCode());
        hashCode = prime * hashCode + ((getType() == null) ? 0 : getType().hashCode());
        hashCode = prime * hashCode + ((getPrompt() == null) ? 0 : getPrompt().hashCode());
        hashCode = prime * hashCode + ((getOutputSource() == null) ? 0 : getOutputSource().hashCode());
        hashCode = prime * hashCode + ((getAttributeFilter() == null) ? 0 : getAttributeFilter().hashCode());
        return hashCode;
    }

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