/*
 * 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.textract.model;

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

/**
 * <p>
 * Each query contains the question you want to ask in the Text and the alias you want to associate.
 * </p>
 * 
 * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/Query" target="_top">AWS API
 *      Documentation</a>
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class Query implements Serializable, Cloneable, StructuredPojo {

    /**
     * <p>
     * Question that Amazon Textract will apply to the document. An example would be "What is the customer's SSN?"
     * </p>
     */
    private String text;
    /**
     * <p>
     * Alias attached to the query, for ease of location.
     * </p>
     */
    private String alias;
    /**
     * <p>
     * Pages is a parameter that the user inputs to specify which pages to apply a query to. The following is a list of
     * rules for using this parameter.
     * </p>
     * <ul>
     * <li>
     * <p>
     * If a page is not specified, it is set to <code>["1"]</code> by default.
     * </p>
     * </li>
     * <li>
     * <p>
     * The following characters are allowed in the parameter's string: <code>0 1 2 3 4 5 6 7 8 9 - *</code>. No
     * whitespace is allowed.
     * </p>
     * </li>
     * <li>
     * <p>
     * When using * to indicate all pages, it must be the only element in the list.
     * </p>
     * </li>
     * <li>
     * <p>
     * You can use page intervals, such as <code>[“1-3”, “1-1”, “4-*”]</code>. Where <code>*</code> indicates last page
     * of document.
     * </p>
     * </li>
     * <li>
     * <p>
     * Specified pages must be greater than 0 and less than or equal to the number of pages in the document.
     * </p>
     * </li>
     * </ul>
     */
    private java.util.List<String> pages;

    /**
     * <p>
     * Question that Amazon Textract will apply to the document. An example would be "What is the customer's SSN?"
     * </p>
     * 
     * @param text
     *        Question that Amazon Textract will apply to the document. An example would be
     *        "What is the customer's SSN?"
     */

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

    /**
     * <p>
     * Question that Amazon Textract will apply to the document. An example would be "What is the customer's SSN?"
     * </p>
     * 
     * @return Question that Amazon Textract will apply to the document. An example would be
     *         "What is the customer's SSN?"
     */

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

    /**
     * <p>
     * Question that Amazon Textract will apply to the document. An example would be "What is the customer's SSN?"
     * </p>
     * 
     * @param text
     *        Question that Amazon Textract will apply to the document. An example would be
     *        "What is the customer's SSN?"
     * @return Returns a reference to this object so that method calls can be chained together.
     */

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

    /**
     * <p>
     * Alias attached to the query, for ease of location.
     * </p>
     * 
     * @param alias
     *        Alias attached to the query, for ease of location.
     */

    public void setAlias(String alias) {
        this.alias = alias;
    }

    /**
     * <p>
     * Alias attached to the query, for ease of location.
     * </p>
     * 
     * @return Alias attached to the query, for ease of location.
     */

    public String getAlias() {
        return this.alias;
    }

    /**
     * <p>
     * Alias attached to the query, for ease of location.
     * </p>
     * 
     * @param alias
     *        Alias attached to the query, for ease of location.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public Query withAlias(String alias) {
        setAlias(alias);
        return this;
    }

    /**
     * <p>
     * Pages is a parameter that the user inputs to specify which pages to apply a query to. The following is a list of
     * rules for using this parameter.
     * </p>
     * <ul>
     * <li>
     * <p>
     * If a page is not specified, it is set to <code>["1"]</code> by default.
     * </p>
     * </li>
     * <li>
     * <p>
     * The following characters are allowed in the parameter's string: <code>0 1 2 3 4 5 6 7 8 9 - *</code>. No
     * whitespace is allowed.
     * </p>
     * </li>
     * <li>
     * <p>
     * When using * to indicate all pages, it must be the only element in the list.
     * </p>
     * </li>
     * <li>
     * <p>
     * You can use page intervals, such as <code>[“1-3”, “1-1”, “4-*”]</code>. Where <code>*</code> indicates last page
     * of document.
     * </p>
     * </li>
     * <li>
     * <p>
     * Specified pages must be greater than 0 and less than or equal to the number of pages in the document.
     * </p>
     * </li>
     * </ul>
     * 
     * @return Pages is a parameter that the user inputs to specify which pages to apply a query to. The following is a
     *         list of rules for using this parameter.</p>
     *         <ul>
     *         <li>
     *         <p>
     *         If a page is not specified, it is set to <code>["1"]</code> by default.
     *         </p>
     *         </li>
     *         <li>
     *         <p>
     *         The following characters are allowed in the parameter's string: <code>0 1 2 3 4 5 6 7 8 9 - *</code>. No
     *         whitespace is allowed.
     *         </p>
     *         </li>
     *         <li>
     *         <p>
     *         When using * to indicate all pages, it must be the only element in the list.
     *         </p>
     *         </li>
     *         <li>
     *         <p>
     *         You can use page intervals, such as <code>[“1-3”, “1-1”, “4-*”]</code>. Where <code>*</code> indicates
     *         last page of document.
     *         </p>
     *         </li>
     *         <li>
     *         <p>
     *         Specified pages must be greater than 0 and less than or equal to the number of pages in the document.
     *         </p>
     *         </li>
     */

    public java.util.List<String> getPages() {
        return pages;
    }

    /**
     * <p>
     * Pages is a parameter that the user inputs to specify which pages to apply a query to. The following is a list of
     * rules for using this parameter.
     * </p>
     * <ul>
     * <li>
     * <p>
     * If a page is not specified, it is set to <code>["1"]</code> by default.
     * </p>
     * </li>
     * <li>
     * <p>
     * The following characters are allowed in the parameter's string: <code>0 1 2 3 4 5 6 7 8 9 - *</code>. No
     * whitespace is allowed.
     * </p>
     * </li>
     * <li>
     * <p>
     * When using * to indicate all pages, it must be the only element in the list.
     * </p>
     * </li>
     * <li>
     * <p>
     * You can use page intervals, such as <code>[“1-3”, “1-1”, “4-*”]</code>. Where <code>*</code> indicates last page
     * of document.
     * </p>
     * </li>
     * <li>
     * <p>
     * Specified pages must be greater than 0 and less than or equal to the number of pages in the document.
     * </p>
     * </li>
     * </ul>
     * 
     * @param pages
     *        Pages is a parameter that the user inputs to specify which pages to apply a query to. The following is a
     *        list of rules for using this parameter.</p>
     *        <ul>
     *        <li>
     *        <p>
     *        If a page is not specified, it is set to <code>["1"]</code> by default.
     *        </p>
     *        </li>
     *        <li>
     *        <p>
     *        The following characters are allowed in the parameter's string: <code>0 1 2 3 4 5 6 7 8 9 - *</code>. No
     *        whitespace is allowed.
     *        </p>
     *        </li>
     *        <li>
     *        <p>
     *        When using * to indicate all pages, it must be the only element in the list.
     *        </p>
     *        </li>
     *        <li>
     *        <p>
     *        You can use page intervals, such as <code>[“1-3”, “1-1”, “4-*”]</code>. Where <code>*</code> indicates
     *        last page of document.
     *        </p>
     *        </li>
     *        <li>
     *        <p>
     *        Specified pages must be greater than 0 and less than or equal to the number of pages in the document.
     *        </p>
     *        </li>
     */

    public void setPages(java.util.Collection<String> pages) {
        if (pages == null) {
            this.pages = null;
            return;
        }

        this.pages = new java.util.ArrayList<String>(pages);
    }

    /**
     * <p>
     * Pages is a parameter that the user inputs to specify which pages to apply a query to. The following is a list of
     * rules for using this parameter.
     * </p>
     * <ul>
     * <li>
     * <p>
     * If a page is not specified, it is set to <code>["1"]</code> by default.
     * </p>
     * </li>
     * <li>
     * <p>
     * The following characters are allowed in the parameter's string: <code>0 1 2 3 4 5 6 7 8 9 - *</code>. No
     * whitespace is allowed.
     * </p>
     * </li>
     * <li>
     * <p>
     * When using * to indicate all pages, it must be the only element in the list.
     * </p>
     * </li>
     * <li>
     * <p>
     * You can use page intervals, such as <code>[“1-3”, “1-1”, “4-*”]</code>. Where <code>*</code> indicates last page
     * of document.
     * </p>
     * </li>
     * <li>
     * <p>
     * Specified pages must be greater than 0 and less than or equal to the number of pages in the document.
     * </p>
     * </li>
     * </ul>
     * <p>
     * <b>NOTE:</b> This method appends the values to the existing list (if any). Use
     * {@link #setPages(java.util.Collection)} or {@link #withPages(java.util.Collection)} if you want to override the
     * existing values.
     * </p>
     * 
     * @param pages
     *        Pages is a parameter that the user inputs to specify which pages to apply a query to. The following is a
     *        list of rules for using this parameter.</p>
     *        <ul>
     *        <li>
     *        <p>
     *        If a page is not specified, it is set to <code>["1"]</code> by default.
     *        </p>
     *        </li>
     *        <li>
     *        <p>
     *        The following characters are allowed in the parameter's string: <code>0 1 2 3 4 5 6 7 8 9 - *</code>. No
     *        whitespace is allowed.
     *        </p>
     *        </li>
     *        <li>
     *        <p>
     *        When using * to indicate all pages, it must be the only element in the list.
     *        </p>
     *        </li>
     *        <li>
     *        <p>
     *        You can use page intervals, such as <code>[“1-3”, “1-1”, “4-*”]</code>. Where <code>*</code> indicates
     *        last page of document.
     *        </p>
     *        </li>
     *        <li>
     *        <p>
     *        Specified pages must be greater than 0 and less than or equal to the number of pages in the document.
     *        </p>
     *        </li>
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public Query withPages(String... pages) {
        if (this.pages == null) {
            setPages(new java.util.ArrayList<String>(pages.length));
        }
        for (String ele : pages) {
            this.pages.add(ele);
        }
        return this;
    }

    /**
     * <p>
     * Pages is a parameter that the user inputs to specify which pages to apply a query to. The following is a list of
     * rules for using this parameter.
     * </p>
     * <ul>
     * <li>
     * <p>
     * If a page is not specified, it is set to <code>["1"]</code> by default.
     * </p>
     * </li>
     * <li>
     * <p>
     * The following characters are allowed in the parameter's string: <code>0 1 2 3 4 5 6 7 8 9 - *</code>. No
     * whitespace is allowed.
     * </p>
     * </li>
     * <li>
     * <p>
     * When using * to indicate all pages, it must be the only element in the list.
     * </p>
     * </li>
     * <li>
     * <p>
     * You can use page intervals, such as <code>[“1-3”, “1-1”, “4-*”]</code>. Where <code>*</code> indicates last page
     * of document.
     * </p>
     * </li>
     * <li>
     * <p>
     * Specified pages must be greater than 0 and less than or equal to the number of pages in the document.
     * </p>
     * </li>
     * </ul>
     * 
     * @param pages
     *        Pages is a parameter that the user inputs to specify which pages to apply a query to. The following is a
     *        list of rules for using this parameter.</p>
     *        <ul>
     *        <li>
     *        <p>
     *        If a page is not specified, it is set to <code>["1"]</code> by default.
     *        </p>
     *        </li>
     *        <li>
     *        <p>
     *        The following characters are allowed in the parameter's string: <code>0 1 2 3 4 5 6 7 8 9 - *</code>. No
     *        whitespace is allowed.
     *        </p>
     *        </li>
     *        <li>
     *        <p>
     *        When using * to indicate all pages, it must be the only element in the list.
     *        </p>
     *        </li>
     *        <li>
     *        <p>
     *        You can use page intervals, such as <code>[“1-3”, “1-1”, “4-*”]</code>. Where <code>*</code> indicates
     *        last page of document.
     *        </p>
     *        </li>
     *        <li>
     *        <p>
     *        Specified pages must be greater than 0 and less than or equal to the number of pages in the document.
     *        </p>
     *        </li>
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public Query withPages(java.util.Collection<String> pages) {
        setPages(pages);
        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 (getAlias() != null)
            sb.append("Alias: ").append(getAlias()).append(",");
        if (getPages() != null)
            sb.append("Pages: ").append(getPages());
        sb.append("}");
        return sb.toString();
    }

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

        if (obj instanceof Query == false)
            return false;
        Query other = (Query) obj;
        if (other.getText() == null ^ this.getText() == null)
            return false;
        if (other.getText() != null && other.getText().equals(this.getText()) == false)
            return false;
        if (other.getAlias() == null ^ this.getAlias() == null)
            return false;
        if (other.getAlias() != null && other.getAlias().equals(this.getAlias()) == false)
            return false;
        if (other.getPages() == null ^ this.getPages() == null)
            return false;
        if (other.getPages() != null && other.getPages().equals(this.getPages()) == 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 + ((getAlias() == null) ? 0 : getAlias().hashCode());
        hashCode = prime * hashCode + ((getPages() == null) ? 0 : getPages().hashCode());
        return hashCode;
    }

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