/*
 * 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 DescribeQuerySuggestionsConfig operation.
    /// </summary>
    public partial class DescribeQuerySuggestionsConfigResponse : AmazonWebServiceResponse
    {
        private AttributeSuggestionsDescribeConfig _attributeSuggestionsConfig;
        private bool? _includeQueriesWithoutUserInformation;
        private DateTime? _lastClearTime;
        private DateTime? _lastSuggestionsBuildTime;
        private int? _minimumNumberOfQueryingUsers;
        private int? _minimumQueryCount;
        private Mode _mode;
        private int? _queryLogLookBackWindowInDays;
        private QuerySuggestionsStatus _status;
        private int? _totalSuggestionsCount;

        /// <summary>
        /// Gets and sets the property AttributeSuggestionsConfig. 
        /// <para>
        /// Configuration information for the document fields/attributes that you want to base
        /// query suggestions on.
        /// </para>
        /// </summary>
        public AttributeSuggestionsDescribeConfig AttributeSuggestionsConfig
        {
            get { return this._attributeSuggestionsConfig; }
            set { this._attributeSuggestionsConfig = value; }
        }

        // Check to see if AttributeSuggestionsConfig property is set
        internal bool IsSetAttributeSuggestionsConfig()
        {
            return this._attributeSuggestionsConfig != null;
        }

        /// <summary>
        /// Gets and sets the property IncludeQueriesWithoutUserInformation. 
        /// <para>
        ///  <code>TRUE</code> to use all queries, otherwise use only queries that include user
        /// information to generate the query suggestions.
        /// </para>
        /// </summary>
        public bool IncludeQueriesWithoutUserInformation
        {
            get { return this._includeQueriesWithoutUserInformation.GetValueOrDefault(); }
            set { this._includeQueriesWithoutUserInformation = value; }
        }

        // Check to see if IncludeQueriesWithoutUserInformation property is set
        internal bool IsSetIncludeQueriesWithoutUserInformation()
        {
            return this._includeQueriesWithoutUserInformation.HasValue; 
        }

        /// <summary>
        /// Gets and sets the property LastClearTime. 
        /// <para>
        /// The Unix timestamp when query suggestions for an index was last cleared.
        /// </para>
        ///  
        /// <para>
        /// After you clear suggestions, Amazon Kendra learns new suggestions based on new queries
        /// added to the query log from the time you cleared suggestions. Amazon Kendra only considers
        /// re-occurences of a query from the time you cleared suggestions. 
        /// </para>
        /// </summary>
        public DateTime LastClearTime
        {
            get { return this._lastClearTime.GetValueOrDefault(); }
            set { this._lastClearTime = value; }
        }

        // Check to see if LastClearTime property is set
        internal bool IsSetLastClearTime()
        {
            return this._lastClearTime.HasValue; 
        }

        /// <summary>
        /// Gets and sets the property LastSuggestionsBuildTime. 
        /// <para>
        /// The Unix timestamp when query suggestions for an index was last updated.
        /// </para>
        ///  
        /// <para>
        /// Amazon Kendra automatically updates suggestions every 24 hours, after you change a
        /// setting or after you apply a <a href="https://docs.aws.amazon.com/kendra/latest/dg/query-suggestions.html#query-suggestions-blocklist">block
        /// list</a>.
        /// </para>
        /// </summary>
        public DateTime LastSuggestionsBuildTime
        {
            get { return this._lastSuggestionsBuildTime.GetValueOrDefault(); }
            set { this._lastSuggestionsBuildTime = value; }
        }

        // Check to see if LastSuggestionsBuildTime property is set
        internal bool IsSetLastSuggestionsBuildTime()
        {
            return this._lastSuggestionsBuildTime.HasValue; 
        }

        /// <summary>
        /// Gets and sets the property MinimumNumberOfQueryingUsers. 
        /// <para>
        /// The minimum number of unique users who must search a query in order for the query
        /// to be eligible to suggest to your users.
        /// </para>
        /// </summary>
        [AWSProperty(Min=1, Max=10000)]
        public int MinimumNumberOfQueryingUsers
        {
            get { return this._minimumNumberOfQueryingUsers.GetValueOrDefault(); }
            set { this._minimumNumberOfQueryingUsers = value; }
        }

        // Check to see if MinimumNumberOfQueryingUsers property is set
        internal bool IsSetMinimumNumberOfQueryingUsers()
        {
            return this._minimumNumberOfQueryingUsers.HasValue; 
        }

        /// <summary>
        /// Gets and sets the property MinimumQueryCount. 
        /// <para>
        /// The minimum number of times a query must be searched in order for the query to be
        /// eligible to suggest to your users.
        /// </para>
        /// </summary>
        [AWSProperty(Min=1, Max=10000)]
        public int MinimumQueryCount
        {
            get { return this._minimumQueryCount.GetValueOrDefault(); }
            set { this._minimumQueryCount = value; }
        }

        // Check to see if MinimumQueryCount property is set
        internal bool IsSetMinimumQueryCount()
        {
            return this._minimumQueryCount.HasValue; 
        }

        /// <summary>
        /// Gets and sets the property Mode. 
        /// <para>
        /// Whether query suggestions are currently in <code>ENABLED</code> mode or <code>LEARN_ONLY</code>
        /// mode.
        /// </para>
        ///  
        /// <para>
        /// By default, Amazon Kendra enables query suggestions.<code>LEARN_ONLY</code> turns
        /// off query suggestions for your users. You can change the mode using the <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateQuerySuggestionsConfig.html">UpdateQuerySuggestionsConfig</a>
        /// API.
        /// </para>
        /// </summary>
        public Mode Mode
        {
            get { return this._mode; }
            set { this._mode = value; }
        }

        // Check to see if Mode property is set
        internal bool IsSetMode()
        {
            return this._mode != null;
        }

        /// <summary>
        /// Gets and sets the property QueryLogLookBackWindowInDays. 
        /// <para>
        /// How recent your queries are in your query log time window (in days).
        /// </para>
        /// </summary>
        public int QueryLogLookBackWindowInDays
        {
            get { return this._queryLogLookBackWindowInDays.GetValueOrDefault(); }
            set { this._queryLogLookBackWindowInDays = value; }
        }

        // Check to see if QueryLogLookBackWindowInDays property is set
        internal bool IsSetQueryLogLookBackWindowInDays()
        {
            return this._queryLogLookBackWindowInDays.HasValue; 
        }

        /// <summary>
        /// Gets and sets the property Status. 
        /// <para>
        /// Whether the status of query suggestions settings is currently <code>ACTIVE</code>
        /// or <code>UPDATING</code>.
        /// </para>
        ///  
        /// <para>
        /// Active means the current settings apply and Updating means your changed settings are
        /// in the process of applying.
        /// </para>
        /// </summary>
        public QuerySuggestionsStatus Status
        {
            get { return this._status; }
            set { this._status = value; }
        }

        // Check to see if Status property is set
        internal bool IsSetStatus()
        {
            return this._status != null;
        }

        /// <summary>
        /// Gets and sets the property TotalSuggestionsCount. 
        /// <para>
        /// The current total count of query suggestions for an index.
        /// </para>
        ///  
        /// <para>
        /// This count can change when you update your query suggestions settings, if you filter
        /// out certain queries from suggestions using a block list, and as the query log accumulates
        /// more queries for Amazon Kendra to learn from.
        /// </para>
        ///  
        /// <para>
        /// If the count is much lower than you expected, it could be because Amazon Kendra needs
        /// more queries in the query history to learn from or your current query suggestions
        /// settings are too strict.
        /// </para>
        /// </summary>
        public int TotalSuggestionsCount
        {
            get { return this._totalSuggestionsCount.GetValueOrDefault(); }
            set { this._totalSuggestionsCount = value; }
        }

        // Check to see if TotalSuggestionsCount property is set
        internal bool IsSetTotalSuggestionsCount()
        {
            return this._totalSuggestionsCount.HasValue; 
        }

    }
}