/*
 * 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>
    /// Container for the parameters to the GetSnapshots operation.
    /// Retrieves search metrics data. The data provides a snapshot of how your users interact
    /// with your search application and how effective the application is.
    /// </summary>
    public partial class GetSnapshotsRequest : AmazonKendraRequest
    {
        private string _indexId;
        private Interval _interval;
        private int? _maxResults;
        private MetricType _metricType;
        private string _nextToken;

        /// <summary>
        /// Gets and sets the property IndexId. 
        /// <para>
        /// The identifier of the index to get search metrics data.
        /// </para>
        /// </summary>
        [AWSProperty(Required=true, Min=36, Max=36)]
        public string IndexId
        {
            get { return this._indexId; }
            set { this._indexId = value; }
        }

        // Check to see if IndexId property is set
        internal bool IsSetIndexId()
        {
            return this._indexId != null;
        }

        /// <summary>
        /// Gets and sets the property Interval. 
        /// <para>
        /// The time interval or time window to get search metrics data. The time interval uses
        /// the time zone of your index. You can view data in the following time windows:
        /// </para>
        ///  <ul> <li> 
        /// <para>
        ///  <code>THIS_WEEK</code>: The current week, starting on the Sunday and ending on the
        /// day before the current date.
        /// </para>
        ///  </li> <li> 
        /// <para>
        ///  <code>ONE_WEEK_AGO</code>: The previous week, starting on the Sunday and ending on
        /// the following Saturday.
        /// </para>
        ///  </li> <li> 
        /// <para>
        ///  <code>TWO_WEEKS_AGO</code>: The week before the previous week, starting on the Sunday
        /// and ending on the following Saturday.
        /// </para>
        ///  </li> <li> 
        /// <para>
        ///  <code>THIS_MONTH</code>: The current month, starting on the first day of the month
        /// and ending on the day before the current date.
        /// </para>
        ///  </li> <li> 
        /// <para>
        ///  <code>ONE_MONTH_AGO</code>: The previous month, starting on the first day of the
        /// month and ending on the last day of the month.
        /// </para>
        ///  </li> <li> 
        /// <para>
        ///  <code>TWO_MONTHS_AGO</code>: The month before the previous month, starting on the
        /// first day of the month and ending on last day of the month.
        /// </para>
        ///  </li> </ul>
        /// </summary>
        [AWSProperty(Required=true)]
        public Interval Interval
        {
            get { return this._interval; }
            set { this._interval = value; }
        }

        // Check to see if Interval property is set
        internal bool IsSetInterval()
        {
            return this._interval != null;
        }

        /// <summary>
        /// Gets and sets the property MaxResults. 
        /// <para>
        /// The maximum number of returned data for the metric.
        /// </para>
        /// </summary>
        public int MaxResults
        {
            get { return this._maxResults.GetValueOrDefault(); }
            set { this._maxResults = value; }
        }

        // Check to see if MaxResults property is set
        internal bool IsSetMaxResults()
        {
            return this._maxResults.HasValue; 
        }

        /// <summary>
        /// Gets and sets the property MetricType. 
        /// <para>
        /// The metric you want to retrieve. You can specify only one metric per call.
        /// </para>
        ///  
        /// <para>
        /// For more information about the metrics you can view, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/search-analytics.html">Gaining
        /// insights with search analytics</a>.
        /// </para>
        /// </summary>
        [AWSProperty(Required=true)]
        public MetricType MetricType
        {
            get { return this._metricType; }
            set { this._metricType = value; }
        }

        // Check to see if MetricType property is set
        internal bool IsSetMetricType()
        {
            return this._metricType != null;
        }

        /// <summary>
        /// Gets and sets the property NextToken. 
        /// <para>
        /// If the previous response was incomplete (because there is more data to retrieve),
        /// Amazon Kendra returns a pagination token in the response. You can use this pagination
        /// token to retrieve the next set of search metrics data.
        /// </para>
        /// </summary>
        [AWSProperty(Min=1, Max=800)]
        public string NextToken
        {
            get { return this._nextToken; }
            set { this._nextToken = value; }
        }

        // Check to see if NextToken property is set
        internal bool IsSetNextToken()
        {
            return this._nextToken != null;
        }

    }
}