/*******************************************************************************
* 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.ApiGatewayV2;
using Amazon.ApiGatewayV2.Model;
namespace Amazon.PowerShell.Cmdlets.AG2
{
///
///
[Cmdlet("Export", "AG2Api", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("System.IO.MemoryStream")]
[AWSCmdlet("Calls the Amazon API Gateway V2 ExportApi API operation.", Operation = new[] {"ExportApi"}, SelectReturnType = typeof(Amazon.ApiGatewayV2.Model.ExportApiResponse))]
[AWSCmdletOutput("System.IO.MemoryStream or Amazon.ApiGatewayV2.Model.ExportApiResponse",
"This cmdlet returns a System.IO.MemoryStream object.",
"The service call response (type Amazon.ApiGatewayV2.Model.ExportApiResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class ExportAG2ApiCmdlet : AmazonApiGatewayV2ClientCmdlet, IExecutor
{
#region Parameter ApiId
///
///
/// The API identifier.
///
///
#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 ApiId { get; set; }
#endregion
#region Parameter ExportVersion
///
///
/// The version of the API Gateway export algorithm. API Gateway uses the latest version
/// by default. Currently, the only supported version is 1.0.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String ExportVersion { get; set; }
#endregion
#region Parameter IncludeExtension
///
///
/// Specifies whether to include API
/// Gateway extensions in the exported API definition. API Gateway extensions are
/// included by default.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("IncludeExtensions")]
public System.Boolean? IncludeExtension { get; set; }
#endregion
#region Parameter OutputType
///
///
/// The output type of the exported definition file. Valid values are JSON and YAML.
///
///
#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 OutputType { get; set; }
#endregion
#region Parameter Specification
///
///
/// The version of the API specification to use. OAS30, for OpenAPI 3.0, is the only supported
/// value.
///
///
#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 Specification { get; set; }
#endregion
#region Parameter StageName
///
///
/// The name of the API stage to export. If you don't specify this property, a representation
/// of the latest API configuration is exported.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String StageName { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is 'Body'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ApiGatewayV2.Model.ExportApiResponse).
/// Specifying the name of a property of type Amazon.ApiGatewayV2.Model.ExportApiResponse 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; } = "Body";
#endregion
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the ApiId parameter.
/// The -PassThru parameter is deprecated, use -Select '^ApiId' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^ApiId' 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.ApiId), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Export-AG2Api (ExportApi)"))
{
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.ApiId;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.ApiId = this.ApiId;
#if MODULAR
if (this.ApiId == null && ParameterWasBound(nameof(this.ApiId)))
{
WriteWarning("You are passing $null as a value for parameter ApiId 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.ExportVersion = this.ExportVersion;
context.IncludeExtension = this.IncludeExtension;
context.OutputType = this.OutputType;
#if MODULAR
if (this.OutputType == null && ParameterWasBound(nameof(this.OutputType)))
{
WriteWarning("You are passing $null as a value for parameter OutputType 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.Specification = this.Specification;
#if MODULAR
if (this.Specification == null && ParameterWasBound(nameof(this.Specification)))
{
WriteWarning("You are passing $null as a value for parameter Specification 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.StageName = this.StageName;
// 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.ApiGatewayV2.Model.ExportApiRequest();
if (cmdletContext.ApiId != null)
{
request.ApiId = cmdletContext.ApiId;
}
if (cmdletContext.ExportVersion != null)
{
request.ExportVersion = cmdletContext.ExportVersion;
}
if (cmdletContext.IncludeExtension != null)
{
request.IncludeExtensions = cmdletContext.IncludeExtension.Value;
}
if (cmdletContext.OutputType != null)
{
request.OutputType = cmdletContext.OutputType;
}
if (cmdletContext.Specification != null)
{
request.Specification = cmdletContext.Specification;
}
if (cmdletContext.StageName != null)
{
request.StageName = cmdletContext.StageName;
}
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.ApiGatewayV2.Model.ExportApiResponse CallAWSServiceOperation(IAmazonApiGatewayV2 client, Amazon.ApiGatewayV2.Model.ExportApiRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon API Gateway V2", "ExportApi");
try
{
#if DESKTOP
return client.ExportApi(request);
#elif CORECLR
return client.ExportApiAsync(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 ApiId { get; set; }
public System.String ExportVersion { get; set; }
public System.Boolean? IncludeExtension { get; set; }
public System.String OutputType { get; set; }
public System.String Specification { get; set; }
public System.String StageName { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.Body;
}
}
}