/*
 * 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 kinesis-video-archived-media-2017-09-30.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.KinesisVideoArchivedMedia.Model
{
    /// <summary>
    /// Container for the parameters to the GetImages operation.
    /// Retrieves a list of Images corresponding to each timestamp for a given time range,
    /// sampling interval, and image format configuration.
    /// </summary>
    public partial class GetImagesRequest : AmazonKinesisVideoArchivedMediaRequest
    {
        private DateTime? _endTimestamp;
        private Format _format;
        private Dictionary<string, string> _formatConfig = new Dictionary<string, string>();
        private int? _heightPixels;
        private ImageSelectorType _imageSelectorType;
        private long? _maxResults;
        private string _nextToken;
        private int? _samplingInterval;
        private DateTime? _startTimestamp;
        private string _streamARN;
        private string _streamName;
        private int? _widthPixels;

        /// <summary>
        /// Gets and sets the property EndTimestamp. 
        /// <para>
        /// The end timestamp for the range of images to be generated.
        /// </para>
        /// </summary>
        [AWSProperty(Required=true)]
        public DateTime EndTimestamp
        {
            get { return this._endTimestamp.GetValueOrDefault(); }
            set { this._endTimestamp = value; }
        }

        // Check to see if EndTimestamp property is set
        internal bool IsSetEndTimestamp()
        {
            return this._endTimestamp.HasValue; 
        }

        /// <summary>
        /// Gets and sets the property Format. 
        /// <para>
        /// The format that will be used to encode the image.
        /// </para>
        /// </summary>
        [AWSProperty(Required=true)]
        public Format Format
        {
            get { return this._format; }
            set { this._format = value; }
        }

        // Check to see if Format property is set
        internal bool IsSetFormat()
        {
            return this._format != null;
        }

        /// <summary>
        /// Gets and sets the property FormatConfig. 
        /// <para>
        /// The list of a key-value pair structure that contains extra parameters that can be
        /// applied when the image is generated. The <code>FormatConfig</code> key is the <code>JPEGQuality</code>,
        /// which indicates the JPEG quality key to be used to generate the image. The <code>FormatConfig</code>
        /// value accepts ints from 1 to 100. If the value is 1, the image will be generated with
        /// less quality and the best compression. If the value is 100, the image will be generated
        /// with the best quality and less compression. If no value is provided, the default value
        /// of the <code>JPEGQuality</code> key will be set to 80.
        /// </para>
        /// </summary>
        [AWSProperty(Min=1, Max=1)]
        public Dictionary<string, string> FormatConfig
        {
            get { return this._formatConfig; }
            set { this._formatConfig = value; }
        }

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

        /// <summary>
        /// Gets and sets the property HeightPixels. 
        /// <para>
        /// The height of the output image that is used in conjunction with the <code>WidthPixels</code>
        /// parameter. When both <code>HeightPixels</code> and <code>WidthPixels</code> parameters
        /// are provided, the image will be stretched to fit the specified aspect ratio. If only
        /// the <code>HeightPixels</code> parameter is provided, its original aspect ratio will
        /// be used to calculate the <code>WidthPixels</code> ratio. If neither parameter is provided,
        /// the original image size will be returned.
        /// </para>
        /// </summary>
        [AWSProperty(Min=1, Max=2160)]
        public int HeightPixels
        {
            get { return this._heightPixels.GetValueOrDefault(); }
            set { this._heightPixels = value; }
        }

        // Check to see if HeightPixels property is set
        internal bool IsSetHeightPixels()
        {
            return this._heightPixels.HasValue; 
        }

        /// <summary>
        /// Gets and sets the property ImageSelectorType. 
        /// <para>
        /// The origin of the Server or Producer timestamps to use to generate the images.
        /// </para>
        /// </summary>
        [AWSProperty(Required=true)]
        public ImageSelectorType ImageSelectorType
        {
            get { return this._imageSelectorType; }
            set { this._imageSelectorType = value; }
        }

        // Check to see if ImageSelectorType property is set
        internal bool IsSetImageSelectorType()
        {
            return this._imageSelectorType != null;
        }

        /// <summary>
        /// Gets and sets the property MaxResults. 
        /// <para>
        /// The maximum number of images to be returned by the API. 
        /// </para>
        ///  <note> 
        /// <para>
        /// The default limit is 100 images per API response. The additional results will be paginated.
        /// 
        /// </para>
        ///  </note>
        /// </summary>
        [AWSProperty(Min=1, Max=100)]
        public long 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 NextToken. 
        /// <para>
        /// A token that specifies where to start paginating the next set of Images. This is the
        /// <code>GetImages:NextToken</code> from a previously truncated response.
        /// </para>
        /// </summary>
        [AWSProperty(Min=1, Max=4096)]
        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 SamplingInterval. 
        /// <para>
        /// The time interval in milliseconds (ms) at which the images need to be generated from
        /// the stream. The minimum value that can be provided is 3000 ms. If the timestamp range
        /// is less than the sampling interval, the Image from the <code>startTimestamp</code>
        /// will be returned if available. 
        /// </para>
        ///  <note> 
        /// <para>
        /// The minimum value of 3000 ms is a soft limit. If needed, a lower sampling frequency
        /// can be requested.
        /// </para>
        ///  </note>
        /// </summary>
        [AWSProperty(Required=true, Min=3000, Max=20000)]
        public int SamplingInterval
        {
            get { return this._samplingInterval.GetValueOrDefault(); }
            set { this._samplingInterval = value; }
        }

        // Check to see if SamplingInterval property is set
        internal bool IsSetSamplingInterval()
        {
            return this._samplingInterval.HasValue; 
        }

        /// <summary>
        /// Gets and sets the property StartTimestamp. 
        /// <para>
        /// The starting point from which the images should be generated. This <code>StartTimestamp</code>
        /// must be within an inclusive range of timestamps for an image to be returned.
        /// </para>
        /// </summary>
        [AWSProperty(Required=true)]
        public DateTime StartTimestamp
        {
            get { return this._startTimestamp.GetValueOrDefault(); }
            set { this._startTimestamp = value; }
        }

        // Check to see if StartTimestamp property is set
        internal bool IsSetStartTimestamp()
        {
            return this._startTimestamp.HasValue; 
        }

        /// <summary>
        /// Gets and sets the property StreamARN. 
        /// <para>
        /// The Amazon Resource Name (ARN) of the stream from which to retrieve the images. You
        /// must specify either the <code>StreamName</code> or the <code>StreamARN</code>.
        /// </para>
        /// </summary>
        [AWSProperty(Min=1, Max=1024)]
        public string StreamARN
        {
            get { return this._streamARN; }
            set { this._streamARN = value; }
        }

        // Check to see if StreamARN property is set
        internal bool IsSetStreamARN()
        {
            return this._streamARN != null;
        }

        /// <summary>
        /// Gets and sets the property StreamName. 
        /// <para>
        /// The name of the stream from which to retrieve the images. You must specify either
        /// the <code>StreamName</code> or the <code>StreamARN</code>.
        /// </para>
        /// </summary>
        [AWSProperty(Min=1, Max=256)]
        public string StreamName
        {
            get { return this._streamName; }
            set { this._streamName = value; }
        }

        // Check to see if StreamName property is set
        internal bool IsSetStreamName()
        {
            return this._streamName != null;
        }

        /// <summary>
        /// Gets and sets the property WidthPixels. 
        /// <para>
        /// The width of the output image that is used in conjunction with the <code>HeightPixels</code>
        /// parameter. When both <code>WidthPixels</code> and <code>HeightPixels</code> parameters
        /// are provided, the image will be stretched to fit the specified aspect ratio. If only
        /// the <code>WidthPixels</code> parameter is provided or if only the <code>HeightPixels</code>
        /// is provided, a <code>ValidationException</code> will be thrown. If neither parameter
        /// is provided, the original image size from the stream will be returned.
        /// </para>
        /// </summary>
        [AWSProperty(Min=1, Max=3840)]
        public int WidthPixels
        {
            get { return this._widthPixels.GetValueOrDefault(); }
            set { this._widthPixels = value; }
        }

        // Check to see if WidthPixels property is set
        internal bool IsSetWidthPixels()
        {
            return this._widthPixels.HasValue; 
        }

    }
}