/*
 * 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 models.lex.v2-2020-08-07.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.LexModelsV2.Model
{
    /// <summary>
    /// Container for the parameters to the ListUtteranceMetrics operation.
    /// <note> 
    /// <para>
    /// To use this API operation, your IAM role must have permissions to perform the <a href="https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListAggregatedUtterances.html">ListAggregatedUtterances</a>
    /// operation, which provides access to utterance-related analytics. See <a href="https://docs.aws.amazon.com/lexv2/latest/dg/monitoring-utterances.html">Viewing
    /// utterance statistics</a> for the IAM policy to apply to the IAM role.
    /// </para>
    ///  </note> 
    /// <para>
    /// Retrieves summary metrics for the utterances in your bot. The following fields are
    /// required:
    /// </para>
    ///  <ul> <li> 
    /// <para>
    ///  <code>metrics</code> – A list of <a href="https://docs.aws.amazon.com/lexv2/latest/APIReference/API_AnalyticsUtteranceMetric.html">AnalyticsUtteranceMetric</a>
    /// objects. In each object, use the <code>name</code> field to specify the metric to
    /// calculate, the <code>statistic</code> field to specify whether to calculate the <code>Sum</code>,
    /// <code>Average</code>, or <code>Max</code> number, and the <code>order</code> field
    /// to specify whether to sort the results in <code>Ascending</code> or <code>Descending</code>
    /// order.
    /// </para>
    ///  </li> <li> 
    /// <para>
    ///  <code>startDateTime</code> and <code>endDateTime</code> – Define a time range for
    /// which you want to retrieve results.
    /// </para>
    ///  </li> </ul> 
    /// <para>
    /// Of the optional fields, you can organize the results in the following ways:
    /// </para>
    ///  <ul> <li> 
    /// <para>
    /// Use the <code>filters</code> field to filter the results, the <code>groupBy</code>
    /// field to specify categories by which to group the results, and the <code>binBy</code>
    /// field to specify time intervals by which to group the results.
    /// </para>
    ///  </li> <li> 
    /// <para>
    /// Use the <code>maxResults</code> field to limit the number of results to return in
    /// a single response and the <code>nextToken</code> field to return the next batch of
    /// results if the response does not return the full set of results.
    /// </para>
    ///  </li> </ul> 
    /// <para>
    /// Note that an <code>order</code> field exists in both <code>binBy</code> and <code>metrics</code>.
    /// Currently, you can specify it in either field, but not in both.
    /// </para>
    /// </summary>
    public partial class ListUtteranceMetricsRequest : AmazonLexModelsV2Request
    {
        private List<AnalyticsUtteranceAttribute> _attributes = new List<AnalyticsUtteranceAttribute>();
        private List<AnalyticsBinBySpecification> _binBy = new List<AnalyticsBinBySpecification>();
        private string _botId;
        private DateTime? _endDateTime;
        private List<AnalyticsUtteranceFilter> _filters = new List<AnalyticsUtteranceFilter>();
        private List<AnalyticsUtteranceGroupBySpecification> _groupBy = new List<AnalyticsUtteranceGroupBySpecification>();
        private int? _maxResults;
        private List<AnalyticsUtteranceMetric> _metrics = new List<AnalyticsUtteranceMetric>();
        private string _nextToken;
        private DateTime? _startDateTime;

        /// <summary>
        /// Gets and sets the property Attributes. 
        /// <para>
        /// A list containing attributes related to the utterance that you want the response to
        /// return. The following attributes are possible:
        /// </para>
        ///  <ul> <li> 
        /// <para>
        ///  <code>LastUsedIntent</code> – The last used intent at the time of the utterance.
        /// </para>
        ///  </li> </ul>
        /// </summary>
        [AWSProperty(Min=1, Max=1)]
        public List<AnalyticsUtteranceAttribute> Attributes
        {
            get { return this._attributes; }
            set { this._attributes = value; }
        }

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

        /// <summary>
        /// Gets and sets the property BinBy. 
        /// <para>
        /// A list of objects, each of which contains specifications for organizing the results
        /// by time.
        /// </para>
        /// </summary>
        [AWSProperty(Min=1, Max=1)]
        public List<AnalyticsBinBySpecification> BinBy
        {
            get { return this._binBy; }
            set { this._binBy = value; }
        }

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

        /// <summary>
        /// Gets and sets the property BotId. 
        /// <para>
        /// The identifier for the bot for which you want to retrieve utterance metrics.
        /// </para>
        /// </summary>
        [AWSProperty(Required=true, Min=10, Max=10)]
        public string BotId
        {
            get { return this._botId; }
            set { this._botId = value; }
        }

        // Check to see if BotId property is set
        internal bool IsSetBotId()
        {
            return this._botId != null;
        }

        /// <summary>
        /// Gets and sets the property EndDateTime. 
        /// <para>
        /// The date and time that marks the end of the range of time for which you want to see
        /// utterance metrics.
        /// </para>
        /// </summary>
        [AWSProperty(Required=true)]
        public DateTime EndDateTime
        {
            get { return this._endDateTime.GetValueOrDefault(); }
            set { this._endDateTime = value; }
        }

        // Check to see if EndDateTime property is set
        internal bool IsSetEndDateTime()
        {
            return this._endDateTime.HasValue; 
        }

        /// <summary>
        /// Gets and sets the property Filters. 
        /// <para>
        /// A list of objects, each of which describes a condition by which you want to filter
        /// the results.
        /// </para>
        /// </summary>
        [AWSProperty(Min=1, Max=9)]
        public List<AnalyticsUtteranceFilter> Filters
        {
            get { return this._filters; }
            set { this._filters = value; }
        }

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

        /// <summary>
        /// Gets and sets the property GroupBy. 
        /// <para>
        /// A list of objects, each of which specifies how to group the results. You can group
        /// by the following criteria:
        /// </para>
        ///  <ul> <li> 
        /// <para>
        ///  <code>UtteranceText</code> – The transcription of the utterance.
        /// </para>
        ///  </li> <li> 
        /// <para>
        ///  <code>UtteranceState</code> – The state of the utterance. The possible states are
        /// detailed in <a href="https://docs.aws.amazon.com/analytics-key-definitions-utterances">Key
        /// definitions</a> in the user guide.
        /// </para>
        ///  </li> </ul>
        /// </summary>
        [AWSProperty(Min=1, Max=2)]
        public List<AnalyticsUtteranceGroupBySpecification> GroupBy
        {
            get { return this._groupBy; }
            set { this._groupBy = value; }
        }

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

        /// <summary>
        /// Gets and sets the property MaxResults. 
        /// <para>
        /// The maximum number of results to return in each page of results. If there are fewer
        /// results than the maximum page size, only the actual number of results are returned.
        /// </para>
        /// </summary>
        [AWSProperty(Min=1, Max=1000)]
        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 Metrics. 
        /// <para>
        /// A list of objects, each of which contains a metric you want to list, the statistic
        /// for the metric you want to return, and the method by which to organize the results.
        /// </para>
        /// </summary>
        [AWSProperty(Required=true, Min=1, Max=4)]
        public List<AnalyticsUtteranceMetric> Metrics
        {
            get { return this._metrics; }
            set { this._metrics = value; }
        }

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

        /// <summary>
        /// Gets and sets the property NextToken. 
        /// <para>
        /// If the response from the ListUtteranceMetrics operation contains more results than
        /// specified in the maxResults parameter, a token is returned in the response.
        /// </para>
        ///  
        /// <para>
        /// Use the returned token in the nextToken parameter of a ListUtteranceMetrics request
        /// to return the next page of results. For a complete set of results, call the ListUtteranceMetrics
        /// operation until the nextToken returned in the response is null.
        /// </para>
        /// </summary>
        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;
        }

        /// <summary>
        /// Gets and sets the property StartDateTime. 
        /// <para>
        /// The date and time that marks the beginning of the range of time for which you want
        /// to see utterance metrics.
        /// </para>
        /// </summary>
        [AWSProperty(Required=true)]
        public DateTime StartDateTime
        {
            get { return this._startDateTime.GetValueOrDefault(); }
            set { this._startDateTime = value; }
        }

        // Check to see if StartDateTime property is set
        internal bool IsSetStartDateTime()
        {
            return this._startDateTime.HasValue; 
        }

    }
}