/******************************************************************************* * 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.Finspace; using Amazon.Finspace.Model; namespace Amazon.PowerShell.Cmdlets.FINSP { /// /// Creates a changeset for a kdb database. A changeset allows you to add and delete /// existing files by using an ordered list of change requests. /// [Cmdlet("New", "FINSPKxChangeset", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("Amazon.Finspace.Model.CreateKxChangesetResponse")] [AWSCmdlet("Calls the FinSpace User Environment Management Service CreateKxChangeset API operation.", Operation = new[] {"CreateKxChangeset"}, SelectReturnType = typeof(Amazon.Finspace.Model.CreateKxChangesetResponse))] [AWSCmdletOutput("Amazon.Finspace.Model.CreateKxChangesetResponse", "This cmdlet returns an Amazon.Finspace.Model.CreateKxChangesetResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class NewFINSPKxChangesetCmdlet : AmazonFinspaceClientCmdlet, IExecutor { #region Parameter ChangeRequest /// /// /// A list of change request objects that are run in order. A change request object consists /// of changeType , s3Path, and a dbPath. A changeType can has the following values: All the change requests require a mandatory dbPath attribute that defines the /// path within the database directory. The s3Path attribute defines the s3 source /// file path and is required for a PUT change type.Here is an example of how you can use the change request object:[ { "changeType": "PUT", "s3Path":"s3://bucket/db/2020.01.02/", "dbPath":"/2020.01.02/"}, /// { "changeType": "PUT", "s3Path":"s3://bucket/db/sym", "dbPath":"/"}, { "changeType": /// "DELETE", "dbPath": "/2020.01.01/"} ]In this example, the first request with PUT change type allows you to add files /// in the given s3Path under the 2020.01.02 partition of the database. The second /// request with PUT change type allows you to add a single sym file at database /// root location. The last request with DELETE change type allows you to delete /// the files under the 2020.01.01 partition of the database. /// /// #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowEmptyCollection] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] [Alias("ChangeRequests")] public Amazon.Finspace.Model.ChangeRequest[] ChangeRequest { get; set; } #endregion #region Parameter DatabaseName /// /// /// The name of the kdb database. /// /// #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 DatabaseName { get; set; } #endregion #region Parameter EnvironmentId /// /// /// A unique identifier of the kdb environment. /// /// #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 EnvironmentId { get; set; } #endregion #region Parameter ClientToken /// /// /// A token that ensures idempotency. This token expires in 10 minutes. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String ClientToken { 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.Finspace.Model.CreateKxChangesetResponse). /// Specifying the name of a property of type Amazon.Finspace.Model.CreateKxChangesetResponse 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 DatabaseName parameter. /// The -PassThru parameter is deprecated, use -Select '^DatabaseName' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^DatabaseName' 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.DatabaseName), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "New-FINSPKxChangeset (CreateKxChangeset)")) { 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.DatabaseName; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute if (this.ChangeRequest != null) { context.ChangeRequest = new List(this.ChangeRequest); } #if MODULAR if (this.ChangeRequest == null && ParameterWasBound(nameof(this.ChangeRequest))) { WriteWarning("You are passing $null as a value for parameter ChangeRequest 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.ClientToken = this.ClientToken; context.DatabaseName = this.DatabaseName; #if MODULAR if (this.DatabaseName == null && ParameterWasBound(nameof(this.DatabaseName))) { WriteWarning("You are passing $null as a value for parameter DatabaseName 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.EnvironmentId = this.EnvironmentId; #if MODULAR if (this.EnvironmentId == null && ParameterWasBound(nameof(this.EnvironmentId))) { WriteWarning("You are passing $null as a value for parameter EnvironmentId 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.Finspace.Model.CreateKxChangesetRequest(); if (cmdletContext.ChangeRequest != null) { request.ChangeRequests = cmdletContext.ChangeRequest; } if (cmdletContext.ClientToken != null) { request.ClientToken = cmdletContext.ClientToken; } if (cmdletContext.DatabaseName != null) { request.DatabaseName = cmdletContext.DatabaseName; } if (cmdletContext.EnvironmentId != null) { request.EnvironmentId = cmdletContext.EnvironmentId; } 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.Finspace.Model.CreateKxChangesetResponse CallAWSServiceOperation(IAmazonFinspace client, Amazon.Finspace.Model.CreateKxChangesetRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "FinSpace User Environment Management Service", "CreateKxChangeset"); try { #if DESKTOP return client.CreateKxChangeset(request); #elif CORECLR return client.CreateKxChangesetAsync(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 ChangeRequest { get; set; } public System.String ClientToken { get; set; } public System.String DatabaseName { get; set; } public System.String EnvironmentId { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response; } } }