/*
 * Copyright 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.
 */

/*
 * Do not modify this file. This file is generated from the kendra-2019-02-03.normal.json service model.
 */
using System;
using System.Collections.Generic;
using System.Xml.Serialization;
using System.Text;
using System.IO;
using System.Net;

using Amazon.Runtime;
using Amazon.Runtime.Internal;

namespace Amazon.Kendra.Model
{
    /// <summary>
    /// This is the response object from the Query operation.
    /// </summary>
    public partial class QueryResponse : AmazonWebServiceResponse
    {
        private List<FacetResult> _facetResults = new List<FacetResult>();
        private List<FeaturedResultsItem> _featuredResultsItems = new List<FeaturedResultsItem>();
        private string _queryId;
        private List<QueryResultItem> _resultItems = new List<QueryResultItem>();
        private List<SpellCorrectedQuery> _spellCorrectedQueries = new List<SpellCorrectedQuery>();
        private int? _totalNumberOfResults;
        private List<Warning> _warnings = new List<Warning>();

        /// <summary>
        /// Gets and sets the property FacetResults. 
        /// <para>
        /// Contains the facet results. A <code>FacetResult</code> contains the counts for each
        /// field/attribute key that was specified in the <code>Facets</code> input parameter.
        /// </para>
        /// </summary>
        public List<FacetResult> FacetResults
        {
            get { return this._facetResults; }
            set { this._facetResults = value; }
        }

        // Check to see if FacetResults property is set
        internal bool IsSetFacetResults()
        {
            return this._facetResults != null && this._facetResults.Count > 0; 
        }

        /// <summary>
        /// Gets and sets the property FeaturedResultsItems. 
        /// <para>
        /// The list of featured result items. Featured results are displayed at the top of the
        /// search results page, placed above all other results for certain queries. If there's
        /// an exact match of a query, then certain documents are featured in the search results.
        /// </para>
        /// </summary>
        public List<FeaturedResultsItem> FeaturedResultsItems
        {
            get { return this._featuredResultsItems; }
            set { this._featuredResultsItems = value; }
        }

        // Check to see if FeaturedResultsItems property is set
        internal bool IsSetFeaturedResultsItems()
        {
            return this._featuredResultsItems != null && this._featuredResultsItems.Count > 0; 
        }

        /// <summary>
        /// Gets and sets the property QueryId. 
        /// <para>
        /// The identifier for the search. You also use <code>QueryId</code> to identify the search
        /// when using the <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_SubmitFeedback.html">SubmitFeedback</a>
        /// API.
        /// </para>
        /// </summary>
        [AWSProperty(Min=1, Max=36)]
        public string QueryId
        {
            get { return this._queryId; }
            set { this._queryId = value; }
        }

        // Check to see if QueryId property is set
        internal bool IsSetQueryId()
        {
            return this._queryId != null;
        }

        /// <summary>
        /// Gets and sets the property ResultItems. 
        /// <para>
        /// The results of the search.
        /// </para>
        /// </summary>
        public List<QueryResultItem> ResultItems
        {
            get { return this._resultItems; }
            set { this._resultItems = value; }
        }

        // Check to see if ResultItems property is set
        internal bool IsSetResultItems()
        {
            return this._resultItems != null && this._resultItems.Count > 0; 
        }

        /// <summary>
        /// Gets and sets the property SpellCorrectedQueries. 
        /// <para>
        /// A list of information related to suggested spell corrections for a query.
        /// </para>
        /// </summary>
        public List<SpellCorrectedQuery> SpellCorrectedQueries
        {
            get { return this._spellCorrectedQueries; }
            set { this._spellCorrectedQueries = value; }
        }

        // Check to see if SpellCorrectedQueries property is set
        internal bool IsSetSpellCorrectedQueries()
        {
            return this._spellCorrectedQueries != null && this._spellCorrectedQueries.Count > 0; 
        }

        /// <summary>
        /// Gets and sets the property TotalNumberOfResults. 
        /// <para>
        /// The total number of items found by the search. However, you can only retrieve up to
        /// 100 items. For example, if the search found 192 items, you can only retrieve the first
        /// 100 of the items.
        /// </para>
        /// </summary>
        public int TotalNumberOfResults
        {
            get { return this._totalNumberOfResults.GetValueOrDefault(); }
            set { this._totalNumberOfResults = value; }
        }

        // Check to see if TotalNumberOfResults property is set
        internal bool IsSetTotalNumberOfResults()
        {
            return this._totalNumberOfResults.HasValue; 
        }

        /// <summary>
        /// Gets and sets the property Warnings. 
        /// <para>
        /// A list of warning codes and their messages on problems with your query.
        /// </para>
        ///  
        /// <para>
        /// Amazon Kendra currently only supports one type of warning, which is a warning on invalid
        /// syntax used in the query. For examples of invalid query syntax, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/searching-example.html#searching-index-query-syntax">Searching
        /// with advanced query syntax</a>.
        /// </para>
        /// </summary>
        [AWSProperty(Min=1, Max=1)]
        public List<Warning> Warnings
        {
            get { return this._warnings; }
            set { this._warnings = value; }
        }

        // Check to see if Warnings property is set
        internal bool IsSetWarnings()
        {
            return this._warnings != null && this._warnings.Count > 0; 
        }

    }
}