/******************************************************************************* * 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.LocationService; using Amazon.LocationService.Model; namespace Amazon.PowerShell.Cmdlets.LOC { /// /// Generates suggestions for addresses and points of interest based on partial or misspelled /// free-form text. This operation is also known as autocomplete, autosuggest, or fuzzy /// matching. /// /// /// /// Optional parameters let you narrow your search results by bounding box or country, /// or bias your search toward a specific position on the globe. /// /// You can search for suggested place names near a specified position by using BiasPosition, /// or filter results within a bounding box by using FilterBBox. These parameters /// are mutually exclusive; using both BiasPosition and FilterBBox /// in the same command returns an error. /// /// [Cmdlet("Search", "LOCPlaceIndexForSuggestion", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("Amazon.LocationService.Model.SearchPlaceIndexForSuggestionsResponse")] [AWSCmdlet("Calls the Amazon Location Service SearchPlaceIndexForSuggestions API operation.", Operation = new[] {"SearchPlaceIndexForSuggestions"}, SelectReturnType = typeof(Amazon.LocationService.Model.SearchPlaceIndexForSuggestionsResponse))] [AWSCmdletOutput("Amazon.LocationService.Model.SearchPlaceIndexForSuggestionsResponse", "This cmdlet returns an Amazon.LocationService.Model.SearchPlaceIndexForSuggestionsResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class SearchLOCPlaceIndexForSuggestionCmdlet : AmazonLocationServiceClientCmdlet, IExecutor { protected override bool IsSensitiveRequest { get; set; } = true; protected override bool IsSensitiveResponse { get; set; } = true; #region Parameter BiasPosition /// /// /// An optional parameter that indicates a preference for place suggestions that are closer /// to a specified position. If provided, this parameter must contain a pair of numbers. The first number represents /// the X coordinate, or longitude; the second number represents the Y coordinate, or /// latitude.For example, [-123.1174, 49.2847] represents the position with longitude /// -123.1174 and latitude 49.2847.BiasPosition and FilterBBox are mutually exclusive. Specifying /// both options results in an error. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Double[] BiasPosition { get; set; } #endregion #region Parameter FilterBBox /// /// /// An optional parameter that limits the search results by returning only suggestions /// within a specified bounding box. If provided, this parameter must contain a total of four consecutive numbers in two /// pairs. The first pair of numbers represents the X and Y coordinates (longitude and /// latitude, respectively) of the southwest corner of the bounding box; the second pair /// of numbers represents the X and Y coordinates (longitude and latitude, respectively) /// of the northeast corner of the bounding box.For example, [-12.7935, -37.4835, -12.0684, -36.9542] represents a bounding /// box where the southwest corner has longitude -12.7935 and latitude -37.4835, /// and the northeast corner has longitude -12.0684 and latitude -36.9542.FilterBBox and BiasPosition are mutually exclusive. Specifying /// both options results in an error. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Double[] FilterBBox { get; set; } #endregion #region Parameter FilterCategory /// /// /// A list of one or more Amazon Location categories to filter the returned places. If /// you include more than one category, the results will include results that match any /// of the categories listed.For more information about using categories, including a list of Amazon Location categories, /// see Categories /// and filtering, in the Amazon Location Service Developer Guide. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("FilterCategories")] public System.String[] FilterCategory { get; set; } #endregion #region Parameter FilterCountry /// /// /// An optional parameter that limits the search results by returning only suggestions /// within the provided list of countries. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("FilterCountries")] public System.String[] FilterCountry { get; set; } #endregion #region Parameter IndexName /// /// /// The name of the place index resource you want to use for the search. /// /// #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 IndexName { get; set; } #endregion #region Parameter Key /// /// /// The optional API /// key to authorize the request. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String Key { get; set; } #endregion #region Parameter Language /// /// /// The preferred language used to return results. The value must be a valid BCP /// 47 language tag, for example, en for English.This setting affects the languages used in the results. If no language is specified, /// or not supported for a particular result, the partner automatically chooses a language /// for the result.For an example, we'll use the Greek language. You search for Athens, Gr /// to get suggestions with the language parameter set to en. /// The results found will most likely be returned as Athens, Greece.If you set the language parameter to el, for Greek, then /// the result found will more likely be returned as Αθήνα, Ελλάδα.If the data provider does not have a value for Greek, the result will be in a language /// that the provider does support. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String Language { get; set; } #endregion #region Parameter Text /// /// /// The free-form partial text to use to generate place suggestions. For example, eiffel /// tow. /// /// #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 Text { get; set; } #endregion #region Parameter MaxResult /// /// /// An optional parameter. The maximum number of results returned per request. The default: 5 /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("MaxResults")] public System.Int32? MaxResult { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is '*'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LocationService.Model.SearchPlaceIndexForSuggestionsResponse). /// Specifying the name of a property of type Amazon.LocationService.Model.SearchPlaceIndexForSuggestionsResponse will result in that property being returned. /// Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public string Select { get; set; } = "*"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the IndexName parameter. /// The -PassThru parameter is deprecated, use -Select '^IndexName' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^IndexName' 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 /// /// This parameter overrides confirmation prompts to force /// the cmdlet to continue its operation. This parameter should always /// be used with caution. /// [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.IndexName), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Search-LOCPlaceIndexForSuggestion (SearchPlaceIndexForSuggestions)")) { 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(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.IndexName; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute if (this.BiasPosition != null) { context.BiasPosition = new List(this.BiasPosition); } if (this.FilterBBox != null) { context.FilterBBox = new List(this.FilterBBox); } if (this.FilterCategory != null) { context.FilterCategory = new List(this.FilterCategory); } if (this.FilterCountry != null) { context.FilterCountry = new List(this.FilterCountry); } context.IndexName = this.IndexName; #if MODULAR if (this.IndexName == null && ParameterWasBound(nameof(this.IndexName))) { WriteWarning("You are passing $null as a value for parameter IndexName 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.Key = this.Key; context.Language = this.Language; context.MaxResult = this.MaxResult; context.Text = this.Text; #if MODULAR if (this.Text == null && ParameterWasBound(nameof(this.Text))) { WriteWarning("You are passing $null as a value for parameter Text 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 // 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.LocationService.Model.SearchPlaceIndexForSuggestionsRequest(); if (cmdletContext.BiasPosition != null) { request.BiasPosition = cmdletContext.BiasPosition; } if (cmdletContext.FilterBBox != null) { request.FilterBBox = cmdletContext.FilterBBox; } if (cmdletContext.FilterCategory != null) { request.FilterCategories = cmdletContext.FilterCategory; } if (cmdletContext.FilterCountry != null) { request.FilterCountries = cmdletContext.FilterCountry; } if (cmdletContext.IndexName != null) { request.IndexName = cmdletContext.IndexName; } if (cmdletContext.Key != null) { request.Key = cmdletContext.Key; } if (cmdletContext.Language != null) { request.Language = cmdletContext.Language; } if (cmdletContext.MaxResult != null) { request.MaxResults = cmdletContext.MaxResult.Value; } if (cmdletContext.Text != null) { request.Text = cmdletContext.Text; } 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.LocationService.Model.SearchPlaceIndexForSuggestionsResponse CallAWSServiceOperation(IAmazonLocationService client, Amazon.LocationService.Model.SearchPlaceIndexForSuggestionsRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Location Service", "SearchPlaceIndexForSuggestions"); try { #if DESKTOP return client.SearchPlaceIndexForSuggestions(request); #elif CORECLR return client.SearchPlaceIndexForSuggestionsAsync(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 List BiasPosition { get; set; } public List FilterBBox { get; set; } public List FilterCategory { get; set; } public List FilterCountry { get; set; } public System.String IndexName { get; set; } public System.String Key { get; set; } public System.String Language { get; set; } public System.Int32? MaxResult { get; set; } public System.String Text { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response; } } }