/*******************************************************************************
* 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.Honeycode;
using Amazon.Honeycode.Model;
namespace Amazon.PowerShell.Cmdlets.HC
{
///
/// The BatchDeleteTableRows API allows you to delete one or more rows from a table in
/// a workbook. You need to specify the ids of the rows that you want to delete from the
/// table.
///
[Cmdlet("Remove", "HCTableRowsBatch", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.High)]
[OutputType("Amazon.Honeycode.Model.BatchDeleteTableRowsResponse")]
[AWSCmdlet("Calls the Amazon Honeycode BatchDeleteTableRows API operation.", Operation = new[] {"BatchDeleteTableRows"}, SelectReturnType = typeof(Amazon.Honeycode.Model.BatchDeleteTableRowsResponse))]
[AWSCmdletOutput("Amazon.Honeycode.Model.BatchDeleteTableRowsResponse",
"This cmdlet returns an Amazon.Honeycode.Model.BatchDeleteTableRowsResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class RemoveHCTableRowsBatchCmdlet : AmazonHoneycodeClientCmdlet, IExecutor
{
#region Parameter ClientRequestToken
///
///
/// The request token for performing the delete action. Request tokens help to identify
/// duplicate requests. If a call times out or fails due to a transient error like a failed
/// network connection, you can retry the call with the same request token. The service
/// ensures that if the first call using that request token is successfully performed,
/// the second call will not perform the action again. Note that request tokens are valid only for a few minutes. You cannot use request
/// tokens to dedupe requests spanning hours or days.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String ClientRequestToken { get; set; }
#endregion
#region Parameter RowId
///
///
/// The list of row ids to delete from the table. You need to specify at least one row
/// id in this list. Note that if one of the row ids provided in the request does not exist in the table,
/// then the request fails and no rows are deleted from the table.
///
///
#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("RowIds")]
public System.String[] RowId { get; set; }
#endregion
#region Parameter TableId
///
///
/// The ID of the table where the rows are being deleted. If a table with the specified id could not be found, this API throws ResourceNotFoundException.
///
///
///
#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 TableId { get; set; }
#endregion
#region Parameter WorkbookId
///
///
/// The ID of the workbook where the rows are being deleted. If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.
///
///
///
#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 WorkbookId { 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.Honeycode.Model.BatchDeleteTableRowsResponse).
/// Specifying the name of a property of type Amazon.Honeycode.Model.BatchDeleteTableRowsResponse 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 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.TableId), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Remove-HCTableRowsBatch (BatchDeleteTableRows)"))
{
return;
}
var context = new CmdletContext();
// allow for manipulation of parameters prior to loading into context
PreExecutionContextLoad(context);
if (ParameterWasBound(nameof(this.Select)))
{
context.Select = CreateSelectDelegate(Select) ??
throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select));
}
context.ClientRequestToken = this.ClientRequestToken;
if (this.RowId != null)
{
context.RowId = new List(this.RowId);
}
#if MODULAR
if (this.RowId == null && ParameterWasBound(nameof(this.RowId)))
{
WriteWarning("You are passing $null as a value for parameter RowId 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.TableId = this.TableId;
#if MODULAR
if (this.TableId == null && ParameterWasBound(nameof(this.TableId)))
{
WriteWarning("You are passing $null as a value for parameter TableId 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.WorkbookId = this.WorkbookId;
#if MODULAR
if (this.WorkbookId == null && ParameterWasBound(nameof(this.WorkbookId)))
{
WriteWarning("You are passing $null as a value for parameter WorkbookId 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.Honeycode.Model.BatchDeleteTableRowsRequest();
if (cmdletContext.ClientRequestToken != null)
{
request.ClientRequestToken = cmdletContext.ClientRequestToken;
}
if (cmdletContext.RowId != null)
{
request.RowIds = cmdletContext.RowId;
}
if (cmdletContext.TableId != null)
{
request.TableId = cmdletContext.TableId;
}
if (cmdletContext.WorkbookId != null)
{
request.WorkbookId = cmdletContext.WorkbookId;
}
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.Honeycode.Model.BatchDeleteTableRowsResponse CallAWSServiceOperation(IAmazonHoneycode client, Amazon.Honeycode.Model.BatchDeleteTableRowsRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Honeycode", "BatchDeleteTableRows");
try
{
#if DESKTOP
return client.BatchDeleteTableRows(request);
#elif CORECLR
return client.BatchDeleteTableRowsAsync(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 ClientRequestToken { get; set; }
public List RowId { get; set; }
public System.String TableId { get; set; }
public System.String WorkbookId { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response;
}
}
}