/*******************************************************************************
 *  Copyright 2012-2019 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.
 * *****************************************************************************
 *
 *  AWS Tools for Windows (TM) PowerShell (TM)
 *
 */

using System;
using System.Collections.Generic;
using System.Linq;
using System.Management.Automation;
using System.Text;
using Amazon.PowerShell.Common;
using Amazon.Runtime;
using Amazon.Kendra;
using Amazon.Kendra.Model;

namespace Amazon.PowerShell.Cmdlets.KNDR
{
    /// <summary>
    /// Creates a set of featured results to display at the top of the search results page.
    /// Featured results are placed above all other results for certain queries. You map specific
    /// queries to specific documents for featuring in the results. If a query contains an
    /// exact match, then one or more specific documents are featured in the search results.
    /// 
    ///  
    /// <para>
    /// You can create up to 50 sets of featured results per index. You can request to increase
    /// this limit by contacting <a href="http://aws.amazon.com/contact-us/">Support</a>.
    /// </para>
    /// </summary>
    [Cmdlet("New", "KNDRFeaturedResultsSet", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
    [OutputType("Amazon.Kendra.Model.FeaturedResultsSet")]
    [AWSCmdlet("Calls the Amazon Kendra CreateFeaturedResultsSet API operation.", Operation = new[] {"CreateFeaturedResultsSet"}, SelectReturnType = typeof(Amazon.Kendra.Model.CreateFeaturedResultsSetResponse))]
    [AWSCmdletOutput("Amazon.Kendra.Model.FeaturedResultsSet or Amazon.Kendra.Model.CreateFeaturedResultsSetResponse",
        "This cmdlet returns an Amazon.Kendra.Model.FeaturedResultsSet object.",
        "The service call response (type Amazon.Kendra.Model.CreateFeaturedResultsSetResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
    )]
    public partial class NewKNDRFeaturedResultsSetCmdlet : AmazonKendraClientCmdlet, IExecutor
    {
        
        #region Parameter Description
        /// <summary>
        /// <para>
        /// <para>A description for the set of featured results.</para>
        /// </para>
        /// </summary>
        [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
        public System.String Description { get; set; }
        #endregion
        
        #region Parameter FeaturedDocument
        /// <summary>
        /// <para>
        /// <para>A list of document IDs for the documents you want to feature at the top of the search
        /// results page. For more information on the list of documents, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_FeaturedResultsSet.html">FeaturedResultsSet</a>.</para>
        /// </para>
        /// </summary>
        [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
        [Alias("FeaturedDocuments")]
        public Amazon.Kendra.Model.FeaturedDocument[] FeaturedDocument { get; set; }
        #endregion
        
        #region Parameter FeaturedResultsSetName
        /// <summary>
        /// <para>
        /// <para>A name for the set of featured results.</para>
        /// </para>
        /// </summary>
        #if !MODULAR
        [System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)]
        #else
        [System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true, Mandatory = true)]
        [System.Management.Automation.AllowEmptyString]
        [System.Management.Automation.AllowNull]
        #endif
        [Amazon.PowerShell.Common.AWSRequiredParameter]
        public System.String FeaturedResultsSetName { get; set; }
        #endregion
        
        #region Parameter IndexId
        /// <summary>
        /// <para>
        /// <para>The identifier of the index that you want to use for featuring results.</para>
        /// </para>
        /// </summary>
        #if !MODULAR
        [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
        #else
        [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)]
        [System.Management.Automation.AllowEmptyString]
        [System.Management.Automation.AllowNull]
        #endif
        [Amazon.PowerShell.Common.AWSRequiredParameter]
        public System.String IndexId { get; set; }
        #endregion
        
        #region Parameter QueryText
        /// <summary>
        /// <para>
        /// <para>A list of queries for featuring results. For more information on the list of queries,
        /// see <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_FeaturedResultsSet.html">FeaturedResultsSet</a>.</para>
        /// </para>
        /// </summary>
        [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
        [Alias("QueryTexts")]
        public System.String[] QueryText { get; set; }
        #endregion
        
        #region Parameter Status
        /// <summary>
        /// <para>
        /// <para>The current status of the set of featured results. When the value is <code>ACTIVE</code>,
        /// featured results are ready for use. You can still configure your settings before setting
        /// the status to <code>ACTIVE</code>. You can set the status to <code>ACTIVE</code> or
        /// <code>INACTIVE</code> using the <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateFeaturedResultsSet.html">UpdateFeaturedResultsSet</a>
        /// API. The queries you specify for featured results must be unique per featured results
        /// set for each index, whether the status is <code>ACTIVE</code> or <code>INACTIVE</code>.</para>
        /// </para>
        /// </summary>
        [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
        [AWSConstantClassSource("Amazon.Kendra.FeaturedResultsSetStatus")]
        public Amazon.Kendra.FeaturedResultsSetStatus Status { get; set; }
        #endregion
        
        #region Parameter Tag
        /// <summary>
        /// <para>
        /// <para>A list of key-value pairs that identify or categorize the featured results set. You
        /// can also use tags to help control access to the featured results set. Tag keys and
        /// values can consist of Unicode letters, digits, white space, and any of the following
        /// symbols:_ . : / = + - @.</para>
        /// </para>
        /// </summary>
        [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
        [Alias("Tags")]
        public Amazon.Kendra.Model.Tag[] Tag { get; set; }
        #endregion
        
        #region Parameter ClientToken
        /// <summary>
        /// <para>
        /// <para>A token that you provide to identify the request to create a set of featured results.
        /// Multiple calls to the <code>CreateFeaturedResultsSet</code> API with the same client
        /// token will create only one featured results set.</para>
        /// </para>
        /// </summary>
        [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
        public System.String ClientToken { get; set; }
        #endregion
        
        #region Parameter Select
        /// <summary>
        /// Use the -Select parameter to control the cmdlet output. The default value is 'FeaturedResultsSet'.
        /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Kendra.Model.CreateFeaturedResultsSetResponse).
        /// Specifying the name of a property of type Amazon.Kendra.Model.CreateFeaturedResultsSetResponse will result in that property being returned.
        /// Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
        /// </summary>
        [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
        public string Select { get; set; } = "FeaturedResultsSet";
        #endregion
        
        #region Parameter PassThru
        /// <summary>
        /// Changes the cmdlet behavior to return the value passed to the FeaturedResultsSetName parameter.
        /// The -PassThru parameter is deprecated, use -Select '^FeaturedResultsSetName' instead. This parameter will be removed in a future version.
        /// </summary>
        [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^FeaturedResultsSetName' instead. This parameter will be removed in a future version.")]
        [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
        public SwitchParameter PassThru { get; set; }
        #endregion
        
        #region Parameter Force
        /// <summary>
        /// This parameter overrides confirmation prompts to force 
        /// the cmdlet to continue its operation. This parameter should always
        /// be used with caution.
        /// </summary>
        [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
        public SwitchParameter Force { get; set; }
        #endregion
        
        protected override void ProcessRecord()
        {
            this._AWSSignerType = "v4";
            base.ProcessRecord();
            
            var resourceIdentifiersText = FormatParameterValuesForConfirmationMsg(nameof(this.FeaturedResultsSetName), MyInvocation.BoundParameters);
            if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "New-KNDRFeaturedResultsSet (CreateFeaturedResultsSet)"))
            {
                return;
            }
            
            var context = new CmdletContext();
            
            // allow for manipulation of parameters prior to loading into context
            PreExecutionContextLoad(context);
            
            #pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute
            if (ParameterWasBound(nameof(this.Select)))
            {
                context.Select = CreateSelectDelegate<Amazon.Kendra.Model.CreateFeaturedResultsSetResponse, NewKNDRFeaturedResultsSetCmdlet>(Select) ??
                    throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select));
                if (this.PassThru.IsPresent)
                {
                    throw new System.ArgumentException("-PassThru cannot be used when -Select is specified.", nameof(this.Select));
                }
            }
            else if (this.PassThru.IsPresent)
            {
                context.Select = (response, cmdlet) => this.FeaturedResultsSetName;
            }
            #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
            context.ClientToken = this.ClientToken;
            context.Description = this.Description;
            if (this.FeaturedDocument != null)
            {
                context.FeaturedDocument = new List<Amazon.Kendra.Model.FeaturedDocument>(this.FeaturedDocument);
            }
            context.FeaturedResultsSetName = this.FeaturedResultsSetName;
            #if MODULAR
            if (this.FeaturedResultsSetName == null && ParameterWasBound(nameof(this.FeaturedResultsSetName)))
            {
                WriteWarning("You are passing $null as a value for parameter FeaturedResultsSetName which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues.");
            }
            #endif
            context.IndexId = this.IndexId;
            #if MODULAR
            if (this.IndexId == null && ParameterWasBound(nameof(this.IndexId)))
            {
                WriteWarning("You are passing $null as a value for parameter IndexId which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues.");
            }
            #endif
            if (this.QueryText != null)
            {
                context.QueryText = new List<System.String>(this.QueryText);
            }
            context.Status = this.Status;
            if (this.Tag != null)
            {
                context.Tag = new List<Amazon.Kendra.Model.Tag>(this.Tag);
            }
            
            // allow further manipulation of loaded context prior to processing
            PostExecutionContextLoad(context);
            
            var output = Execute(context) as CmdletOutput;
            ProcessOutput(output);
        }
        
        #region IExecutor Members
        
        public object Execute(ExecutorContext context)
        {
            var cmdletContext = context as CmdletContext;
            // create request
            var request = new Amazon.Kendra.Model.CreateFeaturedResultsSetRequest();
            
            if (cmdletContext.ClientToken != null)
            {
                request.ClientToken = cmdletContext.ClientToken;
            }
            if (cmdletContext.Description != null)
            {
                request.Description = cmdletContext.Description;
            }
            if (cmdletContext.FeaturedDocument != null)
            {
                request.FeaturedDocuments = cmdletContext.FeaturedDocument;
            }
            if (cmdletContext.FeaturedResultsSetName != null)
            {
                request.FeaturedResultsSetName = cmdletContext.FeaturedResultsSetName;
            }
            if (cmdletContext.IndexId != null)
            {
                request.IndexId = cmdletContext.IndexId;
            }
            if (cmdletContext.QueryText != null)
            {
                request.QueryTexts = cmdletContext.QueryText;
            }
            if (cmdletContext.Status != null)
            {
                request.Status = cmdletContext.Status;
            }
            if (cmdletContext.Tag != null)
            {
                request.Tags = cmdletContext.Tag;
            }
            
            CmdletOutput output;
            
            // issue call
            var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint);
            try
            {
                var response = CallAWSServiceOperation(client, request);
                object pipelineOutput = null;
                pipelineOutput = cmdletContext.Select(response, this);
                output = new CmdletOutput
                {
                    PipelineOutput = pipelineOutput,
                    ServiceResponse = response
                };
            }
            catch (Exception e)
            {
                output = new CmdletOutput { ErrorResponse = e };
            }
            
            return output;
        }
        
        public ExecutorContext CreateContext()
        {
            return new CmdletContext();
        }
        
        #endregion
        
        #region AWS Service Operation Call
        
        private Amazon.Kendra.Model.CreateFeaturedResultsSetResponse CallAWSServiceOperation(IAmazonKendra client, Amazon.Kendra.Model.CreateFeaturedResultsSetRequest request)
        {
            Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Kendra", "CreateFeaturedResultsSet");
            try
            {
                #if DESKTOP
                return client.CreateFeaturedResultsSet(request);
                #elif CORECLR
                return client.CreateFeaturedResultsSetAsync(request).GetAwaiter().GetResult();
                #else
                        #error "Unknown build edition"
                #endif
            }
            catch (AmazonServiceException exc)
            {
                var webException = exc.InnerException as System.Net.WebException;
                if (webException != null)
                {
                    throw new Exception(Utils.Common.FormatNameResolutionFailureMessage(client.Config, webException.Message), webException);
                }
                throw;
            }
        }
        
        #endregion
        
        internal partial class CmdletContext : ExecutorContext
        {
            public System.String ClientToken { get; set; }
            public System.String Description { get; set; }
            public List<Amazon.Kendra.Model.FeaturedDocument> FeaturedDocument { get; set; }
            public System.String FeaturedResultsSetName { get; set; }
            public System.String IndexId { get; set; }
            public List<System.String> QueryText { get; set; }
            public Amazon.Kendra.FeaturedResultsSetStatus Status { get; set; }
            public List<Amazon.Kendra.Model.Tag> Tag { get; set; }
            public System.Func<Amazon.Kendra.Model.CreateFeaturedResultsSetResponse, NewKNDRFeaturedResultsSetCmdlet, object> Select { get; set; } =
                (response, cmdlet) => response.FeaturedResultsSet;
        }
        
    }
}